Files

3 lines
13 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/controller/master - Space Station 13</title></head><body><header><a href="index.html">Space Station 13</a> - <a href="index.html#modules">Modules</a> - <a href="index.html#types">Types</a><a href="datum/controller/master.html#var">Var Details</a> - <a href="datum/controller/master.html#proc">Proc Details</a></header><main><h1>master <aside>/<a href="datum.html">datum</a>/<a href="datum/controller.html">controller</a>/<a href="datum/controller/master.html">master</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L18"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 18"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/controller/master.html#var/current_runlevel">current_runlevel</a></th><td>For scheduling different subsystems for different stages of the round</td></tr><tr><th><a href="datum/controller/master.html#var/current_ticklimit">current_ticklimit</a></th><td>Current tick limit, assigned before running a subsystem. Used by CHECK_TICK as well so that the procs subsystems call can obey that SS's tick limits</td></tr><tr><th><a href="datum/controller/master.html#var/initializations_finished_with_no_players_logged_in">initializations_finished_with_no_players_logged_in</a></th><td>Did inits finish with no one logged in</td></tr><tr><th><a href="datum/controller/master.html#var/iteration">iteration</a></th><td>How many times have we ran</td></tr><tr><th><a href="datum/controller/master.html#var/last_init_info">last_init_info</a></th><td>Last reported init info</td></tr><tr><th><a href="datum/controller/master.html#var/last_processed">last_processed</a></th><td>The last subsystem to be fire()'d.</td></tr><tr><th><a href="datum/controller/master.html#var/last_run">last_run</a></th><td>world.time of last fire, for tracking lag outside of the mc</td></tr><tr><th><a href="datum/controller/master.html#var/make_runtime">make_runtime</a></th><td>Set this to 1 to debug the MC with a detailed stack trace. Do not set on a production server.</td></tr><tr><th><a href="datum/controller/master.html#var/map_loading">map_loading</a></th><td>Are we loading in a new map?</td></tr><tr><th><a href="datum/controller/master.html#var/processing">processing</a></th><td>Are we processing (higher values increase the processing delay by n ticks)</td></tr><tr><th><a href="datum/controller/master.html#var/queue_head">queue_head</a></th><td>Start of queue linked list</td></tr><tr><th><a href="datum/controller/master.html#var/queue_priority_count">queue_priority_count</a></th><td>Running total so that we don't have to loop thru the queue each run to split up the tick</td></tr><tr><th><a href="datum/controller/master.html#var/queue_priority_count_bg">queue_priority_count_bg</a></th><td>Same, but for background subsystems</td></tr><tr><th><a href="datum/controller/master.html#var/queue_tail">queue_tail</a></th><td>End of queue linked list (used for appending to the list)</td></tr><tr><th><a href="datum/controller/master.html#var/random_seed">random_seed</a></th><td>Random seed generated for randomness if entropy is required</td></tr><tr><th><a href="datum/controller/master.html#var/skip_ticks">skip_ticks</a></th><td>Only run ticker subsystems for the next n ticks.</td></tr><tr><th><a href="datum/controller/master.html#var/sleep_delta">sleep_delta</a></th><td>How long is the MC sleeping between runs, read only (set by Loop() based off of anti-tick-contention heuristics)</td></tr><tr><th><a href="datum/controller/master.html#var/sleep_offline_after_initializations">sleep_offline_after_initializations</a></th><td>Do we want to sleep until players log in?</td></tr><tr><th><a href="datum/controller/master.html#var/ss_in_init_order">ss_in_init_order</a></th><td>Cache for the loading screen - cleared after</td></tr><tr><th><a href="datum/controller/master.html#var/subsystems">subsystems</a></th><td>List of subsystems to fire().</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/controller/master.html#proc/RunQueue">RunQueue</a></th><td>RunQueue - Run thru the queue of subsystems to run, running them while balancing out their allocated tick precentage
Returns 0 if runtimed, a negitive number for logic errors, and a positive number if the operation completed without errors</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/current_runlevel"><aside class="declaration">var </aside>current_runlevel <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L70"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 70"></a></h3><p>For scheduling different subsystems for different stages of the round</p><h3 id="var/current_ticklimit"><aside class="declaration">var </aside>current_ticklimit <aside> /static</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L82"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 82"></a></h3><p>Current tick limit, assigned before running a subsystem. Used by CHECK_TICK as well so that the procs subsystems call can obey that SS's tick limits</p><h3 id="var/initializations_finished_with_no_players_logged_in"><aside class="declaration">var </aside>initializations_finished_with_no_players_logged_in <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L50"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 50"></a></h3><p>Did inits finish with no one logged in</p><h3 id="var/iteration"><aside class="declaration">var </aside>iteration <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L24"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 24"></a></h3><p>How many times have we ran</p><h3 id="var/last_init_info"><aside class="declaration">var </aside>last_init_info <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L33"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 33"></a></h3><p>Last reported init info</p><h3 id="var/last_processed"><aside class="declaration">var </aside>last_processed <aside> /<a href="datum.html">datum</a>/<a href="datum/controller.html">controller</a>/<a href="datum/controller/subsystem.html">subsystem</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L53"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 53"></a></h3><p>The last subsystem to be fire()'d.</p><h3 id="var/last_run"><aside class="declaration">var </aside>last_run <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L27"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 27"></a></h3><p>world.time of last fire, for tracking lag outside of the mc</p><h3 id="var/make_runtime"><aside class="declaration">var </aside>make_runtime <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L44"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 44"></a></h3><p>Set this to 1 to debug the MC with a detailed stack trace. Do not set on a production server.</p><h3 id="var/map_loading"><aside class="declaration">var </aside>map_loading <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L67"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 67"></a></h3><p>Are we loading in a new map?</p><h3 id="var/processing"><aside class="declaration">var </aside>processing <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L22"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 22"></a></h3><p>Are we processing (higher values increase the processing delay by n ticks)</p><h3 id="var/queue_head"><aside class="declaration">var </aside>queue_head <aside> /<a href="datum.html">datum</a>/<a href="datum/controller.html">controller</a>/<a href="datum/controller/subsystem.html">subsystem</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L59"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 59"></a></h3><p>Start of queue linked list</p><h3 id="var/queue_priority_count"><aside class="declaration">var </aside>queue_priority_count <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L63"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 63"></a></h3><p>Running total so that we don't have to loop thru the queue each run to split up the tick</p><h3 id="var/queue_priority_count_bg"><aside class="declaration">var </aside>queue_priority_count_bg <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L65"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 65"></a></h3><p>Same, but for background subsystems</p><h3 id="var/queue_tail"><aside class="declaration">var </aside>queue_tail <aside> /<a href="datum.html">datum</a>/<a href="datum/controller.html">controller</a>/<a href="datum/controller/subsystem.html">subsystem</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L61"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 61"></a></h3><p>End of queue linked list (used for appending to the list)</p><h3 id="var/random_seed"><aside class="declaration">var </aside>random_seed <aside> /static</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L79"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 79"></a></h3><p>Random seed generated for randomness if entropy is required</p><h3 id="var/skip_ticks"><aside class="declaration">var </aside>skip_ticks <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L47"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 47"></a></h3><p>Only run ticker subsystems for the next n ticks.</p><h3 id="var/sleep_delta"><aside class="declaration">var </aside>sleep_delta <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L41"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 41"></a></h3><p>How long is the MC sleeping between runs, read only (set by Loop() based off of anti-tick-contention heuristics)</p><h3 id="var/sleep_offline_after_initializations"><aside class="declaration">var </aside>sleep_offline_after_initializations <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L72"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 72"></a></h3><p>Do we want to sleep until players log in?</p><h3 id="var/ss_in_init_order"><aside class="declaration">var </aside>ss_in_init_order <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L56"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 56"></a></h3><p>Cache for the loading screen - cleared after</p><h3 id="var/subsystems"><aside class="declaration">var </aside>subsystems <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L30"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 30"></a></h3><p>List of subsystems to fire().</p><h2 id="proc">Proc Details</h2><h3 id="proc/RunQueue"><aside class="declaration">proc </aside>RunQueue<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/master.dm#L503"><img src="git.png" width="16" height="16" title="code/controllers/master.dm 503"></a></aside></h3><p>RunQueue - Run thru the queue of subsystems to run, running them while balancing out their allocated tick precentage
Returns 0 if runtimed, a negitive number for logic errors, and a positive number if the operation completed without errors</p></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/8a8a00a2a9bec485351e5f219982b7315d3504fa">8a8a00a</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html>