/tg/ Station 13 - Modules - TypesVar Details - Proc Details

revolution

Vars

ex_headrevsList of all ex-headrevs. Useful because dynamic removes antag status when it ends, so this can be kept for the roundend report.
ex_revsList of all ex-revs. Useful because dynamic removes antag status when it ends, so this can be kept for the roundend report.
heads_objectiveThe objective of the heads of staff, aka to kill the headrevs.
max_headrevsMaximum number of headrevs

Procs

check_heads_victoryChecks if heads have won
check_rev_victoryChecks if revs have won
defeat_effectsHandles effects of revs losing, such as making ex-headrevs unrevivable and setting up head of staff memories.
get_head_revolutionariesReturns a list of all headrevs.
process_victoryUpdates the state of the world depending on if revs won or loss. Returns who won, at which case this method should no longer be called.
round_resultMutates the ticker to report that the revs have won
save_membersSaves a list of all ex-headrevs and a list of all revs.
update_objectivesProc called on periodic timer. Updates the rev team's objectives to make sure all heads are targets, useful when new heads latejoin. Propagates all objectives to all revs.
update_rev_headsProc called on periodic timer. Tries to make sure an appropriate number of headrevs are part of the revolution. Will promote up revs to headrevs as necessary based on the hard max_headrevs cap and the soft cap based on the number of heads of staff and sec.
victory_effectsHandles any pre-round-ending effects on rev victory. An example use case is recording memories.

Var Details

ex_headrevs

List of all ex-headrevs. Useful because dynamic removes antag status when it ends, so this can be kept for the roundend report.

ex_revs

List of all ex-revs. Useful because dynamic removes antag status when it ends, so this can be kept for the roundend report.

heads_objective

The objective of the heads of staff, aka to kill the headrevs.

max_headrevs

Maximum number of headrevs

Proc Details

check_heads_victory

Checks if heads have won

check_rev_victory

Checks if revs have won

defeat_effects

Handles effects of revs losing, such as making ex-headrevs unrevivable and setting up head of staff memories.

get_head_revolutionaries

Returns a list of all headrevs.

process_victory

Updates the state of the world depending on if revs won or loss. Returns who won, at which case this method should no longer be called.

round_result

Mutates the ticker to report that the revs have won

save_members

Saves a list of all ex-headrevs and a list of all revs.

update_objectives

Proc called on periodic timer. Updates the rev team's objectives to make sure all heads are targets, useful when new heads latejoin. Propagates all objectives to all revs.

update_rev_heads

Proc called on periodic timer. Tries to make sure an appropriate number of headrevs are part of the revolution. Will promote up revs to headrevs as necessary based on the hard max_headrevs cap and the soft cap based on the number of heads of staff and sec.

victory_effects

Handles any pre-round-ending effects on rev victory. An example use case is recording memories.