mirror of
https://github.com/ParadiseSS13/Paradise.git
synced 2026-08-28 14:37:04 +01:00
1 line
6.1 KiB
HTML
1 line
6.1 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/rcd_act - 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/rcd_act.html#var">Var Details</a> - <a href="datum/rcd_act.html#proc">Proc Details</a></header><main><h1>rcd_act <aside>/<a href="datum.html">datum</a>/<a href="datum/rcd_act.html">rcd_act</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/RCD.dm#L10"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 10"></a></h1><p>A generic action for an RCD.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/rcd_act.html#var/cost">cost</a></th><td>How much compressed matter this action costs.</td></tr><tr><th><a href="datum/rcd_act.html#var/delay">delay</a></th><td>How long this action takes.</td></tr><tr><th><a href="datum/rcd_act.html#var/end_effect_type">end_effect_type</a></th><td>The effect (if any) to create when the action completes.</td></tr><tr><th><a href="datum/rcd_act.html#var/mode">mode</a></th><td>The mode the RCD must be in.</td></tr><tr><th><a href="datum/rcd_act.html#var/start_effect_type">start_effect_type</a></th><td>The effect (if any) to create when the action starts.</td></tr><tr><th><a href="datum/rcd_act.html#var/start_message">start_message</a></th><td>The message (if any) to send the user when the action starts.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/rcd_act.html#proc/act">act</a></th><td>Perform the act. You should usually override this.</td></tr><tr><th><a href="datum/rcd_act.html#proc/can_act">can_act</a></th><td>Test to see if the act is possible. You should usually override this.</td></tr><tr><th><a href="datum/rcd_act.html#proc/try_act">try_act</a></th><td>Attempt the action. This should not need to be overridden.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/cost"><aside class="declaration">var </aside>cost <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/RCD.dm#L12"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 12"></a></h3><p>How much compressed matter this action costs.</p><h3 id="var/delay"><aside class="declaration">var </aside>delay <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/RCD.dm#L14"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 14"></a></h3><p>How long this action takes.</p><h3 id="var/end_effect_type"><aside class="declaration">var </aside>end_effect_type <aside>– /<a href="obj.html">obj</a>/effect</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/RCD.dm#L20"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 20"></a></h3><p>The effect (if any) to create when the action completes.</p><h3 id="var/mode"><aside class="declaration">var </aside>mode <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/RCD.dm#L22"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 22"></a></h3><p>The mode the RCD must be in.</p><h3 id="var/start_effect_type"><aside class="declaration">var </aside>start_effect_type <aside>– /<a href="obj.html">obj</a>/effect</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/RCD.dm#L18"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 18"></a></h3><p>The effect (if any) to create when the action starts.</p><h3 id="var/start_message"><aside class="declaration">var </aside>start_message <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/RCD.dm#L16"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 16"></a></h3><p>The message (if any) to send the user when the action starts.</p><h2 id="proc">Proc Details</h2><h3 id="proc/act"><aside class="declaration">proc </aside>act<aside>(/<a href="atom.html">atom</a>/A, /<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/<a href="obj/item/rcd.html">rcd</a>/rcd, /<a href="mob.html">mob</a>/user) <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/RCD.dm#L58"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 58"></a></aside></h3><p>Perform the act. You should usually override this.</p><h3 id="proc/can_act"><aside class="declaration">proc </aside>can_act<aside>(/<a href="atom.html">atom</a>/A, /<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/<a href="obj/item/rcd.html">rcd</a>/rcd) <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/RCD.dm#L53"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 53"></a></aside></h3><p>Test to see if the act is possible. You should usually override this.</p><h3 id="proc/try_act"><aside class="declaration">proc </aside>try_act<aside>(/<a href="atom.html">atom</a>/A, /<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/<a href="obj/item/rcd.html">rcd</a>/rcd, /<a href="mob.html">mob</a>/user) <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/RCD.dm#L25"><img src="git.png" width="16" height="16" title="code/game/objects/items/RCD.dm 25"></a></aside></h3><p>Attempt the action. This should not need to be overridden.</p></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7">c8dfcda</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html> |