sheepishgoat
1 line
5.1 KiB
HTML
1 line
5.1 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/component/footstep - /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="datum/component/footstep.html#var">Var Details</a> - <a href="datum/component/footstep.html#proc">Proc Details</a></header><main><h1>footstep <aside>/<a href="datum.html">datum</a>/<a href="datum/component.html">component</a>/<a href="datum/component/footstep.html">footstep</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/footstep.dm#L2"><img src="git.png" width="16" height="16" title="code/datums/components/footstep.dm 2"></a></h1><p>Footstep component. Plays footsteps at parents location when it is appropriate.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/component/footstep.html#var/e_range">e_range</a></th><td>e_range stands for extra range - aka how far the sound can be heard. This is added to the base value and ignored if there isn't a base value.</td></tr><tr><th><a href="datum/component/footstep.html#var/footstep_sounds">footstep_sounds</a></th><td>This can be a list OR a soundfile OR null. Determines whatever sound gets played.</td></tr><tr><th><a href="datum/component/footstep.html#var/footstep_type">footstep_type</a></th><td>footstep_type is a define which determines what kind of sounds should get chosen.</td></tr><tr><th><a href="datum/component/footstep.html#var/steps">steps</a></th><td>How many steps the parent has taken since the last time a footstep was played</td></tr><tr><th><a href="datum/component/footstep.html#var/volume">volume</a></th><td>volume determines the extra volume of the footstep. This is multiplied by the base volume, should there be one.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/component/footstep.html#proc/prepare_step">prepare_step</a></th><td>Prepares a footstep. Determines if it should get played. Returns the turf it should get played on. Note that it is always a /turf/open</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/e_range"><aside class="declaration">var </aside>e_range <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/footstep.dm#L8"><img src="git.png" width="16" height="16" title="code/datums/components/footstep.dm 8"></a></h3><p>e_range stands for extra range - aka how far the sound can be heard. This is added to the base value and ignored if there isn't a base value.</p><h3 id="var/footstep_sounds"><aside class="declaration">var </aside>footstep_sounds <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/footstep.dm#L14"><img src="git.png" width="16" height="16" title="code/datums/components/footstep.dm 14"></a></h3><p>This can be a list OR a soundfile OR null. Determines whatever sound gets played.</p><h3 id="var/footstep_type"><aside class="declaration">var </aside>footstep_type <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/footstep.dm#L10"><img src="git.png" width="16" height="16" title="code/datums/components/footstep.dm 10"></a></h3><p>footstep_type is a define which determines what kind of sounds should get chosen.</p><h3 id="var/steps"><aside class="declaration">var </aside>steps <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/footstep.dm#L4"><img src="git.png" width="16" height="16" title="code/datums/components/footstep.dm 4"></a></h3><p>How many steps the parent has taken since the last time a footstep was played</p><h3 id="var/volume"><aside class="declaration">var </aside>volume <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/footstep.dm#L6"><img src="git.png" width="16" height="16" title="code/datums/components/footstep.dm 6"></a></h3><p>volume determines the extra volume of the footstep. This is multiplied by the base volume, should there be one.</p><h2 id="proc">Proc Details</h2><h3 id="proc/prepare_step"><aside class="declaration">proc </aside>prepare_step<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/footstep.dm#L41"><img src="git.png" width="16" height="16" title="code/datums/components/footstep.dm 41"></a></aside></h3><p>Prepares a footstep. Determines if it should get played. Returns the turf it should get played on. Note that it is always a /turf/open</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> |