cyberpresidentvanellope/Paradise
1
0
Fork 0
mirror of https://github.com/ParadiseSS13/Paradise.git synced 2026-08-30 07:27:57 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
Paradise/obj/item/rcd.html
T

34 lines
17 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>/obj/item/rcd - 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="obj/item/rcd.html#var">Var Details</a> - <a href="obj/item/rcd.html#proc">Proc Details</a></header><main><h1>rcd <aside>/<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/<a href="obj/item/rcd.html">rcd</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L219"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 219"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/item/rcd.html#var/airlock_glass">airlock_glass</a></th><td>If the airlock will be created with glass so it can be seen through.</td></tr><tr><th><a href="obj/item/rcd.html#var/allowed_targets">allowed_targets</a></th><td>A list of valid atoms that RCDs can target. Clicking on an atom with an RCD which is not in this list, will do nothing.</td></tr><tr><th><a href="obj/item/rcd.html#var/can_rwall">can_rwall</a></th><td>If the RCD can deconstruct reinforced walls.</td></tr><tr><th><a href="obj/item/rcd.html#var/door_accesses_list">door_accesses_list</a></th><td>An associative list containing all station accesses. Includes their name and access number. For use with the UI.</td></tr><tr><th><a href="obj/item/rcd.html#var/door_name">door_name</a></th><td>The name that newly build airlocks will receive.</td></tr><tr><th><a href="obj/item/rcd.html#var/door_type">door_type</a></th><td>The current airlock type that will be build.</td></tr><tr><th><a href="obj/item/rcd.html#var/door_types_ui_list">door_types_ui_list</a></th><td>An associative list containing an airlock's name, type path, and image. For use with the UI.</td></tr><tr><th><a href="obj/item/rcd.html#var/electrochromic">electrochromic</a></th><td>If the glass airlock is polarized.</td></tr><tr><th><a href="obj/item/rcd.html#var/locked">locked</a></th><td>Is the RCD's airlock access selection menu locked?</td></tr><tr><th><a href="obj/item/rcd.html#var/matter">matter</a></th><td>The current amount of matter stored.</td></tr><tr><th><a href="obj/item/rcd.html#var/max_matter">max_matter</a></th><td>The max amount of matter that can be stored.</td></tr><tr><th><a href="obj/item/rcd.html#var/mode">mode</a></th><td>The RCD's current build mode.</td></tr><tr><th><a href="obj/item/rcd.html#var/no_ammo_message">no_ammo_message</a></th><td>No ammo warning</td></tr><tr><th><a href="obj/item/rcd.html#var/one_access">one_access</a></th><td>If this is TRUE, any airlocks that gets built will require only ONE of the checked accesses. If FALSE, it will require ALL of them.</td></tr><tr><th><a href="obj/item/rcd.html#var/possible_actions">possible_actions</a></th><td>The list of potential RCD actions.</td></tr><tr><th><a href="obj/item/rcd.html#var/rcd_door_types">rcd_door_types</a></th><td>An associative list of airlock type paths as keys, and their names as values.</td></tr><tr><th><a href="obj/item/rcd.html#var/selected_accesses">selected_accesses</a></th><td>A list of access numbers which have been checked off by the user in the UI.</td></tr><tr><th><a href="obj/item/rcd.html#var/spark_system">spark_system</a></th><td>The spark system used to create sparks when the user interacts with the RCD.</td></tr><tr><th><a href="obj/item/rcd.html#var/ui_tab">ui_tab</a></th><td>Which airlock tab the UI is currently set to display.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/item/rcd.html#proc/check_menu">check_menu</a></th><td>Runs a series of pre-checks before opening the radial menu to the user.</td></tr><tr><th><a href="obj/item/rcd.html#proc/detonate_pulse">detonate_pulse</a></th><td>Called from malf AI's &quot;detonate RCD&quot; ability.</td></tr><tr><th><a href="obj/item/rcd.html#proc/detonate_pulse_explode">detonate_pulse_explode</a></th><td>Called in <code>/obj/item/rcd/proc/detonate_pulse()</code> via callback.</td></tr><tr><th><a href="obj/item/rcd.html#proc/get_airlock_image">get_airlock_image</a></th><td>Creates and returns a base64 icon of the given <code>airlock_type</code>.</td></tr><tr><th><a href="obj/item/rcd.html#proc/load">load</a></th><td>Tries to load ammo into an RCD, borgs will not use this.
Arguments:</td></tr><tr><th><a href="obj/item/rcd.html#proc/radial_menu">radial_menu</a></th><td>Creates and displays a radial menu to a user when they trigger the <code>attack_self</code> of the RCD.</td></tr><tr><th><a href="obj/item/rcd.html#proc/tool_use_check">tool_use_check</a></th><td>Called in each of the four build modes before an object gets build. Makes sure there is enough matter to build the object.</td></tr><tr><th><a href="obj/item/rcd.html#proc/ui_act_modal">ui_act_modal</a></th><td>Called in ui_act() to process modal actions</td></tr><tr><th><a href="obj/item/rcd.html#proc/use">use</a></th><td>Attempts to use matter from the RCD.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/airlock_glass"><aside class="declaration">var </aside>airlock_glass <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L256"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 256"></a></h3><p>If the airlock will be created with glass so it can be seen through.</p><h3 id="var/allowed_targets"><aside class="declaration">var </aside>allowed_targets <aside>– /static/list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L264"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 264"></a></h3><p>A list of valid atoms that RCDs can target. Clicking on an atom with an RCD which is not in this list, will do nothing.</p><h3 id="var/can_rwall"><aside class="declaration">var </aside>can_rwall <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L246"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 246"></a></h3><p>If the RCD can deconstruct reinforced walls.</p><h3 id="var/door_accesses_list"><aside class="declaration">var </aside>door_accesses_list <aside>– /static/list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L270"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 270"></a></h3><p>An associative list containing all station accesses. Includes their name and access number. For use with the UI.</p><h3 id="var/door_name"><aside class="declaration">var </aside>door_name <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L252"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 252"></a></h3><p>The name that newly build airlocks will receive.</p><h3 id="var/door_type"><aside class="declaration">var </aside>door_type <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L250"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 250"></a></h3><p>The current airlock type that will be build.</p><h3 id="var/door_types_ui_list"><aside class="declaration">var </aside>door_types_ui_list <aside>– /static/list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L268"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 268"></a></h3><p>An associative list containing an airlock's name, type path, and image. For use with the UI.</p><h3 id="var/electrochromic"><aside class="declaration">var </aside>electrochromic <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L254"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 254"></a></h3><p>If the glass airlock is polarized.</p><h3 id="var/locked"><aside class="declaration">var </aside>locked <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L248"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 248"></a></h3><p>Is the RCD's airlock access selection menu locked?</p><h3 id="var/matter"><aside class="declaration">var </aside>matter <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L240"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 240"></a></h3><p>The current amount of matter stored.</p><h3 id="var/max_matter"><aside class="declaration">var </aside>max_matter <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L242"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 242"></a></h3><p>The max amount of matter that can be stored.</p><h3 id="var/mode"><aside class="declaration">var </aside>mode <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L244"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 244"></a></h3><p>The RCD's current build mode.</p><h3 id="var/no_ammo_message"><aside class="declaration">var </aside>no_ammo_message <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L236"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 236"></a></h3><p>No ammo warning</p><h3 id="var/one_access"><aside class="declaration">var </aside>one_access <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L258"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 258"></a></h3><p>If this is TRUE, any airlocks that gets built will require only ONE of the checked accesses. If FALSE, it will require ALL of them.</p><h3 id="var/possible_actions"><aside class="declaration">var </aside>possible_actions <aside>– /static/list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L272"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 272"></a></h3><p>The list of potential RCD actions.</p><h3 id="var/rcd_door_types"><aside class="declaration">var </aside>rcd_door_types <aside>– /static/list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L266"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 266"></a></h3><p>An associative list of airlock type paths as keys, and their names as values.</p><h3 id="var/selected_accesses"><aside class="declaration">var </aside>selected_accesses <aside>– /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L262"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 262"></a></h3><p>A list of access numbers which have been checked off by the user in the UI.</p><h3 id="var/spark_system"><aside class="declaration">var </aside>spark_system <aside>– /<a href="datum.html">datum</a>/<a href="datum/effect_system.html">effect_system</a>/spark_spread</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L238"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 238"></a></h3><p>The spark system used to create sparks when the user interacts with the RCD.</p><h3 id="var/ui_tab"><aside class="declaration">var </aside>ui_tab <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L260"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 260"></a></h3><p>Which airlock tab the UI is currently set to display.</p><h2 id="proc">Proc Details</h2><h3 id="proc/check_menu"><aside class="declaration">proc </aside>check_menu<aside>(/<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/user) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L396"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 396"></a></aside></h3><p>Runs a series of pre-checks before opening the radial menu to the user.</p>
<p>Arguments:</p>
<ul>
<li>user - the mob trying to open the radial menu.</li>
</ul><h3 id="proc/detonate_pulse"><aside class="declaration">proc </aside>detonate_pulse<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L692"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 692"></a></aside></h3><p>Called from malf AI's &quot;detonate RCD&quot; ability.</p>
<p>Creates a delayed explosion centered around the RCD.</p><h3 id="proc/detonate_pulse_explode"><aside class="declaration">proc </aside>detonate_pulse_explode<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L700"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 700"></a></aside></h3><p>Called in <code>/obj/item/rcd/proc/detonate_pulse()</code> via callback.</p><h3 id="proc/get_airlock_image"><aside class="declaration">proc </aside>get_airlock_image<aside>(airlock_type) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L379"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 379"></a></aside></h3><p>Creates and returns a base64 icon of the given <code>airlock_type</code>.</p>
<p>This is used for airlock icon previews in the UI.</p>
<p>Arugments:</p>
<ul>
<li>airlock_type - an airlock typepath.</li>
</ul><h3 id="proc/load"><aside class="declaration">proc </aside>load<aside>(/<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/rcd_ammo/cart, /<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/user) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L408"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 408"></a></aside></h3><p>Tries to load ammo into an RCD, borgs will not use this.
Arguments:</p>
<ul>
<li>cart - the compressed matter catridge to insert</li>
<li>user - the user to display the chat messages to</li>
</ul><h3 id="proc/radial_menu"><aside class="declaration">proc </aside>radial_menu<aside>(/<a href="mob.html">mob</a>/user) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L435"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 435"></a></aside></h3><p>Creates and displays a radial menu to a user when they trigger the <code>attack_self</code> of the RCD.</p>
<p>Arguments:</p>
<ul>
<li>user - the mob trying to open the RCD radial.</li>
</ul><h3 id="proc/tool_use_check">tool_use_check<aside>(/<a href="mob.html">mob</a>/user, amount) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L653"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 653"></a></aside></h3><p>Called in each of the four build modes before an object gets build. Makes sure there is enough matter to build the object.</p>
<p>Arguments:</p>
<ul>
<li>amount - an amount of matter to check for</li>
</ul><h3 id="proc/ui_act_modal"><aside class="declaration">proc </aside>ui_act_modal<aside>(action, /list/params) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L597"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 597"></a></aside></h3><p>Called in ui_act() to process modal actions</p>
<p>Arguments:</p>
<ul>
<li>action - The action passed by tgui</li>
<li>params - The params passed by tgui</li>
</ul><h3 id="proc/use"><aside class="parent"><a title="/obj/item" href="obj/item.html#proc/use">↑</a></aside>use<aside>(amount) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/game/objects/items/RCD.dm#L639"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 639"></a></aside></h3><p>Attempts to use matter from the RCD.</p>
<p>Arguments:</p>
<ul>
<li>amount - the amount of matter to use</li>
</ul></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/edee60476d21ee840643bd1abe7f6003a8c65773">edee604</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