sheepishgoat
18 lines
7.2 KiB
HTML
18 lines
7.2 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/hud - /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/hud.html#var">Var Details</a> - <a href="datum/hud.html#proc">Proc Details</a></header><main><h1>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/hud.dm#L23"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 23"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/hud.html#var/screentip_text">screentip_text</a></th><td>UI for screentips that appear when you mouse over things</td></tr><tr><th><a href="datum/hud.html#var/toggle_palette">toggle_palette</a></th><td>Whether or not screentips are enabled.
|
||
This is updated by the preference for cheaper reads than would be
|
||
had with a proc call, especially on one of the hottest procs in the
|
||
game (MouseEntered).
|
||
The color to use for the screentips.
|
||
This is updated by the preference for cheaper reads than would be
|
||
had with a proc call, especially on one of the hottest procs in the
|
||
game (MouseEntered).</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/hud.html#proc/build_action_groups">build_action_groups</a></th><td>Generates and fills new action groups with our mob's current actions</td></tr><tr><th><a href="datum/hud.html#proc/generate_landings">generate_landings</a></th><td>Generates visual landings for all groups that the button is not a memeber of</td></tr><tr><th><a href="datum/hud.html#proc/get_action_buttons_icons">get_action_buttons_icons</a></th><td>This is a silly proc used in hud code code to determine what icon and icon state we should be using
|
||
for hud elements (such as action buttons) that don't have their own icon and icon state set.</td></tr><tr><th><a href="datum/hud.html#proc/hide_action">hide_action</a></th><td>Removes the passed in action from its current position on the screen</td></tr><tr><th><a href="datum/hud.html#proc/hide_landings">hide_landings</a></th><td>Clears all currently visible landings</td></tr><tr><th><a href="datum/hud.html#proc/view_audit_buttons">view_audit_buttons</a></th><td>Ensures all of our buttons are properly within the bounds of our client's view, moves them if they're not</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/screentip_text"><aside class="declaration">var </aside>screentip_text <aside>– /<a href="atom.html">atom</a>/<a href="atom/movable.html">movable</a>/<a href="atom/movable/screen.html">screen</a>/screentip</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L63"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 63"></a></h3><p>UI for screentips that appear when you mouse over things</p><h3 id="var/toggle_palette"><aside class="declaration">var </aside>toggle_palette <aside>– /<a href="atom.html">atom</a>/<a href="atom/movable.html">movable</a>/<a href="atom/movable/screen.html">screen</a>/<a href="atom/movable/screen/button_palette.html">button_palette</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L79"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 79"></a></h3><p>Whether or not screentips are enabled.
|
||
This is updated by the preference for cheaper reads than would be
|
||
had with a proc call, especially on one of the hottest procs in the
|
||
game (MouseEntered).
|
||
The color to use for the screentips.
|
||
This is updated by the preference for cheaper reads than would be
|
||
had with a proc call, especially on one of the hottest procs in the
|
||
game (MouseEntered).</p><h2 id="proc">Proc Details</h2><h3 id="proc/build_action_groups"><aside class="declaration">proc </aside>build_action_groups<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L435"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 435"></a></aside></h3><p>Generates and fills new action groups with our mob's current actions</p><h3 id="proc/generate_landings"><aside class="declaration">proc </aside>generate_landings<aside>(/<a href="atom.html">atom</a>/<a href="atom/movable.html">movable</a>/<a href="atom/movable/screen.html">screen</a>/<a href="atom/movable/screen/movable.html">movable</a>/<a href="atom/movable/screen/movable/action_button.html">action_button</a>/button) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L405"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 405"></a></aside></h3><p>Generates visual landings for all groups that the button is not a memeber of</p><h3 id="proc/get_action_buttons_icons"><aside class="declaration">proc </aside>get_action_buttons_icons<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/action_button.dm#L159"><img src="git.png" width="16" height="16" title="code/_onclick/hud/action_button.dm 159"></a></aside></h3><p>This is a silly proc used in hud code code to determine what icon and icon state we should be using
|
||
for hud elements (such as action buttons) that don't have their own icon and icon state set.</p>
|
||
<p>It returns a list, which is pretty much just a struct of info</p><h3 id="proc/hide_action"><aside class="declaration">proc </aside>hide_action<aside>(/<a href="atom.html">atom</a>/<a href="atom/movable.html">movable</a>/<a href="atom/movable/screen.html">screen</a>/<a href="atom/movable/screen/movable.html">movable</a>/<a href="atom/movable/screen/movable/action_button.html">action_button</a>/button) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L392"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 392"></a></aside></h3><p>Removes the passed in action from its current position on the screen</p><h3 id="proc/hide_landings"><aside class="declaration">proc </aside>hide_landings<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L410"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 410"></a></aside></h3><p>Clears all currently visible landings</p><h3 id="proc/view_audit_buttons"><aside class="declaration">proc </aside>view_audit_buttons<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L423"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 423"></a></aside></h3><p>Ensures all of our buttons are properly within the bounds of our client's view, moves them if they're not</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> |