shikix/GS13NG
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
gh-pages
GS13NG/datum/component/storage.html
T
sheepishgoat 705fd9528e Deploying to gh-pages from @ e8e0068531 🚀
2025-02-05 06:19:18 +00:00

5 lines
14 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/component/storage - /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="datum/component/storage.html#var">Var Details</a> - <a href="datum/component/storage.html#proc">Proc Details</a></header><main><h1>storage <aside>/<a href="datum.html">datum</a>/<a href="datum/component.html">component</a>/<a href="datum/component/storage.html">storage</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/storage.dm#L13"><img src="git.png" width="16" height="16" title="code/datums/components/storage/storage.dm 13"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/component/storage.html#var/max_combined_w_class">max_combined_w_class</a></th><td>Max combined w_class. Applies to <a href="code/__DEFINES/storage/_storage.html#define/STORAGE_LIMIT_COMBINED_W_CLASS" title="STORAGE_LIMIT_COMBINED_W_CLASS">STORAGE_LIMIT_COMBINED_W_CLASS</a></td></tr><tr><th><a href="datum/component/storage.html#var/max_items">max_items</a></th><td>Max items we can hold. Applies to <a href="code/__DEFINES/storage/_storage.html#define/STORAGE_LIMIT_MAX_ITEMS" title="STORAGE_LIMIT_MAX_ITEMS">STORAGE_LIMIT_MAX_ITEMS</a></td></tr><tr><th><a href="datum/component/storage.html#var/max_volume">max_volume</a></th><td>Max volume we can hold. Applies to <a href="code/__DEFINES/storage/_storage.html#define/STORAGE_LIMIT_VOLUME" title="STORAGE_LIMIT_VOLUME">STORAGE_LIMIT_VOLUME</a>. Auto scaled on New() if unset.</td></tr><tr><th><a href="datum/component/storage.html#var/max_w_class">max_w_class</a></th><td>Max w_class we can hold. Applies to <a href="code/__DEFINES/storage/_storage.html#define/STORAGE_LIMIT_COMBINED_W_CLASS" title="STORAGE_LIMIT_COMBINED_W_CLASS">STORAGE_LIMIT_COMBINED_W_CLASS</a> and <a href="code/__DEFINES/storage/_storage.html#define/STORAGE_LIMIT_VOLUME" title="STORAGE_LIMIT_VOLUME">STORAGE_LIMIT_VOLUME</a></td></tr><tr><th><a href="datum/component/storage.html#var/storage_flags">storage_flags</a></th><td>Storage flags, including what kinds of limiters we use for how many items we can hold</td></tr><tr><th><a href="datum/component/storage.html#var/ui_by_mob">ui_by_mob</a></th><td>Ui objects by person. mob = list(objects)</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/component/storage.html#proc/_process_numerical_display">_process_numerical_display</a></th><td>Generates a list of numbered_display datums for the numerical display system.</td></tr><tr><th><a href="datum/component/storage.html#proc/check_on_found">check_on_found</a></th><td>Check if we should trigger on_found()
If this returns TRUE, it means an on_found() returned TRUE and immediately broke the chain.
In most contexts, this should mean to stop.</td></tr><tr><th><a href="datum/component/storage.html#proc/get_max_volume">get_max_volume</a></th><td>Gets our max volume</td></tr><tr><th><a href="datum/component/storage.html#proc/get_ui_boxes">get_ui_boxes</a></th><td>Gets our ui_boxes, making it if it doesn't exist.</td></tr><tr><th><a href="datum/component/storage.html#proc/get_ui_close">get_ui_close</a></th><td>Gets our ui_close, making it if it doesn't exist.</td></tr><tr><th><a href="datum/component/storage.html#proc/get_ui_continuous">get_ui_continuous</a></th><td>Gets our ui_continuous, making it if it doesn't exist.</td></tr><tr><th><a href="datum/component/storage.html#proc/get_ui_left">get_ui_left</a></th><td>Gets our ui_left, making it if it doesn't exist.</td></tr><tr><th><a href="datum/component/storage.html#proc/on_logout">on_logout</a></th><td>Proc triggered by signal to ensure logging out clients don't linger.</td></tr><tr><th><a href="datum/component/storage.html#proc/orient2hud_legacy">orient2hud_legacy</a></th><td>Orients all objects in legacy mode, and returns the objects to show to the user.</td></tr><tr><th><a href="datum/component/storage.html#proc/orient2hud_volumetric">orient2hud_volumetric</a></th><td>Orients all objects in .. volumetric mode. Does not support numerical display!</td></tr><tr><th><a href="datum/component/storage.html#proc/ui_hide">ui_hide</a></th><td>Hides our UI from a mob</td></tr><tr><th><a href="datum/component/storage.html#proc/ui_show">ui_show</a></th><td>Shows our UI to a mob.</td></tr><tr><th><a href="datum/component/storage.html#proc/volumetric_ui">volumetric_ui</a></th><td>Returns TRUE if we are using volumetric UI instead of box UI</td></tr><tr><th><a href="datum/component/storage.html#proc/vv_edit_var">vv_edit_var</a></th><td>VV hooked to ensure no lingering screen objects.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/max_combined_w_class"><aside class="declaration">var </aside>max_combined_w_class <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/storage.dm#L30"><img src="git.png" width="16" height="16" title="code/datums/components/storage/storage.dm 30"></a></h3><p>Max combined w_class. Applies to <a href="code/__DEFINES/storage/_storage.html#define/STORAGE_LIMIT_COMBINED_W_CLASS" title="STORAGE_LIMIT_COMBINED_W_CLASS">STORAGE_LIMIT_COMBINED_W_CLASS</a></p><h3 id="var/max_items"><aside class="declaration">var </aside>max_items <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/storage.dm#L32"><img src="git.png" width="16" height="16" title="code/datums/components/storage/storage.dm 32"></a></h3><p>Max items we can hold. Applies to <a href="code/__DEFINES/storage/_storage.html#define/STORAGE_LIMIT_MAX_ITEMS" title="STORAGE_LIMIT_MAX_ITEMS">STORAGE_LIMIT_MAX_ITEMS</a></p><h3 id="var/max_volume"><aside class="declaration">var </aside>max_volume <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/storage.dm#L34"><img src="git.png" width="16" height="16" title="code/datums/components/storage/storage.dm 34"></a></h3><p>Max volume we can hold. Applies to <a href="code/__DEFINES/storage/_storage.html#define/STORAGE_LIMIT_VOLUME" title="STORAGE_LIMIT_VOLUME">STORAGE_LIMIT_VOLUME</a>. Auto scaled on New() if unset.</p><h3 id="var/max_w_class"><aside class="declaration">var </aside>max_w_class <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/storage.dm#L28"><img src="git.png" width="16" height="16" title="code/datums/components/storage/storage.dm 28"></a></h3><p>Max w_class we can hold. Applies to <a href="code/__DEFINES/storage/_storage.html#define/STORAGE_LIMIT_COMBINED_W_CLASS" title="STORAGE_LIMIT_COMBINED_W_CLASS">STORAGE_LIMIT_COMBINED_W_CLASS</a> and <a href="code/__DEFINES/storage/_storage.html#define/STORAGE_LIMIT_VOLUME" title="STORAGE_LIMIT_VOLUME">STORAGE_LIMIT_VOLUME</a></p><h3 id="var/storage_flags"><aside class="declaration">var </aside>storage_flags <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/storage.dm#L26"><img src="git.png" width="16" height="16" title="code/datums/components/storage/storage.dm 26"></a></h3><p>Storage flags, including what kinds of limiters we use for how many items we can hold</p><h3 id="var/ui_by_mob"><aside class="declaration">var </aside>ui_by_mob <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/storage.dm#L51"><img src="git.png" width="16" height="16" title="code/datums/components/storage/storage.dm 51"></a></h3><p>Ui objects by person. mob = list(objects)</p><h2 id="proc">Proc Details</h2><h3 id="proc/_process_numerical_display"><aside class="declaration">proc </aside>_process_numerical_display<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/ui.dm#L4"><img src="git.png" width="16" height="16" title="code/datums/components/storage/ui.dm 4"></a></aside></h3><p>Generates a list of numbered_display datums for the numerical display system.</p><h3 id="proc/check_on_found"><aside class="declaration">proc </aside>check_on_found<aside>(/<a href="mob.html">mob</a>/user) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/storage.dm#L473"><img src="git.png" width="16" height="16" title="code/datums/components/storage/storage.dm 473"></a></aside></h3><p>Check if we should trigger on_found()
If this returns TRUE, it means an on_found() returned TRUE and immediately broke the chain.
In most contexts, this should mean to stop.</p><h3 id="proc/get_max_volume"><aside class="declaration">proc </aside>get_max_volume<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/storage.dm#L735"><img src="git.png" width="16" height="16" title="code/datums/components/storage/storage.dm 735"></a></aside></h3><p>Gets our max volume</p><h3 id="proc/get_ui_boxes"><aside class="declaration">proc </aside>get_ui_boxes<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/ui.dm#L261"><img src="git.png" width="16" height="16" title="code/datums/components/storage/ui.dm 261"></a></aside></h3><p>Gets our ui_boxes, making it if it doesn't exist.</p><h3 id="proc/get_ui_close"><aside class="declaration">proc </aside>get_ui_close<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/ui.dm#L273"><img src="git.png" width="16" height="16" title="code/datums/components/storage/ui.dm 273"></a></aside></h3><p>Gets our ui_close, making it if it doesn't exist.</p><h3 id="proc/get_ui_continuous"><aside class="declaration">proc </aside>get_ui_continuous<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/ui.dm#L279"><img src="git.png" width="16" height="16" title="code/datums/components/storage/ui.dm 279"></a></aside></h3><p>Gets our ui_continuous, making it if it doesn't exist.</p><h3 id="proc/get_ui_left"><aside class="declaration">proc </aside>get_ui_left<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/ui.dm#L267"><img src="git.png" width="16" height="16" title="code/datums/components/storage/ui.dm 267"></a></aside></h3><p>Gets our ui_left, making it if it doesn't exist.</p><h3 id="proc/on_logout"><aside class="declaration">proc </aside>on_logout<aside>(/<a href="datum.html">datum</a>/source, /<a href="client.html">client</a>/C) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/ui.dm#L233"><img src="git.png" width="16" height="16" title="code/datums/components/storage/ui.dm 233"></a></aside></h3><p>Proc triggered by signal to ensure logging out clients don't linger.</p><h3 id="proc/orient2hud_legacy"><aside class="declaration">proc </aside>orient2hud_legacy<aside>(/<a href="mob.html">mob</a>/user, maxcolumns) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/ui.dm#L19"><img src="git.png" width="16" height="16" title="code/datums/components/storage/ui.dm 19"></a></aside></h3><p>Orients all objects in legacy mode, and returns the objects to show to the user.</p><h3 id="proc/orient2hud_volumetric"><aside class="declaration">proc </aside>orient2hud_volumetric<aside>(/<a href="mob.html">mob</a>/user, maxcolumns) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/ui.dm#L84"><img src="git.png" width="16" height="16" title="code/datums/components/storage/ui.dm 84"></a></aside></h3><p>Orients all objects in .. volumetric mode. Does not support numerical display!</p><h3 id="proc/ui_hide"><aside class="declaration">proc </aside>ui_hide<aside>(/<a href="mob.html">mob</a>/M) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/ui.dm#L239"><img src="git.png" width="16" height="16" title="code/datums/components/storage/ui.dm 239"></a></aside></h3><p>Hides our UI from a mob</p><h3 id="proc/ui_show"><aside class="declaration">proc </aside>ui_show<aside>(/<a href="mob.html">mob</a>/M) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/ui.dm#L186"><img src="git.png" width="16" height="16" title="code/datums/components/storage/ui.dm 186"></a></aside></h3><p>Shows our UI to a mob.</p><h3 id="proc/volumetric_ui"><aside class="declaration">proc </aside>volumetric_ui<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/ui.dm#L254"><img src="git.png" width="16" height="16" title="code/datums/components/storage/ui.dm 254"></a></aside></h3><p>Returns TRUE if we are using volumetric UI instead of box UI</p><h3 id="proc/vv_edit_var">vv_edit_var<aside>(var_name, var_value) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/components/storage/ui.dm#L219"><img src="git.png" width="16" height="16" title="code/datums/components/storage/ui.dm 219"></a></aside></h3><p>VV hooked to ensure no lingering screen objects.</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>
Reference in New Issue View Git Blame Copy Permalink