mirror of
https://github.com/ParadiseSS13/Paradise.git
synced 2026-08-27 05:57:24 +01:00
5 lines
7.5 KiB
HTML
5 lines
7.5 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/component/slippery - 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/component/slippery.html#var">Var Details</a> - <a href="datum/component/slippery.html#proc">Proc Details</a></header><main><h1>Slip Component <aside>/<a href="datum.html">datum</a>/<a href="datum/component.html">component</a>/<a href="datum/component/slippery.html">slippery</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/slippery.dm#L10"><img src="git.png" width="16" height="16" title="code/datums/components/slippery.dm 10"></a></h1><p>This is a component that can be applied to any movable atom (mob or obj).</p>
|
||
<p>While the atom has this component, any human mob that walks over it will have a chance to slip.
|
||
Duration, tiles moved, and so on, depend on what variables are passed in when the component is added.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/component/slippery.html#var/default_connections">default_connections</a></th><td>what we give to connect_loc by default, makes slippable mobs moving over us slip</td></tr><tr><th><a href="datum/component/slippery.html#var/description">description</a></th><td>Text that gets displayed in the slip proc, i.e. "user slips on [description]"</td></tr><tr><th><a href="datum/component/slippery.html#var/horizontal_required">horizontal_required</a></th><td>TRUE the player will only slip if the mob this datum is attached to is horizontal</td></tr><tr><th><a href="datum/component/slippery.html#var/knockdown">knockdown</a></th><td>The amount of knockdown to apply after slip.</td></tr><tr><th><a href="datum/component/slippery.html#var/slip_always">slip_always</a></th><td>FALSE if you want no slip shoes to make you immune to the slip</td></tr><tr><th><a href="datum/component/slippery.html#var/slip_chance">slip_chance</a></th><td>The chance that walking over the parent will slip you.</td></tr><tr><th><a href="datum/component/slippery.html#var/slip_tiles">slip_tiles</a></th><td>The amount of tiles someone will be moved after slip.</td></tr><tr><th><a href="datum/component/slippery.html#var/slip_verb">slip_verb</a></th><td>The verb that players will see when someone slips on the parent. In the form of "You [slip_verb]ped on".</td></tr><tr><th><a href="datum/component/slippery.html#var/walking_is_safe">walking_is_safe</a></th><td>TRUE If this slip can be avoided by walking.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/component/slippery.html#proc/slip">slip</a></th><td>Called whenever the parent receives the <code>ATOM_ENTERED</code> signal.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/default_connections"><aside class="declaration">var </aside>default_connections <aside>– /static/list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/slippery.dm#L28"><img src="git.png" width="16" height="16" title="code/datums/components/slippery.dm 28"></a></h3><p>what we give to connect_loc by default, makes slippable mobs moving over us slip</p><h3 id="var/description"><aside class="declaration">var </aside>description <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/slippery.dm#L12"><img src="git.png" width="16" height="16" title="code/datums/components/slippery.dm 12"></a></h3><p>Text that gets displayed in the slip proc, i.e. "user slips on [description]"</p><h3 id="var/horizontal_required"><aside class="declaration">var </aside>horizontal_required <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/slippery.dm#L26"><img src="git.png" width="16" height="16" title="code/datums/components/slippery.dm 26"></a></h3><p>TRUE the player will only slip if the mob this datum is attached to is horizontal</p><h3 id="var/knockdown"><aside class="declaration">var </aside>knockdown <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/slippery.dm#L14"><img src="git.png" width="16" height="16" title="code/datums/components/slippery.dm 14"></a></h3><p>The amount of knockdown to apply after slip.</p><h3 id="var/slip_always"><aside class="declaration">var </aside>slip_always <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/slippery.dm#L22"><img src="git.png" width="16" height="16" title="code/datums/components/slippery.dm 22"></a></h3><p>FALSE if you want no slip shoes to make you immune to the slip</p><h3 id="var/slip_chance"><aside class="declaration">var </aside>slip_chance <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/slippery.dm#L16"><img src="git.png" width="16" height="16" title="code/datums/components/slippery.dm 16"></a></h3><p>The chance that walking over the parent will slip you.</p><h3 id="var/slip_tiles"><aside class="declaration">var </aside>slip_tiles <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/slippery.dm#L18"><img src="git.png" width="16" height="16" title="code/datums/components/slippery.dm 18"></a></h3><p>The amount of tiles someone will be moved after slip.</p><h3 id="var/slip_verb"><aside class="declaration">var </aside>slip_verb <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/slippery.dm#L24"><img src="git.png" width="16" height="16" title="code/datums/components/slippery.dm 24"></a></h3><p>The verb that players will see when someone slips on the parent. In the form of "You [slip_verb]ped on".</p><h3 id="var/walking_is_safe"><aside class="declaration">var </aside>walking_is_safe <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/slippery.dm#L20"><img src="git.png" width="16" height="16" title="code/datums/components/slippery.dm 20"></a></h3><p>TRUE If this slip can be avoided by walking.</p><h2 id="proc">Proc Details</h2><h3 id="proc/slip"><aside class="declaration">proc </aside>slip<aside>(/<a href="datum.html">datum</a>/source, /<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/<a href="mob/living/carbon.html">carbon</a>/<a href="mob/living/carbon/human.html">human</a>/victim) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/slippery.dm#L57"><img src="git.png" width="16" height="16" title="code/datums/components/slippery.dm 57"></a></aside></h3><p>Called whenever the parent receives the <code>ATOM_ENTERED</code> signal.</p>
|
||
<p>Calls the <code>victim</code>'s <code>slip()</code> proc with the component's variables as arguments.
|
||
Additionally calls the parent's <code>after_slip()</code> proc on the <code>victim</code>.</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> |