1 line
7.5 KiB
HTML
1 line
7.5 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../"><link rel="stylesheet" href="dmdoc.css"><title>/obj/structure/safe - /tg/ Station 13</title></head><body><header><a href="index.html">/tg/ Station 13</a> - <a href="index.html#modules">Modules</a> - <a href="index.html#types">Types</a> — <a href="obj/structure/safe.html#var">Var Details</a> - <a href="obj/structure/safe.html#proc">Proc Details</a></header><main><h1>safe <aside>/<a href="obj.html">obj</a>/<a href="obj/structure/safe.html">structure/safe</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/structures/safe.dm#L13"><img src="git.png" width="16" height="16" title="code/game/objects/structures/safe.dm 13"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/structure/safe.html#var/current_tumbler_index">current_tumbler_index</a></th><td>The index in the tumblers list of the tumbler dial position that needs to be hit</td></tr><tr><th><a href="obj/structure/safe.html#var/dial">dial</a></th><td>The position the dial is pointing to</td></tr><tr><th><a href="obj/structure/safe.html#var/explosion_count">explosion_count</a></th><td>Tough, but breakable if explosion counts reaches set value</td></tr><tr><th><a href="obj/structure/safe.html#var/locked">locked</a></th><td>Whether the safe is locked or not</td></tr><tr><th><a href="obj/structure/safe.html#var/maxspace">maxspace</a></th><td>The maximum combined w_class of stuff in the safe</td></tr><tr><th><a href="obj/structure/safe.html#var/number_of_tumblers">number_of_tumblers</a></th><td>The amount of tumblers that will be generated</td></tr><tr><th><a href="obj/structure/safe.html#var/open">open</a></th><td>Whether the safe is open or not</td></tr><tr><th><a href="obj/structure/safe.html#var/space">space</a></th><td>The combined w_class of everything in the safe</td></tr><tr><th><a href="obj/structure/safe.html#var/tumblers">tumblers</a></th><td>The list of tumbler dial positions that need to be hit</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/structure/safe.html#proc/check_broken">check_broken</a></th><td>Checks if safe is considered in a broken state for force-opening the safe</td></tr><tr><th><a href="obj/structure/safe.html#proc/check_unlocked">check_unlocked</a></th><td>Called every dial turn to determine whether the safe should unlock or not.</td></tr><tr><th><a href="obj/structure/safe.html#proc/notify_user">notify_user</a></th><td>Called every dial turn to provide feedback if possible.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/current_tumbler_index"><aside class="declaration">var </aside>current_tumbler_index <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/structures/safe.dm#L35"><img src="git.png" width="16" height="16" title="code/game/objects/structures/safe.dm 35"></a></h3><p>The index in the tumblers list of the tumbler dial position that needs to be hit</p><h3 id="var/dial"><aside class="declaration">var </aside>dial <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/structures/safe.dm#L31"><img src="git.png" width="16" height="16" title="code/game/objects/structures/safe.dm 31"></a></h3><p>The position the dial is pointing to</p><h3 id="var/explosion_count"><aside class="declaration">var </aside>explosion_count <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/structures/safe.dm#L39"><img src="git.png" width="16" height="16" title="code/game/objects/structures/safe.dm 39"></a></h3><p>Tough, but breakable if explosion counts reaches set value</p><h3 id="var/locked"><aside class="declaration">var </aside>locked <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/structures/safe.dm#L29"><img src="git.png" width="16" height="16" title="code/game/objects/structures/safe.dm 29"></a></h3><p>Whether the safe is locked or not</p><h3 id="var/maxspace"><aside class="declaration">var </aside>maxspace <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/structures/safe.dm#L23"><img src="git.png" width="16" height="16" title="code/game/objects/structures/safe.dm 23"></a></h3><p>The maximum combined w_class of stuff in the safe</p><h3 id="var/number_of_tumblers"><aside class="declaration">var </aside>number_of_tumblers <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/structures/safe.dm#L25"><img src="git.png" width="16" height="16" title="code/game/objects/structures/safe.dm 25"></a></h3><p>The amount of tumblers that will be generated</p><h3 id="var/open"><aside class="declaration">var </aside>open <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/structures/safe.dm#L27"><img src="git.png" width="16" height="16" title="code/game/objects/structures/safe.dm 27"></a></h3><p>Whether the safe is open or not</p><h3 id="var/space"><aside class="declaration">var </aside>space <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/structures/safe.dm#L37"><img src="git.png" width="16" height="16" title="code/game/objects/structures/safe.dm 37"></a></h3><p>The combined w_class of everything in the safe</p><h3 id="var/tumblers"><aside class="declaration">var </aside>tumblers <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/structures/safe.dm#L33"><img src="git.png" width="16" height="16" title="code/game/objects/structures/safe.dm 33"></a></h3><p>The list of tumbler dial positions that need to be hit</p><h2 id="proc">Proc Details</h2><h3 id="proc/check_broken"><aside class="declaration">proc </aside>check_broken<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/structures/safe.dm#L210"><img src="git.png" width="16" height="16" title="code/game/objects/structures/safe.dm 210"></a></aside></h3><p>Checks if safe is considered in a broken state for force-opening the safe</p><h3 id="proc/check_unlocked"><aside class="declaration">proc </aside>check_unlocked<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/structures/safe.dm#L216"><img src="git.png" width="16" height="16" title="code/game/objects/structures/safe.dm 216"></a></aside></h3><p>Called every dial turn to determine whether the safe should unlock or not.</p><h3 id="proc/notify_user"><aside class="declaration">proc </aside>notify_user<aside>(user, canhear, sounds, total_ticks, current_tick) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/structures/safe.dm#L229"><img src="git.png" width="16" height="16" title="code/game/objects/structures/safe.dm 229"></a></aside></h3><p>Called every dial turn to provide feedback if possible.</p></main><footer>tgstation.dme <a href="https://github.com/evilew/GS13-Citadel/tree/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e">e8e0068</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.9.0</a></footer></body></html> |