dynamic

Vars
admin_disabled_rulesets	List of ruleset typepaths that admins have explicitly disabled
admin_forcing_next_heavy	Set to TRUE by admin panels if they want to max out the chance of a heavy ruleset spawning
admin_forcing_next_latejoin	Set to TRUE by admin panels if they want to max out the chance of a latejoin ruleset spawning
admin_forcing_next_light	Set to TRUE by admin panels if they want to max out the chance of a light ruleset spawning
antag_events_enabled	Whether random events that spawn antagonists or modify dynamic are enabled
base_rulesets_to_spawn	Tracks the number of rulesets to spawn at game start (for admin reference)
current_tier	Reference to a dynamic tier datum, the tier picked for this round
dynamic_config	The config for dynamic loaded from the toml file
executed_rulesets	List of rulesets that have been executed this round
failed_latejoins	Tracks how many time we fail to spawn a latejoin (to up the odds next time)
heavy_ruleset_start	Cooldown for when we are allowed to spawn heavy rulesets
latejoin_cooldown	Cooldown between latejoin ruleset executions
latejoin_ruleset_start	Cooldown for when we are allowed to spawn latejoin rulesets
light_ruleset_start	Cooldown for when we are allowed to spawn light rulesets
midround_admin_cancel	Set to TRUE by hrefs if admins cancel a midround
midround_admin_cancel_period	Cooldown between "we're going to spawn a midround" and "we're actually spawning a midround", to give admins a chance to cancel
midround_admin_reroll	Set to TRUE by hrefs if admins reroll a midround
midround_cooldown	Cooldown between midround ruleset executions
queued_rulesets	List of rulesets that have been set up to run, but not yet executed
rulesets_to_spawn	Tracks how many of each ruleset category is yet to be spawned
unreported_rulesets	Rulesets in this list will be excluded from the roundend report
Procs
force_extended	Helper to clear all queued rulesets and stop any other rulesets from naturally spawning
force_run_midround	Attempt to run a midround ruleset of the given type
get_latejoin_chance	Gets the chance of a latejoin ruleset being selected
get_latejoin_rulesets	Gets a weighted list of latejoin rulesets
get_midround_chance	Gets the chance of a midround ruleset being selected
get_midround_rulesets	Gets a weighted list of midround rulesets
get_roundstart_rulesets	Gets a weighted list of roundstart rulesets
get_ruleset_cooldown	Get the cooldown between attempts to spawn a ruleset of the given type
on_latejoin	Called when someone latejoins (This could be a signal in the future)
pick_roundstart_rulesets	Picks as many roundstart rulesets as we are allowed to spawn, returns them
pick_tier	Picks what tier we are going to use for this round and sets up all the corresponding variables and ranges
queue_ruleset	Queues a ruleset to run on roundstart or next latejoin which fulfills all requirements
select_roundstart_antagonists	Selects which rulesets are to run at roundstart, and sets them up
set_tier	Sets the tier to the typepath passed in
try_spawn_latejoin	Invoked by SSdynamic to try to spawn a latejoin ruleset Respects ranges and thresholds
try_spawn_midround	Invoked by SSdynamic to try to spawn a random midround ruleset Respects ranges and thresholds

Var Details

var
admin_disabled_rulesets
– /tmp/list

List of ruleset typepaths that admins have explicitly disabled

var
admin_forcing_next_heavy
– /tmp

Set to TRUE by admin panels if they want to max out the chance of a heavy ruleset spawning

var
admin_forcing_next_latejoin
– /tmp

Set to TRUE by admin panels if they want to max out the chance of a latejoin ruleset spawning

var
admin_forcing_next_light
– /tmp

Set to TRUE by admin panels if they want to max out the chance of a light ruleset spawning

var
antag_events_enabled

Whether random events that spawn antagonists or modify dynamic are enabled

var
base_rulesets_to_spawn
– /list

Tracks the number of rulesets to spawn at game start (for admin reference)

var
current_tier
– /datum/dynamic_tier

Reference to a dynamic tier datum, the tier picked for this round

var
dynamic_config
– /list

The config for dynamic loaded from the toml file

var
executed_rulesets
– /list/datum/dynamic_ruleset

List of rulesets that have been executed this round

var
failed_latejoins

Tracks how many time we fail to spawn a latejoin (to up the odds next time)

var
heavy_ruleset_start

Cooldown for when we are allowed to spawn heavy rulesets

var
latejoin_cooldown

Cooldown between latejoin ruleset executions

var
latejoin_ruleset_start

Cooldown for when we are allowed to spawn latejoin rulesets

var
light_ruleset_start

Cooldown for when we are allowed to spawn light rulesets

var
midround_admin_cancel
– /tmp

Set to TRUE by hrefs if admins cancel a midround

var
midround_admin_cancel_period

Cooldown between "we're going to spawn a midround" and "we're actually spawning a midround", to give admins a chance to cancel

var
midround_admin_reroll
– /tmp

Set to TRUE by hrefs if admins reroll a midround

var
midround_cooldown

Cooldown between midround ruleset executions

var
queued_rulesets
– /list/datum/dynamic_ruleset

List of rulesets that have been set up to run, but not yet executed

var
rulesets_to_spawn
– /list

Tracks how many of each ruleset category is yet to be spawned

var
unreported_rulesets
– /list/datum/dynamic_ruleset

Rulesets in this list will be excluded from the roundend report

Proc Details

proc
force_extended
()

Helper to clear all queued rulesets and stop any other rulesets from naturally spawning

proc
force_run_midround
(midround_typepath, forced_max_cap, alert_admins_on_fail, /mob/admin)

Attempt to run a midround ruleset of the given type

midround_type - The type of midround ruleset to force
forced_max_cap - Rather than using the ruleset's max antag cap, use this value As an example, this allows you to only spawn 1 traitor rather than the ruleset's default of 3 Can't be set to 0 (why are you forcing a ruleset that spawns 0 antags?)
alert_admins_on_fail - If TRUE, alert admins if the ruleset fails to prepare/execute
mob/admin - The admin who is forcing the ruleset, used for configuring the ruleset if possible

proc
get_latejoin_chance
()

Gets the chance of a latejoin ruleset being selected

proc
get_latejoin_rulesets
(player_count)

Gets a weighted list of latejoin rulesets

proc
get_midround_chance
(range)

Gets the chance of a midround ruleset being selected

proc
get_midround_rulesets
(player_count, midround_type)

Gets a weighted list of midround rulesets

proc
get_roundstart_rulesets
(/list/antag_candidates)

Gets a weighted list of roundstart rulesets

proc
get_ruleset_cooldown
(range)

Get the cooldown between attempts to spawn a ruleset of the given type

proc
on_latejoin
(/mob/living/carbon/human/latejoiner)

Called when someone latejoins (This could be a signal in the future)

proc
pick_roundstart_rulesets
(/list/antag_candidates)

Picks as many roundstart rulesets as we are allowed to spawn, returns them

proc
pick_tier
(roundstart_population)

Picks what tier we are going to use for this round and sets up all the corresponding variables and ranges

proc
queue_ruleset
(ruleset_typepath)

Queues a ruleset to run on roundstart or next latejoin which fulfills all requirements

For example, if you queue a latejoin revolutionary, it'll only run when population gets large enough and there are enough heads of staff For all latejoins until then, it will simply do nothing

latejoin_type - The type of latejoin ruleset to force

proc
select_roundstart_antagonists
()

Selects which rulesets are to run at roundstart, and sets them up

Note: This proc can sleep (due to lazyloading of templates)!

proc
set_tier
(picked_tier, population)

Sets the tier to the typepath passed in

proc
try_spawn_latejoin
(/mob/living/carbon/human/latejoiner)

Invoked by SSdynamic to try to spawn a latejoin ruleset Respects ranges and thresholds

Returns TRUE if a ruleset was spawned, FALSE otherwise

proc
try_spawn_midround
(range)

Invoked by SSdynamic to try to spawn a random midround ruleset Respects ranges and thresholds

Prioritizes light midround rulesets first, then heavy midround rulesets

Returns TRUE if a ruleset was spawned, FALSE otherwise

dynamic /datum/controller/subsystem/dynamic

Vars

Procs

Var Details

var admin_disabled_rulesets – /tmp/list

var admin_forcing_next_heavy – /tmp

var admin_forcing_next_latejoin – /tmp

var admin_forcing_next_light – /tmp

var antag_events_enabled

var base_rulesets_to_spawn – /list

var current_tier – /datum/dynamic_tier

var dynamic_config – /list

var executed_rulesets – /list/datum/dynamic_ruleset

var failed_latejoins

var heavy_ruleset_start

var latejoin_cooldown

var latejoin_ruleset_start

var light_ruleset_start

var midround_admin_cancel – /tmp

var midround_admin_cancel_period

var midround_admin_reroll – /tmp

var midround_cooldown

var queued_rulesets – /list/datum/dynamic_ruleset

var rulesets_to_spawn – /list

var unreported_rulesets – /list/datum/dynamic_ruleset