Files
Aurora.3/code/controllers/subsystems/vote.dm
Batrachophreno af6c74d917 Verb organization stuff (#21131)
Currently, only Preferences Verbs use subcategories. As a result, all
other Verb tabs are only organized alphabetically, meaning that a single
mechanic (ie. languages) has its governing Verbs scattered rather than
grouped together.

Verb organization by Tab handles broad organization - IC, OOC, Objects,
etc.- highly effectively but requires the user to click-navigate to
other Tabs to access any other verbs.

Verb organization within a Tab can be handled by A.) subcategories and
B.) Verb name prefixes (such as Earphones - *****). The first option is
the clearest and cleanest, but consumes additional vertical space. The
second option conserves vertical space at the cost of visual clarity.

This PR attempts to reorganize Verbs by their Tabs, Subcategories, and
prefixes with the following priorities in mind:
- Minimal disruption; any radical change must be justified (don't move
shit around just for the sake of moving shit around.)
- Verbs which share common functions (such as Languages) should be
grouped together.
- Maintainability. Contributors should not need to memorize an
excessively convoluted Subcategories list; Subcategories must be
intuitive and simple.
- Subcategories should be used judiciously when grouping Verbs to
conserve vertical space. Example: Instead of creating a Subcategory for
Emotes, just rename Audible Emote and Visual Emote to Emote (Audible)
and Emote (Visual).
- Subcategories should highlight uncommon or unusual verbs when
reasonable. Example: There are several animal husbandry-related Verbs,
and because most characters will not have access to those verbs
regularly, we can be less conservative with space (because they'll be
gone most of the time) for the sake of emphasizing their availability.

This PR covers the IC, OOC, and Object Tabs.

Subcategories:
OOC.Chat (Chat functions)
- AOOC
- LOOC
- Devsay (moved from Special Verbs)
- Dsay (moved from Special Verbs)
- OOC

OOC.Debug (Fix shit)
- Fit viewport
- Fix chat
- Refresh TGUI

OOC.Round (Round information)
- Check Gamemode Probability
- Check Round Info
- Custom Event Info
- Vote

IC.Antag (Antag verbs w/o their own tab)
- Invite to the Loyalists
- Invite to the Revolutionaries
- Set Ambition

IC.Critters (More critter stuff than you'd expect there to be)
- Befriend Carp (Previous name 'Become Friends')
- Befriend Cat (Previous name 'Become Friends')
- Befriend Dog
- Befriend Ives
- Name Alien Species
- Name Animal

IC.Language (Language-related stuff)
- Check Default Language
- Check Known Languages
- Set Default Language

IC.Maneuver (Movement, positioning, etc.)
- Adjust walk speed
- Do Pushup
- Face Direction
- Look Down
- Look Up
- Move Downwards
- Move Upwards
- Rest

Object.Equipped (Equipped object stuff, mostly for drip)
- Adjust Badge
- Adjust Bag Straps (Backpacks)
- Adjust Goggles
- Adjust Mask
- Adjust Welding Goggles
- Adjust Welding Mask
- Change Glasses Layer
- Change Pants Layer
- Change Wrist Radio Layer
- Change Wristwear Layer
- Check Time
- Flip Badge
- Flip Belt
- Flip Eyepatch
- Flip Hat
- Flip ID card (ID card)
- Flip Radio (Clip-on radio)
- Flip Wristwear
- Fold Collar
- Lock Antenna(e)
- Point At Watch
- Raise Shroud
- Roll Up Cape Mantle
- Roll Up/Down Jumpsuit
- Roll Up/Down Sleeves
- Switch Belt Layer
- Switch ID Layer
- Switch Lanyard Layer
- Switch Shoe Layer
- Toggle Aviators (Like a dozen variants)
- Toggle Ceremonial Garment Lights
- Toggle Coat Buttons
- Toggle Coat Zipper
- Toggle Hair Coverage (For hats helmets etc)
- Toggle Hair Coverage (FOR BABY CARP!!!!!)
- Toggle Helmet Camera
- Toggle Hood
- Toggle Lyodsuit Mask
- Toggle Poncho Tail Coverage
- Toggle Shirt Buttons
- Toggle Suit Sensors
- Toggle Visor (Pilot helmet)
- Toggle Waistcoat Buttons
- Transform Holoclothing
- Voidsuit - Eject Suit Cooler
- Voidsuit - Eject Tank
- Voidsuit - Toggle Helmet

Object.Held (If you're HOLDING it, its probably relevant to you rn)
- Activate Held Object (Silicons; moved from IC)
- Alter Beacon's Signal (Radio beacon)
- Change Bite Size (Utensils)
- Change Pen Colour
- Choose Colour (Paint sprayer)
- Choose Decal (Paint sprayer)
- Choose Direction (Paint sprayer)
- Choose Preset Colour (Paint sprayer)
- Describe Prototype
- Draw Boot Knife
- Empty Bee Net
- Empty Spray Bottle
- Holster
- Name Gun
- Name Prototype
- Plant Flag (Flags)
- Print Plant Report
- Remove Chopsticks
- Remove Top
- Set Detector High-Bound (Light meter)
- Set Detector Low-Bound (Light meter)
- Set Hailer Message (Hailer)
- Set Timer (Timer igniter)
- Set Valve Pressure (Pneumatic cannon)
- Show Held Item
- Spin Cylinder (Revolvers)
- Switch Verbosity (Health analyzer)
- Toggle Chainsaw Power (Chainsaw)
- Toggle Flashlight Brightness (Flashlights)
- Toggle Gun Safety
- Toggle Hazard Vest
- Toggle Pinpointer Mode (Pinpointer)
- Toggle Mister (Backpack water tank. Goes into/out of hands)
- Twist Cap
- Use Scope
- Wield Pick/Drill
- Wield Two-Handed Weapon (Two-handed weapons)

Object.Cards (I fucking hate cards!!!)
- Deck - Deal
- Deck - Draw
- Deck - Pick
- Hand - Pick
- Turn Hand Into Deck

Object.Earphones (Enough here to separate out)
- Eject Music Cartridge
- Change Volume
- Next Song
- Pause/Unpause
- Play/Stop
- Previous Song

Object.Jetpack (This is probably really important to see quickly)
- Toggle Jetpack
- Toggle Jetpack Stabilization

Object.Tape Recorder (Enough here to separate out)
- Start Recording
- Stop Recording
- Clear Memory
- Playback Memory
- Print Transcript
- Eject Portable Storage

**IC tab example:**
<img width="1061" height="277" alt="Screenshot 2025-08-09 101813"
src="https://github.com/user-attachments/assets/a2afe92d-34fd-4160-bf68-b459a4195e26"
/>
**Objects tab example:**
<img width="1100" height="472" alt="Screenshot 2025-08-09 101807"
src="https://github.com/user-attachments/assets/a36e4c76-594e-4569-93ba-ffcda57e8760"
/>
2025-08-11 15:12:56 +00:00

406 lines
13 KiB
Plaintext

/// Define to mimic a span macro but for the purple font that vote specifically uses.
#define vote_font(text) ("<font color='purple'>" + text + "</font>")
SUBSYSTEM_DEF(vote)
name = "Vote"
wait = 1 SECONDS
flags = SS_KEEP_TIMING
init_order = INIT_ORDER_VOTE
runlevels = RUNLEVEL_LOBBY | RUNLEVELS_DEFAULT
/// A list of all generated action buttons
var/list/datum/action/generated_actions = list()
/// All votes that we can possible vote for.
var/list/datum/vote/possible_votes = list()
/// The vote we're currently voting on.
var/datum/vote/current_vote
/// A list of all ckeys who have voted for the current vote.
var/list/voted = list()
/// A list of all ckeys currently voting for the current vote.
var/list/voting = list()
/datum/controller/subsystem/vote/Initialize()
for(var/vote_type in subtypesof(/datum/vote))
var/datum/vote/vote = new vote_type()
if(!vote.is_accessible_vote())
qdel(vote)
continue
possible_votes[vote.name] = vote
return SS_INIT_SUCCESS
// Called by master_controller
/datum/controller/subsystem/vote/fire()
if(!current_vote)
return
current_vote.time_remaining = round((current_vote.started_time + 600 - world.time) / 10) //Used to be "CONFIG_GET(number/vote_period)" instead of 600
if(current_vote.time_remaining < 0)
process_vote_result()
SStgui.close_uis(src)
reset()
/// Resets all of our vars after votes conclude / are cancelled.
/datum/controller/subsystem/vote/proc/reset()
voted.Cut()
voting.Cut()
current_vote?.reset()
current_vote = null
QDEL_LIST(generated_actions)
SStgui.update_uis(src)
/**
* Process the results of the vote.
* Collects all the winners, breaks any ties that occur,
* prints the results of the vote to the world,
* and finally follows through with the effects of the vote.
*/
/datum/controller/subsystem/vote/proc/process_vote_result()
// First collect all the non-voters we have.
var/list/non_voters = GLOB.directory.Copy() - voted
// Remove AFK or clientless non-voters.
for(var/non_voter_ckey in non_voters)
var/client/non_voter_client = non_voters[non_voter_ckey]
if(!istype(non_voter_client) || non_voter_client.is_afk())
non_voters -= non_voter_ckey
// Now get the result of the vote.
// This is a list, as we could have a tie (multiple winners).
var/list/winners = current_vote.get_vote_result(non_voters)
// Now we should determine who actually won the vote.
var/final_winner
// 1 winner? That's the winning option
if(length(winners) == 1)
final_winner = winners[1]
// More than 1 winner? Tiebreaker between all the winners
else if(length(winners) > 1)
final_winner = current_vote.tiebreaker(winners)
// Announce the results of the vote to the world.
var/to_display = current_vote.get_result_text(winners, final_winner, non_voters)
var/total_votes = 0
var/list/vote_choice_data = list()
for(var/choice in current_vote.choices)
var/choice_votes = current_vote.choices[choice]
total_votes += choice_votes
vote_choice_data["[choice]"] = choice_votes
// stringify the winners to prevent potential unimplemented serialization errors.
// Perhaps this can be removed in the future and we assert that vote choices must implement serialization.
var/final_winner_string = final_winner && "[final_winner]"
var/list/winners_string = list()
for(var/winner in winners)
winners_string += "[winner]"
var/list/vote_log_data = list(
"choices" = vote_choice_data,
"total" = total_votes,
"winners" = winners_string,
"final_winner" = final_winner_string,
)
var/log_string = replacetext(to_display, "\n", "\\n") // 'keep' the newlines, but dont actually print them as newlines
log_vote(log_string, vote_log_data)
to_chat(world, SPAN_INFO(vote_font("\n[to_display]")))
// Finally, doing any effects on vote completion
if (final_winner) // if no one voted, or the vote cannot be won, final_winner will be null
current_vote.finalize_vote(final_winner)
/**
* One selection per person, and the selection with the most votes wins.
*/
/datum/controller/subsystem/vote/proc/submit_single_vote(mob/voter, their_vote)
if(!current_vote)
return
if(!voter?.ckey)
return
if(FALSE && voter.stat == DEAD && !voter.client?.holder) //Used to be "CONFIG_GET(flag/no_dead_vote)"
return
// If user has already voted, remove their specific vote
if(voter.ckey in current_vote.choices_by_ckey)
var/their_old_vote = current_vote.choices_by_ckey[voter.ckey]
current_vote.choices[their_old_vote]--
else
voted += voter.ckey
current_vote.choices_by_ckey[voter.ckey] = their_vote
current_vote.choices[their_vote]++
return TRUE
/**
* Any number of selections per person, and the selection with the most votes wins.
*/
/datum/controller/subsystem/vote/proc/submit_multi_vote(mob/voter, their_vote)
if(!current_vote)
return
if(!voter?.ckey)
return
if(FALSE && voter.stat == DEAD && !voter.client?.holder) //Used to be "CONFIG_GET(flag/no_dead_vote)"
return
else
voted += voter.ckey
if(current_vote.choices_by_ckey[voter.ckey + their_vote] == 1)
current_vote.choices_by_ckey[voter.ckey + their_vote] = 0
current_vote.choices[their_vote]--
else
current_vote.choices_by_ckey[voter.ckey + their_vote] = 1
current_vote.choices[their_vote]++
return TRUE
/**
* Initiates a vote, allowing all players to vote on something.
*
* * vote_type - The type of vote to initiate. Can be a [/datum/vote] typepath, a [/datum/vote] instance, or the name of a vote datum.
* * vote_initiator_name - The ckey (if player initiated) or name that initiated a vote. Ex: "UristMcAdmin", "the server"
* * vote_initiator - If a person / mob initiated the vote, this is the mob that did it
* * forced - Whether we're forcing the vote to go through regardless of existing votes or other circumstances. Note: If the vote is admin created, forced becomes true regardless.
*/
/datum/controller/subsystem/vote/proc/initiate_vote(vote_type, vote_initiator_name, mob/vote_initiator, forced = FALSE)
// Even if it's forced we can't vote before we're set up
if(!MC_RUNNING(init_stage))
if(vote_initiator)
to_chat(vote_initiator, SPAN_WARNING("You cannot start vote now, the server is not done initializing."))
return FALSE
// Check if we have unlimited voting power.
// Admin started (or forced) voted will go through even if there's an ongoing vote,
// if voting is on cooldown, or regardless if a vote is config disabled (in some cases)
var/unlimited_vote_power = forced || !!(vote_initiator.client?.holder?.rights & (R_ADMIN)) //Used GLOB.admin_datum
if(current_vote && !unlimited_vote_power)
if(vote_initiator)
to_chat(vote_initiator, SPAN_WARNING("There is already a vote in progress! Please wait for it to finish."))
return FALSE
// Get our actual datum
var/datum/vote/to_vote
// If we were passed a path: find the path in possible_votes
if(ispath(vote_type, /datum/vote))
var/datum/vote/vote_path = vote_type
to_vote = possible_votes[initial(vote_path.name)]
// If we were passed an instance: use the instance
else if(istype(vote_type, /datum/vote))
to_vote = vote_type
// If we got neither a path or an instance, it could be a vote name, but is likely just an error / null
else
to_vote = possible_votes[vote_type]
if(!to_vote)
stack_trace("Voting initiate_vote was passed an invalid vote type. (Got: [vote_type || "null"])")
// No valid vote found? No vote
if(!istype(to_vote))
if(vote_initiator)
to_chat(vote_initiator, SPAN_WARNING("Invalid voting choice."))
return FALSE
// Vote can't be initiated in our circumstances? No vote
if(!to_vote.can_be_initiated(vote_initiator, unlimited_vote_power))
return FALSE
// Okay, we're ready to actually create a vote -
// Do a reset, just to make sure
reset()
// Try to create the vote. If the creation fails, no vote
if(!to_vote.create_vote(vote_initiator))
return FALSE
// Okay, the vote's happening now, for real. Set it up.
current_vote = to_vote
var/duration = 600 //As above, used to be "CONFIG_GET(number/vote_period)"
var/to_display = current_vote.initiate_vote(vote_initiator_name, duration)
log_vote(to_display)
to_chat(world, SPAN_INFO(vote_font("\n[SPAN_BOLD(to_display)]\n\
Type <b>vote</b> or click <a href='byond://winset?command=vote'>here</a> to place your votes.\n\
You have [DisplayTimeText(duration)] to vote.")))
// And now that it's going, give everyone a voter action
for(var/client/new_voter as anything in GLOB.clients)
var/datum/action/vote/voting_action = new()
voting_action.name = "Vote: [current_vote.override_question || current_vote.name]"
voting_action.Grant(new_voter.mob)
//new_voter.player_details.player_actions += voting_action
generated_actions += voting_action
if(current_vote.vote_sound && (new_voter.prefs.sfx_toggles & ASFX_VOTE)) //Used "new_voter.prefs.read_preference(/datum/preference/toggle/sound_announcements)" but we don't have it
SEND_SOUND(new_voter, sound(current_vote.vote_sound))
return TRUE
/datum/controller/subsystem/vote/ui_state()
return GLOB.always_state
/datum/controller/subsystem/vote/ui_interact(mob/user, datum/tgui/ui)
// Tracks who is currently voting
voting |= user.client?.ckey
ui = SStgui.try_update_ui(user, src, ui)
if(!ui)
ui = new(user, src, "VotePanel")
ui.open()
/datum/controller/subsystem/vote/ui_data(mob/user)
var/list/data = list()
var/is_lower_admin = (user.client?.holder?.rights & (R_ADMIN | R_MOD))
var/is_upper_admin = (user.client?.holder?.rights & (R_ADMIN)) // Used "check_rights_for(user.client, R_ADMIN)" but we don't have that
data["user"] = list(
"ckey" = user.client?.ckey,
"isLowerAdmin" = is_lower_admin,
"isUpperAdmin" = is_upper_admin,
// What the current user has selected in any ongoing votes.
"singleSelection" = current_vote?.choices_by_ckey[user.client?.ckey],
"multiSelection" = current_vote?.choices_by_ckey,
)
data["voting"]= is_lower_admin ? voting : list()
var/list/all_vote_data = list()
for(var/vote_name in possible_votes)
var/datum/vote/vote = possible_votes[vote_name]
if(!istype(vote))
continue
var/list/vote_data = list(
"name" = vote_name,
"canBeInitiated" = vote.can_be_initiated(forced = is_lower_admin),
"config" = vote.is_config_enabled(),
"message" = vote.message,
)
if(vote == current_vote)
var/list/choices = list()
for(var/key in current_vote.choices)
choices += list(list(
"name" = key,
"votes" = current_vote.choices[key],
))
data["currentVote"] = list(
"name" = current_vote.name,
"question" = current_vote.override_question,
"timeRemaining" = current_vote.time_remaining,
"countMethod" = current_vote.count_method,
"choices" = choices,
"vote" = vote_data,
)
all_vote_data += list(vote_data)
data["possibleVotes"] = all_vote_data
return data
/datum/controller/subsystem/vote/ui_act(action, params)
. = ..()
if(.)
return
var/mob/voter = usr
switch(action)
if("cancel")
if(!(voter.client?.holder?.rights & (R_ADMIN | R_MOD)))
return
message_admins("[key_name_admin(voter)] has cancelled the current vote.")
reset()
return TRUE
if("toggleVote")
var/datum/vote/selected = possible_votes[params["voteName"]]
if(!istype(selected))
return
return selected.toggle_votable(voter)
if("callVote")
var/datum/vote/selected = possible_votes[params["voteName"]]
if(!istype(selected))
return
// Whether the user actually can initiate this vote is checked in initiate_vote,
// meaning you can't spoof initiate a vote you're not supposed to be able to
return initiate_vote(selected, voter.key, voter)
if("voteSingle")
return submit_single_vote(voter, params["voteOption"])
if("voteMulti")
return submit_multi_vote(voter, params["voteOption"])
/datum/controller/subsystem/vote/ui_close(mob/user)
voting -= user.client?.ckey
/*#########################
Aurora snowflake area
###########################*/
/datum/controller/subsystem/vote/proc/autogamemode()
initiate_vote(/datum/vote/gamemode, "Server", null, TRUE)
/datum/controller/subsystem/vote/proc/autotransfer()
initiate_vote(/datum/vote/crewtransfer, "Server", null, TRUE)
/*##############################
Aurora snowflake area end
################################*/
/// Mob level verb that allows players to vote on the current vote.
/mob/verb/vote()
set category = "OOC.Round"
set name = "Vote"
SSvote.ui_interact(usr)
/// Datum action given to mobs that allows players to vote on the current vote.
/datum/action/vote
name = "Vote!"
button_icon_state = "vote"
//show_to_observers = FALSE
/datum/action/vote/IsAvailable(feedback = FALSE)
return TRUE // Democracy is always available to the free people
/datum/action/vote/Trigger(trigger_flags)
. = ..()
if(!.)
return
owner.vote()
Remove(owner)
// We also need to remove our action from the player actions when we're cleaning up.
/datum/action/vote/Remove(mob/removed_from)
// if(removed_from.client)
// removed_from.client?.player_details.player_actions -= src
// else if(removed_from.ckey)
// var/datum/player_details/associated_details = GLOB.player_details[removed_from.ckey]
// associated_details?.player_actions -= src
return ..()
#undef vote_font