Files

11 lines
5.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>/atom/movable/screen - /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="atom/movable/screen.html#var">Var Details</a> - <a href="atom/movable/screen.html#proc">Proc Details</a></header><main><h1>screen <aside>/<a href="atom.html">atom</a>/<a href="atom/movable.html">movable</a>/<a href="atom/movable/screen.html">screen</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/screen_objects.dm#L9"><img src="git.png" width="16" height="16" title="code/_onclick/hud/screen_objects.dm 9"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="atom/movable/screen.html#var/assigned_map">assigned_map</a></th><td>Map name assigned to this object.
Automatically set by /client/proc/add_obj_to_map.</td></tr><tr><th><a href="atom/movable/screen.html#var/del_on_map_removal">del_on_map_removal</a></th><td>Mark this object as garbage-collectible after you clean the map
it was registered on.</td></tr><tr><th><a href="atom/movable/screen.html#var/hud">hud</a></th><td>A reference to the owner HUD, if any.</td></tr><tr><th><a href="atom/movable/screen.html#var/master">master</a></th><td>A reference to the object in the slot. Grabs or items, generally.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="atom/movable/screen.html#proc/fill_rect">fill_rect</a></th><td>Sets screen_loc to fill a rectangular area of the map.</td></tr><tr><th><a href="atom/movable/screen.html#proc/set_position">set_position</a></th><td>Sets screen_loc of this screen object, in form of point coordinates,
with optional pixel offset (px, py).</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/assigned_map"><aside class="declaration">var </aside>assigned_map <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/screen_objects.dm#L25"><img src="git.png" width="16" height="16" title="code/_onclick/hud/screen_objects.dm 25"></a></h3><p>Map name assigned to this object.
Automatically set by /client/proc/add_obj_to_map.</p><h3 id="var/del_on_map_removal"><aside class="declaration">var </aside>del_on_map_removal <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/screen_objects.dm#L33"><img src="git.png" width="16" height="16" title="code/_onclick/hud/screen_objects.dm 33"></a></h3><p>Mark this object as garbage-collectible after you clean the map
it was registered on.</p>
<p>This could probably be changed to be a proc, for conditional removal.
But for now, this works.</p><h3 id="var/hud"><aside class="declaration">var </aside>hud <aside> /<a href="datum.html">datum</a>/<a href="datum/hud.html">hud</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/screen_objects.dm#L20"><img src="git.png" width="16" height="16" title="code/_onclick/hud/screen_objects.dm 20"></a></h3><p>A reference to the owner HUD, if any.</p><h3 id="var/master"><aside class="declaration">var </aside>master <aside> /<a href="obj.html">obj</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/screen_objects.dm#L18"><img src="git.png" width="16" height="16" title="code/_onclick/hud/screen_objects.dm 18"></a></h3><p>A reference to the object in the slot. Grabs or items, generally.</p><h2 id="proc">Proc Details</h2><h3 id="proc/fill_rect"><aside class="declaration">proc </aside>fill_rect<aside>(x1, y1, x2, y2) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/map_popups.dm#L39"><img src="git.png" width="16" height="16" title="code/_onclick/hud/map_popups.dm 39"></a></aside></h3><p>Sets screen_loc to fill a rectangular area of the map.</p>
<p>If applicable, &quot;assigned_map&quot; has to be assigned before this proc call.</p><h3 id="proc/set_position"><aside class="declaration">proc </aside>set_position<aside>(x, y, px, py) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/map_popups.dm#L28"><img src="git.png" width="16" height="16" title="code/_onclick/hud/map_popups.dm 28"></a></aside></h3><p>Sets screen_loc of this screen object, in form of point coordinates,
with optional pixel offset (px, py).</p>
<p>If applicable, &quot;assigned_map&quot; has to be assigned before this proc call.</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>