Files

1 line
6.0 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/temp_visual/single_user - 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/temp_visual/single_user.html#var">Var Details</a> - <a href="obj/effect/temp_visual/single_user.html#proc">Proc Details</a></header><main><h1>single_user <aside>/<a href="obj.html">obj</a>/<a href="obj/effect/temp_visual/single_user.html">effect/temp_visual/single_user</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/effects/temporary_visuals/misc_visuals.dm#L412"><img src="git.png" width="16" height="16" title="code/game/objects/effects/temporary_visuals/misc_visuals.dm 412"></a></h1><p>A visual effect that will be shown only to a particular user for a period of time.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/effect/temp_visual/single_user.html#var/displayed_image">displayed_image</a></th><td>The image to show to the user</td></tr><tr><th><a href="obj/effect/temp_visual/single_user.html#var/image_icon">image_icon</a></th><td>The icon to pull the image from</td></tr><tr><th><a href="obj/effect/temp_visual/single_user.html#var/image_icon_state">image_icon_state</a></th><td>The real icon state to be applied to the image</td></tr><tr><th><a href="obj/effect/temp_visual/single_user.html#var/image_layer">image_layer</a></th><td>The layer to apply the image to</td></tr><tr><th><a href="obj/effect/temp_visual/single_user.html#var/image_plane">image_plane</a></th><td>The plane to apply the image to</td></tr><tr><th><a href="obj/effect/temp_visual/single_user.html#var/source_UID">source_UID</a></th><td>The UID of the person who the image is being displayed to</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/effect/temp_visual/single_user.html#proc/add_mind">add_mind</a></th><td>Add the image to the user's screen</td></tr><tr><th><a href="obj/effect/temp_visual/single_user.html#proc/remove_mind">remove_mind</a></th><td>Remove the image from the user's screen</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/displayed_image"><aside class="declaration">var </aside>displayed_image <aside> /image</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/effects/temporary_visuals/misc_visuals.dm#L414"><img src="git.png" width="16" height="16" title="code/game/objects/effects/temporary_visuals/misc_visuals.dm 414"></a></h3><p>The image to show to the user</p><h3 id="var/image_icon"><aside class="declaration">var </aside>image_icon <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/effects/temporary_visuals/misc_visuals.dm#L424"><img src="git.png" width="16" height="16" title="code/game/objects/effects/temporary_visuals/misc_visuals.dm 424"></a></h3><p>The icon to pull the image from</p><h3 id="var/image_icon_state"><aside class="declaration">var </aside>image_icon_state <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/effects/temporary_visuals/misc_visuals.dm#L418"><img src="git.png" width="16" height="16" title="code/game/objects/effects/temporary_visuals/misc_visuals.dm 418"></a></h3><p>The real icon state to be applied to the image</p><h3 id="var/image_layer"><aside class="declaration">var </aside>image_layer <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/effects/temporary_visuals/misc_visuals.dm#L422"><img src="git.png" width="16" height="16" title="code/game/objects/effects/temporary_visuals/misc_visuals.dm 422"></a></h3><p>The layer to apply the image to</p><h3 id="var/image_plane"><aside class="declaration">var </aside>image_plane <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/effects/temporary_visuals/misc_visuals.dm#L420"><img src="git.png" width="16" height="16" title="code/game/objects/effects/temporary_visuals/misc_visuals.dm 420"></a></h3><p>The plane to apply the image to</p><h3 id="var/source_UID"><aside class="declaration">var </aside>source_UID <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/effects/temporary_visuals/misc_visuals.dm#L416"><img src="git.png" width="16" height="16" title="code/game/objects/effects/temporary_visuals/misc_visuals.dm 416"></a></h3><p>The UID of the person who the image is being displayed to</p><h2 id="proc">Proc Details</h2><h3 id="proc/add_mind"><aside class="declaration">proc </aside>add_mind<aside>(/<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/looker) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/effects/temporary_visuals/misc_visuals.dm#L451"><img src="git.png" width="16" height="16" title="code/game/objects/effects/temporary_visuals/misc_visuals.dm 451"></a></aside></h3><p>Add the image to the user's screen</p><h3 id="proc/remove_mind"><aside class="declaration">proc </aside>remove_mind<aside>(/<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/looker) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/effects/temporary_visuals/misc_visuals.dm#L455"><img src="git.png" width="16" height="16" title="code/game/objects/effects/temporary_visuals/misc_visuals.dm 455"></a></aside></h3><p>Remove the image from the user's screen</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>