cyberpresidentvanellope/Paradise
1
0
Fork 0
mirror of https://github.com/ParadiseSS13/Paradise.git synced 2026-08-27 14:07:51 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
Paradise/datum/controller/subsystem/security_level.html
T

29 lines
10 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/subsystem/security_level - 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/subsystem/security_level.html#var">Var Details</a> - <a href="datum/controller/subsystem/security_level.html#proc">Proc Details</a></header><main><h1>security_level <aside>/<a href="datum.html">datum</a>/<a href="datum/controller.html">controller</a>/<a href="datum/controller/subsystem.html">subsystem</a>/<a href="datum/controller/subsystem/security_level.html">security_level</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/SSsecurity_level.dm#L6"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSsecurity_level.dm 6"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/controller/subsystem/security_level.html#var/available_levels">available_levels</a></th><td>A list of initialised security level datums</td></tr><tr><th><a href="datum/controller/subsystem/security_level.html#var/current_security_level">current_security_level</a></th><td>Currently set security level</td></tr><tr><th><a href="datum/controller/subsystem/security_level.html#var/security_level_set_timer_id">security_level_set_timer_id</a></th><td>Option reference of a timer id of the latest set security level. Only set when security level is changed to one with <code>set_delay</code> &gt; 0</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/controller/subsystem/security_level.html#proc/announce_security_level">announce_security_level</a></th><td>Handles announcements of the newly set security level</td></tr><tr><th><a href="datum/controller/subsystem/security_level.html#proc/do_set_level">do_set_level</a></th><td>Actually sets the security level after the announcement</td></tr><tr><th><a href="datum/controller/subsystem/security_level.html#proc/get_colored_current_security_level_name">get_colored_current_security_level_name</a></th><td>Returns security level name formatted with it's color</td></tr><tr><th><a href="datum/controller/subsystem/security_level.html#proc/get_current_level_as_number">get_current_level_as_number</a></th><td>Returns the current security level as a number
In case the subsystem hasn't finished initializing yet, returns default security level</td></tr><tr><th><a href="datum/controller/subsystem/security_level.html#proc/get_current_level_as_text">get_current_level_as_text</a></th><td>Returns the current security level as text</td></tr><tr><th><a href="datum/controller/subsystem/security_level.html#proc/number_level_to_text">number_level_to_text</a></th><td>Converts a number security level to a text</td></tr><tr><th><a href="datum/controller/subsystem/security_level.html#proc/pre_set_level">pre_set_level</a></th><td>Do things before the actual security level set, like executing security level specific pre change behavior</td></tr><tr><th><a href="datum/controller/subsystem/security_level.html#proc/set_level">set_level</a></th><td>Sets a new security level as our current level</td></tr><tr><th><a href="datum/controller/subsystem/security_level.html#proc/text_level_to_number">text_level_to_number</a></th><td>Converts a text security level to a number</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/available_levels"><aside class="declaration">var </aside>available_levels <aside>– /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/SSsecurity_level.dm#L14"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSsecurity_level.dm 14"></a></h3><p>A list of initialised security level datums</p><h3 id="var/current_security_level"><aside class="declaration">var </aside>current_security_level <aside>– /<a href="datum.html">datum</a>/<a href="datum/security_level.html">security_level</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/SSsecurity_level.dm#L12"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSsecurity_level.dm 12"></a></h3><p>Currently set security level</p><h3 id="var/security_level_set_timer_id"><aside class="declaration">var </aside>security_level_set_timer_id <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/SSsecurity_level.dm#L10"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSsecurity_level.dm 10"></a></h3><p>Option reference of a timer id of the latest set security level. Only set when security level is changed to one with <code>set_delay</code> &gt; 0</p><h2 id="proc">Proc Details</h2><h3 id="proc/announce_security_level"><aside class="declaration">proc </aside>announce_security_level<aside>(/<a href="datum.html">datum</a>/<a href="datum/security_level.html">security_level</a>/selected_level) <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/SSsecurity_level.dm#L102"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSsecurity_level.dm 102"></a></aside></h3><p>Handles announcements of the newly set security level</p>
<p>Arguments:</p>
<ul>
<li>selected_level - The new security level that has been set</li>
</ul><h3 id="proc/do_set_level"><aside class="declaration">proc </aside>do_set_level<aside>(/<a href="datum.html">datum</a>/<a href="datum/security_level.html">security_level</a>/selected_level) <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/SSsecurity_level.dm#L79"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSsecurity_level.dm 79"></a></aside></h3><p>Actually sets the security level after the announcement</p>
<p>Sends <code>COMSIG_SECURITY_LEVEL_CHANGED</code> in the end</p>
<p>Arguments:</p>
<ul>
<li>selected_level - The datum of security level selected to be changed to</li>
</ul><h3 id="proc/get_colored_current_security_level_name"><aside class="declaration">proc </aside>get_colored_current_security_level_name<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/SSsecurity_level.dm#L154"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSsecurity_level.dm 154"></a></aside></h3><p>Returns security level name formatted with it's color</p><h3 id="proc/get_current_level_as_number"><aside class="declaration">proc </aside>get_current_level_as_number<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/SSsecurity_level.dm#L120"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSsecurity_level.dm 120"></a></aside></h3><p>Returns the current security level as a number
In case the subsystem hasn't finished initializing yet, returns default security level</p><h3 id="proc/get_current_level_as_text"><aside class="declaration">proc </aside>get_current_level_as_text<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/SSsecurity_level.dm#L126"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSsecurity_level.dm 126"></a></aside></h3><p>Returns the current security level as text</p><h3 id="proc/number_level_to_text"><aside class="declaration">proc </aside>number_level_to_text<aside>(number_level) <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/SSsecurity_level.dm#L145"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSsecurity_level.dm 145"></a></aside></h3><p>Converts a number security level to a text</p>
<p>Arguments:</p>
<ul>
<li>level - The number security level to convert</li>
</ul><h3 id="proc/pre_set_level"><aside class="declaration">proc </aside>pre_set_level<aside>(/<a href="datum.html">datum</a>/<a href="datum/security_level.html">security_level</a>/selected_level) <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/SSsecurity_level.dm#L66"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSsecurity_level.dm 66"></a></aside></h3><p>Do things before the actual security level set, like executing security level specific pre change behavior</p>
<p>Arguments:</p>
<ul>
<li>selected_level - The datum of security level selected to be changed to</li>
</ul><h3 id="proc/set_level"><aside class="declaration">proc </aside>set_level<aside>(new_level) <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/SSsecurity_level.dm#L38"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSsecurity_level.dm 38"></a></aside></h3><p>Sets a new security level as our current level</p>
<p>This is how everything should change the security level</p>
<p>Arguments:</p>
<ul>
<li>new_level - The new security level that will become our current level, could be number or name of security level</li>
</ul><h3 id="proc/text_level_to_number"><aside class="declaration">proc </aside>text_level_to_number<aside>(text_level) <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/SSsecurity_level.dm#L135"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSsecurity_level.dm 135"></a></aside></h3><p>Converts a text security level to a number</p>
<p>Arguments:</p>
<ul>
<li>level - The text security level to convert</li>
</ul></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/776b9861f70566b1e6a0763a465ef22f7920a3d6">776b986</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html>
Reference in New Issue View Git Blame Copy Permalink