subsystem

Defines a subsystem to be managed by the Master Controller

Simply define a child of this subsystem, using the [SUBSYSTEM_DEF] macro, and the MC will handle registration. Changing the name is required

Vars
can_fire	Set to 0 to prevent fire() calls, mostly for admin use or subsystems that may be resumed later use the SS_NO_FIRE flag instead for systems that never fire to keep it from even being added to list that is checked every tick
cost	Running average of the amount of milliseconds it takes the subsystem to complete a run (including all resumes but not the time spent paused)
failure_strikes	How many times we suspect a subsystem type has crashed the MC, 3 strikes and you're out!
flags	Subsystem Flags to control binary behavior. Flags must be set at compile time or before preinit finishes to take full effect. (You can also restart the mc to force them to process again)
init_order	Order of initialization. Higher numbers are initialized first, lower numbers later. Use or create defines such as [INIT_ORDER_DEFAULT] so we can see the order in one file.
init_stage	Which stage does this subsystem init at. Earlier stages can fire while later stages init.
initialization_failure_message	String to store an applicable error message for a subsystem crashing, used to help debug crashes in contexts such as Continuous Integration/Unit Tests
initialized	This var is set to TRUE after the subsystem has been initialized.
last_fire	Last world.time the subsystem completed a run (as in wasn't paused by [MC_TICK_CHECK])
name	Name of the subsystem - you must change this
next_fire	Scheduled world.time for next fire()
paused_tick_usage	Tracks how much of a tick the subsystem has consumed in the current run
paused_ticks	Tracks how many fires the subsystem has consecutively paused on in the current run
postponed_fires	How many fires have we been requested to postpone
priority	Priority Weight: When multiple subsystems need to run in the same tick, higher priority subsystems will be given a higher share of the tick before MC_TICK_CHECK triggers a sleep, higher priority subsystems also run before lower priority subsystems
profiler_focused	boolean set by admins. if TRUE then this subsystem will stop the world profiler after ignite() returns and start it again when called. used so that you can audit a specific subsystem or group of subsystems' synchronous call chain.
queue_next	Next subsystem in the queue of subsystems to run this tick
queue_prev	Previous subsystem in the queue of subsystems to run this tick
queued_priority	Priority at the time the subsystem entered the queue. Needed to avoid changes in priority (by admins and the like) from breaking things.
queued_time	Time the subsystem entered the queue, (for timing and priority reasons)
rolling_usage	Flat list of usage and time, every odd index is a log time, every even index is a usage
runlevels	Bitmap of what game states can this subsystem fire at. See [RUNLEVELS_DEFAULT] for more details.
slept_count	Tracks how many times a subsystem has ever slept in fire().
state	Tracks the current execution state of the subsystem. Used to handle subsystems that sleep in fire so the mc doesn't run them again while they are sleeping
tick_allocation_avg	How much of a tick (in percents of a tick) do we get allocated by the mc on avg.
tick_allocation_last	How much of a tick (in percents of a tick) were we allocated last fire.
tick_overrun	Running average of the amount of tick usage (in percents of a game tick) the subsystem has spent past its allocated time without pausing
tick_usage	Running average of the amount of tick usage in percents of a tick it takes the subsystem to complete a run
ticks	Tracks how many fires the subsystem takes to complete a run on average.
times_fired	Tracks the amount of completed runs for the subsystem
wait	Time to wait (in deciseconds) between each call to fire(). Must be a positive integer.
Procs
Initialize	Used to initialize the subsystem. This is expected to be overridden by subtypes.
OnConfigLoad	Called after the config has been loaded or reloaded.
PreInit	datum/controller/subsystem/New()
enqueue	Queue it to run. (we loop thru a linked list until we get to the end or find the right point) (this lets us sort our run order correctly without having to re-sort the entire already sorted list)
fire	previously, this would have been named 'process()' but that name is used everywhere for different things! fire() seems more suitable. This is the procedure that gets called every 'wait' deciseconds. Sleeping in here prevents future fires until returned.
ignite	This is used so the mc knows when the subsystem sleeps. do not override.
postpone	Causes the next "cycle" fires to be missed. Effect is accumulative but can reset by calling update_nextfire(reset_time = TRUE)
prune_rolling_usage	Prunes out of date entries in our rolling usage list
update_nextfire

Var Details

var
can_fire
–

Set to 0 to prevent fire() calls, mostly for admin use or subsystems that may be resumed later use the SS_NO_FIRE flag instead for systems that never fire to keep it from even being added to list that is checked every tick

var
cost
–

Running average of the amount of milliseconds it takes the subsystem to complete a run (including all resumes but not the time spent paused)

var
failure_strikes
– /static/list

How many times we suspect a subsystem type has crashed the MC, 3 strikes and you're out!

var
flags
–

Subsystem Flags to control binary behavior. Flags must be set at compile time or before preinit finishes to take full effect. (You can also restart the mc to force them to process again)

var
init_order
–

Order of initialization. Higher numbers are initialized first, lower numbers later. Use or create defines such as [INIT_ORDER_DEFAULT] so we can see the order in one file.

var
init_stage
–

Which stage does this subsystem init at. Earlier stages can fire while later stages init.

var
initialization_failure_message
–

String to store an applicable error message for a subsystem crashing, used to help debug crashes in contexts such as Continuous Integration/Unit Tests

var
initialized
–

This var is set to TRUE after the subsystem has been initialized.

var
last_fire
–

Last world.time the subsystem completed a run (as in wasn't paused by [MC_TICK_CHECK])

name
–

Name of the subsystem - you must change this

var
next_fire
–

Scheduled world.time for next fire()

var
paused_tick_usage
–

Tracks how much of a tick the subsystem has consumed in the current run

var
paused_ticks
–

Tracks how many fires the subsystem has consecutively paused on in the current run

var
postponed_fires
–

How many fires have we been requested to postpone

var
priority
–

Priority Weight: When multiple subsystems need to run in the same tick, higher priority subsystems will be given a higher share of the tick before MC_TICK_CHECK triggers a sleep, higher priority subsystems also run before lower priority subsystems

var
profiler_focused
–

boolean set by admins. if TRUE then this subsystem will stop the world profiler after ignite() returns and start it again when called. used so that you can audit a specific subsystem or group of subsystems' synchronous call chain.

var
queue_next
– /datum/controller/subsystem

Next subsystem in the queue of subsystems to run this tick

var
queue_prev
– /datum/controller/subsystem

Previous subsystem in the queue of subsystems to run this tick

var
queued_priority
–

Priority at the time the subsystem entered the queue. Needed to avoid changes in priority (by admins and the like) from breaking things.

var
queued_time
–

Time the subsystem entered the queue, (for timing and priority reasons)

var
rolling_usage
– /list

Flat list of usage and time, every odd index is a log time, every even index is a usage

var
runlevels
–

Bitmap of what game states can this subsystem fire at. See [RUNLEVELS_DEFAULT] for more details.

var
slept_count
–

Tracks how many times a subsystem has ever slept in fire().

var
state
–

Tracks the current execution state of the subsystem. Used to handle subsystems that sleep in fire so the mc doesn't run them again while they are sleeping

var
tick_allocation_avg
–

How much of a tick (in percents of a tick) do we get allocated by the mc on avg.

var
tick_allocation_last
–

How much of a tick (in percents of a tick) were we allocated last fire.

var
tick_overrun
–

Running average of the amount of tick usage (in percents of a game tick) the subsystem has spent past its allocated time without pausing

var
tick_usage
–

Running average of the amount of tick usage in percents of a tick it takes the subsystem to complete a run

var
ticks
–

Tracks how many fires the subsystem takes to complete a run on average.

var
times_fired
–

Tracks the amount of completed runs for the subsystem

var
wait
–

Time to wait (in deciseconds) between each call to fire(). Must be a positive integer.

Proc Details

Initialize
()

Used to initialize the subsystem. This is expected to be overridden by subtypes.

proc
OnConfigLoad
()

Called after the config has been loaded or reloaded.

proc
PreInit
()

datum/controller/subsystem/New()

proc
enqueue
()

Queue it to run. (we loop thru a linked list until we get to the end or find the right point) (this lets us sort our run order correctly without having to re-sort the entire already sorted list)

proc
fire
(resumed)

previously, this would have been named 'process()' but that name is used everywhere for different things! fire() seems more suitable. This is the procedure that gets called every 'wait' deciseconds. Sleeping in here prevents future fires until returned.

proc
ignite
(resumed)

This is used so the mc knows when the subsystem sleeps. do not override.

proc
postpone
(cycles)

Causes the next "cycle" fires to be missed. Effect is accumulative but can reset by calling update_nextfire(reset_time = TRUE)

proc
prune_rolling_usage
()

Prunes out of date entries in our rolling usage list

proc
update_nextfire
(reset_time)

Update next_fire for the next run.
reset_time (bool) - Ignore things that would normally alter the next fire, like tick_overrun, and last_fire. (also resets postpone)

Subsystem base class /datum/controller/subsystem

Vars

Procs

Var Details

var can_fire –

var cost –

var failure_strikes – /static/list

var flags –

var init_order –

var init_stage –

var initialization_failure_message –

var initialized –

var last_fire –

name –

var next_fire –

var paused_tick_usage –

var paused_ticks –

var postponed_fires –

var priority –

var profiler_focused –

var queue_next – /datum/controller/subsystem

var queue_prev – /datum/controller/subsystem

var queued_priority –

var queued_time –

var rolling_usage – /list

var runlevels –

var slept_count –

var state –

var tick_allocation_avg –

var tick_allocation_last –

var tick_overrun –

var tick_usage –

var ticks –

var times_fired –

var wait –