cyberpresidentvanellope/Paradise
1
0
Fork 0
mirror of https://github.com/ParadiseSS13/Paradise.git synced 2026-08-26 13:37:58 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
Paradise/obj/effect/hallucination.html
T

23 lines
10 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/effect/hallucination - 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/effect/hallucination.html#var">Var Details</a> - <a href="obj/effect/hallucination.html#proc">Proc Details</a></header><main><h1>Hallucination <aside>/<a href="obj.html">obj</a>/<a href="obj/effect/hallucination.html">effect/hallucination</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/hallucinations/hallucinations.dm#L45"><img src="git.png" width="16" height="16" title="code/modules/hallucinations/hallucinations.dm 45"></a></h1><p>Base object for hallucinations. Contains basic behaviour to display an icon only to the target.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/effect/hallucination.html#var/duration">duration</a></th><td>Duration in deciseconds. Can also be a list with the form [lower bound, upper bound] for a random duration.</td></tr><tr><th><a href="obj/effect/hallucination.html#var/hallucination_color">hallucination_color</a></th><td>Hallucination color</td></tr><tr><th><a href="obj/effect/hallucination.html#var/hallucination_icon">hallucination_icon</a></th><td>Hallucination icon.</td></tr><tr><th><a href="obj/effect/hallucination.html#var/hallucination_icon_state">hallucination_icon_state</a></th><td>Hallucination icon state.</td></tr><tr><th><a href="obj/effect/hallucination.html#var/hallucination_layer">hallucination_layer</a></th><td>Hallucination layer.</td></tr><tr><th><a href="obj/effect/hallucination.html#var/hallucination_override">hallucination_override</a></th><td>Hallucination override.</td></tr><tr><th><a href="obj/effect/hallucination.html#var/hallucination_plane">hallucination_plane</a></th><td>Hallucination plane.</td></tr><tr><th><a href="obj/effect/hallucination.html#var/images">images</a></th><td>Lazy list of images created as part of the hallucination. Cleared on destruction.</td></tr><tr><th><a href="obj/effect/hallucination.html#var/should_delete">should_delete</a></th><td>Should this hallucination delete itself</td></tr><tr><th><a href="obj/effect/hallucination.html#var/target">target</a></th><td>The mob that sees this hallucination.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/effect/hallucination.html#proc/add_icon">add_icon</a></th><td>Adds an image to the hallucination. Cleared on destruction.</td></tr><tr><th><a href="obj/effect/hallucination.html#proc/clear_icon">clear_icon</a></th><td>Clears an image from the hallucination.</td></tr><tr><th><a href="obj/effect/hallucination.html#proc/clear_icon_in">clear_icon_in</a></th><td>Clears an image from the hallucination after a delay.</td></tr><tr><th><a href="obj/effect/hallucination.html#proc/clear_icons">clear_icons</a></th><td>Clears all images from the hallucination.</td></tr><tr><th><a href="obj/effect/hallucination.html#proc/play_sound_in">play_sound_in</a></th><td>Plays a sound to the target only.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/duration"><aside class="declaration">var </aside>duration <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/hallucinations/hallucinations.dm#L48"><img src="git.png" width="16" height="16" title="code/modules/hallucinations/hallucinations.dm 48"></a></h3><p>Duration in deciseconds. Can also be a list with the form [lower bound, upper bound] for a random duration.</p><h3 id="var/hallucination_color"><aside class="declaration">var </aside>hallucination_color <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/hallucinations/hallucinations.dm#L56"><img src="git.png" width="16" height="16" title="code/modules/hallucinations/hallucinations.dm 56"></a></h3><p>Hallucination color</p><h3 id="var/hallucination_icon"><aside class="declaration">var </aside>hallucination_icon <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/hallucinations/hallucinations.dm#L50"><img src="git.png" width="16" height="16" title="code/modules/hallucinations/hallucinations.dm 50"></a></h3><p>Hallucination icon.</p><h3 id="var/hallucination_icon_state"><aside class="declaration">var </aside>hallucination_icon_state <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/hallucinations/hallucinations.dm#L52"><img src="git.png" width="16" height="16" title="code/modules/hallucinations/hallucinations.dm 52"></a></h3><p>Hallucination icon state.</p><h3 id="var/hallucination_layer"><aside class="declaration">var </aside>hallucination_layer <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/hallucinations/hallucinations.dm#L58"><img src="git.png" width="16" height="16" title="code/modules/hallucinations/hallucinations.dm 58"></a></h3><p>Hallucination layer.</p><h3 id="var/hallucination_override"><aside class="declaration">var </aside>hallucination_override <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/hallucinations/hallucinations.dm#L54"><img src="git.png" width="16" height="16" title="code/modules/hallucinations/hallucinations.dm 54"></a></h3><p>Hallucination override.</p><h3 id="var/hallucination_plane"><aside class="declaration">var </aside>hallucination_plane <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/hallucinations/hallucinations.dm#L60"><img src="git.png" width="16" height="16" title="code/modules/hallucinations/hallucinations.dm 60"></a></h3><p>Hallucination plane.</p><h3 id="var/images"><aside class="declaration">var </aside>images <aside>– /list/image</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/hallucinations/hallucinations.dm#L64"><img src="git.png" width="16" height="16" title="code/modules/hallucinations/hallucinations.dm 64"></a></h3><p>Lazy list of images created as part of the hallucination. Cleared on destruction.</p><h3 id="var/should_delete"><aside class="declaration">var </aside>should_delete <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/hallucinations/hallucinations.dm#L66"><img src="git.png" width="16" height="16" title="code/modules/hallucinations/hallucinations.dm 66"></a></h3><p>Should this hallucination delete itself</p><h3 id="var/target"><aside class="declaration">var </aside>target <aside>– /<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/<a href="mob/living/carbon.html">carbon</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/hallucinations/hallucinations.dm#L62"><img src="git.png" width="16" height="16" title="code/modules/hallucinations/hallucinations.dm 62"></a></h3><p>The mob that sees this hallucination.</p><h2 id="proc">Proc Details</h2><h3 id="proc/add_icon"><aside class="declaration">proc </aside>add_icon<aside>(/image/I) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/hallucinations/hallucinations.dm#L114"><img src="git.png" width="16" height="16" title="code/modules/hallucinations/hallucinations.dm 114"></a></aside></h3><p>Adds an image to the hallucination. Cleared on destruction.</p>
<p>Arguments:</p>
<ul>
<li>I - The image to add.</li>
</ul><h3 id="proc/clear_icon"><aside class="declaration">proc </aside>clear_icon<aside>(/image/I) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/hallucinations/hallucinations.dm#L124"><img src="git.png" width="16" height="16" title="code/modules/hallucinations/hallucinations.dm 124"></a></aside></h3><p>Clears an image from the hallucination.</p>
<p>Arguments:</p>
<ul>
<li>I - The image to clear.</li>
</ul><h3 id="proc/clear_icon_in"><aside class="declaration">proc </aside>clear_icon_in<aside>(/image/I, delay) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/hallucinations/hallucinations.dm#L136"><img src="git.png" width="16" height="16" title="code/modules/hallucinations/hallucinations.dm 136"></a></aside></h3><p>Clears an image from the hallucination after a delay.</p>
<p>Arguments:</p>
<ul>
<li>I - The image to clear.</li>
<li>delay - Delay in deciseconds.</li>
</ul><h3 id="proc/clear_icons"><aside class="declaration">proc </aside>clear_icons<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/hallucinations/hallucinations.dm#L142"><img src="git.png" width="16" height="16" title="code/modules/hallucinations/hallucinations.dm 142"></a></aside></h3><p>Clears all images from the hallucination.</p><h3 id="proc/play_sound_in"><aside class="declaration">proc </aside>play_sound_in<aside>(time, /<a href="turf.html">turf</a>/source, snd, volume, vary, frequency) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/hallucinations/hallucinations.dm#L159"><img src="git.png" width="16" height="16" title="code/modules/hallucinations/hallucinations.dm 159"></a></aside></h3><p>Plays a sound to the target only.</p>
<p>Arguments:</p>
<ul>
<li>time - Deciseconds before the sound plays.</li>
<li>source - The turf to play the sound from. Optional.</li>
<li>snd - The sound file to play.</li>
<li>volume - The sound volume.</li>
<li>vary - Whether to randomize the sound's pitch.</li>
<li>frequency - The sound's pitch.</li>
</ul></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>
Reference in New Issue View Git Blame Copy Permalink