Files

11 lines
3.9 KiB
HTML

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../"><link rel="stylesheet" href="dmdoc.css"><title>/atom/movable/screen - 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="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/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/_onclick/hud/screen_objects.dm#L10"><img src="git.png" width="16" height="16" title="code/_onclick/hud/screen_objects.dm 10"></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><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 <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/_onclick/hud/screen_objects.dm#L23"><img src="git.png" width="16" height="16" title="code/_onclick/hud/screen_objects.dm 23"></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 <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/_onclick/hud/screen_objects.dm#L31"><img src="git.png" width="16" height="16" title="code/_onclick/hud/screen_objects.dm 31"></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><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/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/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/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/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>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/edee60476d21ee840643bd1abe7f6003a8c65773">edee604</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html>