Files
GS13NG/obj/machinery/status_display.html
2025-02-05 06:19:18 +00:00

15 lines
4.5 KiB
HTML

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../"><link rel="stylesheet" href="dmdoc.css"><title>/obj/machinery/status_display - /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="obj/machinery/status_display.html#proc">Proc Details</a></header><main><h1>status_display <aside>/<a href="obj.html">obj</a>/<a href="obj/machinery.html">machinery</a>/<a href="obj/machinery/status_display.html">status_display</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/machinery/status_display.dm#L18"><img src="git.png" width="16" height="16" title="code/game/machinery/status_display.dm 18"></a></h1><p>Status display which can show images and scrolling text.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/machinery/status_display.html#proc/remove_messages">remove_messages</a></th><td>Remove both message objs and null the fields.
Don't call this in subclasses.</td></tr><tr><th><a href="obj/machinery/status_display.html#proc/set_messages">set_messages</a></th><td>Immediately change the display to the given two lines.</td></tr><tr><th><a href="obj/machinery/status_display.html#proc/set_picture">set_picture</a></th><td>Immediately change the display to the given picture.</td></tr><tr><th><a href="obj/machinery/status_display.html#proc/update">update</a></th><td>Update the display and, if necessary, re-enable processing.</td></tr><tr><th><a href="obj/machinery/status_display.html#proc/update_message">update_message</a></th><td>Create/update message overlay.
They must be handled as real objects for the animation to run.
Don't call this in subclasses.
Arguments:</td></tr></table><h2 id="proc">Proc Details</h2><h3 id="proc/remove_messages"><aside class="declaration">proc </aside>remove_messages<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/machinery/status_display.dm#L107"><img src="git.png" width="16" height="16" title="code/game/machinery/status_display.dm 107"></a></aside></h3><p>Remove both message objs and null the fields.
Don't call this in subclasses.</p><h3 id="proc/set_messages"><aside class="declaration">proc </aside>set_messages<aside>(line1, line2) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/machinery/status_display.dm#L91"><img src="git.png" width="16" height="16" title="code/game/machinery/status_display.dm 91"></a></aside></h3><p>Immediately change the display to the given two lines.</p><h3 id="proc/set_picture"><aside class="declaration">proc </aside>set_picture<aside>(state) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/machinery/status_display.dm#L84"><img src="git.png" width="16" height="16" title="code/game/machinery/status_display.dm 84"></a></aside></h3><p>Immediately change the display to the given picture.</p><h3 id="proc/update"><aside class="declaration">proc </aside>update<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/machinery/status_display.dm#L191"><img src="git.png" width="16" height="16" title="code/game/machinery/status_display.dm 191"></a></aside></h3><p>Update the display and, if necessary, re-enable processing.</p><h3 id="proc/update_message"><aside class="declaration">proc </aside>update_message<aside>(/<a href="obj.html">obj</a>/effect/overlay/status_display_text/overlay, line_y, message) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/machinery/status_display.dm#L123"><img src="git.png" width="16" height="16" title="code/game/machinery/status_display.dm 123"></a></aside></h3><p>Create/update message overlay.
They must be handled as real objects for the animation to run.
Don't call this in subclasses.
Arguments:</p>
<ul>
<li>overlay - the current /obj/effect/overlay/status_display_text instance</li>
<li>line_y - The Y offset to render the text.</li>
<li>message - the new message text.
Returns new /obj/effect/overlay/status_display_text or null if unchanged.</li>
</ul></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>