Files
Paradise/datum/object_window_info.html

9 lines
7.8 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>/datum/object_window_info - 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="datum/object_window_info.html#var">Var Details</a> - <a href="datum/object_window_info.html#proc">Proc Details</a></header><main><h1>object_window_info <aside>/<a href="datum.html">datum</a>/<a href="datum/object_window_info.html">object_window_info</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSstatpanel.dm#L253"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSstatpanel.dm 253"></a></h1><p>Datum that holds and tracks info about a client's object window
Really only exists because I want to be able to do logic with signals
And need a safe place to do the registration</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/object_window_info.html#var/actively_tracking">actively_tracking</a></th><td>Are we currently tracking a turf?</td></tr><tr><th><a href="datum/object_window_info.html#var/atoms_to_images">atoms_to_images</a></th><td>list of atom -&gt; image string for objects we have had in the right click tab
this is our caching</td></tr><tr><th><a href="datum/object_window_info.html#var/atoms_to_imagify">atoms_to_imagify</a></th><td>list of atoms to turn into images for the object tab</td></tr><tr><th><a href="datum/object_window_info.html#var/atoms_to_show">atoms_to_show</a></th><td>list of atoms to show to our client via the object tab, at least currently</td></tr><tr><th><a href="datum/object_window_info.html#var/max_index">max_index</a></th><td>The maximum index currently sent to the client.</td></tr><tr><th><a href="datum/object_window_info.html#var/min_index">min_index</a></th><td>The minimum index currently sent to the client.</td></tr><tr><th><a href="datum/object_window_info.html#var/parent">parent</a></th><td>Our owner client</td></tr><tr><th><a href="datum/object_window_info.html#var/pending_turf_refresh">pending_turf_refresh</a></th><td>Debounce flag for immediate refreshes.</td></tr><tr><th><a href="datum/object_window_info.html#var/tracked_turf">tracked_turf</a></th><td>Turf we are currently listening to for content changes.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/object_window_info.html#proc/process">process</a></th><td>Takes a client, attempts to generate object images for it
We will update the client with any improvements we make when we're done</td></tr><tr><th><a href="datum/object_window_info.html#proc/viewing_atom_deleted">viewing_atom_deleted</a></th><td>Clears any cached object window stuff
We use hard refs cause we'd need a signal for this anyway. Cleaner this way</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/actively_tracking"><aside class="declaration">var </aside>actively_tracking <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSstatpanel.dm#L264"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSstatpanel.dm 264"></a></h3><p>Are we currently tracking a turf?</p><h3 id="var/atoms_to_images"><aside class="declaration">var </aside>atoms_to_images <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSstatpanel.dm#L258"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSstatpanel.dm 258"></a></h3><p>list of atom -&gt; image string for objects we have had in the right click tab
this is our caching</p><h3 id="var/atoms_to_imagify"><aside class="declaration">var </aside>atoms_to_imagify <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSstatpanel.dm#L260"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSstatpanel.dm 260"></a></h3><p>list of atoms to turn into images for the object tab</p><h3 id="var/atoms_to_show"><aside class="declaration">var </aside>atoms_to_show <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSstatpanel.dm#L255"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSstatpanel.dm 255"></a></h3><p>list of atoms to show to our client via the object tab, at least currently</p><h3 id="var/max_index"><aside class="declaration">var </aside>max_index <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSstatpanel.dm#L272"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSstatpanel.dm 272"></a></h3><p>The maximum index currently sent to the client.</p><h3 id="var/min_index"><aside class="declaration">var </aside>min_index <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSstatpanel.dm#L270"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSstatpanel.dm 270"></a></h3><p>The minimum index currently sent to the client.</p><h3 id="var/parent"><aside class="declaration">var </aside>parent <aside> /<a href="client.html">client</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSstatpanel.dm#L262"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSstatpanel.dm 262"></a></h3><p>Our owner client</p><h3 id="var/pending_turf_refresh"><aside class="declaration">var </aside>pending_turf_refresh <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSstatpanel.dm#L268"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSstatpanel.dm 268"></a></h3><p>Debounce flag for immediate refreshes.</p><h3 id="var/tracked_turf"><aside class="declaration">var </aside>tracked_turf <aside> /<a href="turf.html">turf</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSstatpanel.dm#L266"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSstatpanel.dm 266"></a></h3><p>Turf we are currently listening to for content changes.</p><h2 id="proc">Proc Details</h2><h3 id="proc/process">process<aside>(delta_time) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSstatpanel.dm#L292"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSstatpanel.dm 292"></a></aside></h3><p>Takes a client, attempts to generate object images for it
We will update the client with any improvements we make when we're done</p><h3 id="proc/viewing_atom_deleted"><aside class="declaration">proc </aside>viewing_atom_deleted<aside>(/<a href="atom.html">atom</a>/deleted) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSstatpanel.dm#L381"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSstatpanel.dm 381"></a></aside></h3><p>Clears any cached object window stuff
We use hard refs cause we'd need a signal for this anyway. Cleaner this way</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>