7 lines
8.1 KiB
HTML
7 lines
8.1 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/action_group - /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/action_group.html#var">Var Details</a> - <a href="datum/action_group.html#proc">Proc Details</a></header><main><h1>action_group <aside>/<a href="datum.html">datum</a>/<a href="datum/action_group.html">action_group</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L447"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 447"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/action_group.html#var/actions">actions</a></th><td>The actions we're managing</td></tr><tr><th><a href="datum/action_group.html#var/column_max">column_max</a></th><td>Max amount of buttons we can have per row
|
||
Indexes at 1</td></tr><tr><th><a href="datum/action_group.html#var/landing">landing</a></th><td>Our landing screen object</td></tr><tr><th><a href="datum/action_group.html#var/location">location</a></th><td>The screen location we go by</td></tr><tr><th><a href="datum/action_group.html#var/max_rows">max_rows</a></th><td>How many rows of actions we can have at max before we just stop hiding
|
||
Indexes at 1</td></tr><tr><th><a href="datum/action_group.html#var/north_offset">north_offset</a></th><td>The initial vertical offset of our action buttons</td></tr><tr><th><a href="datum/action_group.html#var/owner">owner</a></th><td>The hud we're owned by</td></tr><tr><th><a href="datum/action_group.html#var/pixel_north_offset">pixel_north_offset</a></th><td>The pixel vertical offset of our action buttons</td></tr><tr><th><a href="datum/action_group.html#var/row_offset">row_offset</a></th><td>How far "ahead" of the first row we start. Lets us "scroll" our rows
|
||
Indexes at 1</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/action_group.html#proc/ButtonNumberToScreenCoords">ButtonNumberToScreenCoords</a></th><td>Accepts a number represeting our position in the group, indexes at 0 to make the math nicer</td></tr><tr><th><a href="datum/action_group.html#proc/clear_landing">clear_landing</a></th><td>Clears any landing objects we may currently have</td></tr><tr><th><a href="datum/action_group.html#proc/generate_landing">generate_landing</a></th><td>Generates a landing object that can be dropped on to join this group</td></tr><tr><th><a href="datum/action_group.html#proc/size">size</a></th><td>Returns the amount of objects we're storing at the moment</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/actions"><aside class="declaration">var </aside>actions <aside>– /list/atom/movable/screen/movable/action_button</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L451"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 451"></a></h3><p>The actions we're managing</p><h3 id="var/column_max"><aside class="declaration">var </aside>column_max <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L458"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 458"></a></h3><p>Max amount of buttons we can have per row
|
||
Indexes at 1</p><h3 id="var/landing"><aside class="declaration">var </aside>landing <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/action_landing.html">action_landing</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L470"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 470"></a></h3><p>Our landing screen object</p><h3 id="var/location"><aside class="declaration">var </aside>location <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L466"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 466"></a></h3><p>The screen location we go by</p><h3 id="var/max_rows"><aside class="declaration">var </aside>max_rows <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L464"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 464"></a></h3><p>How many rows of actions we can have at max before we just stop hiding
|
||
Indexes at 1</p><h3 id="var/north_offset"><aside class="declaration">var </aside>north_offset <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L453"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 453"></a></h3><p>The initial vertical offset of our action buttons</p><h3 id="var/owner"><aside class="declaration">var </aside>owner <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#L449"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 449"></a></h3><p>The hud we're owned by</p><h3 id="var/pixel_north_offset"><aside class="declaration">var </aside>pixel_north_offset <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L455"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 455"></a></h3><p>The pixel vertical offset of our action buttons</p><h3 id="var/row_offset"><aside class="declaration">var </aside>row_offset <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L461"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 461"></a></h3><p>How far "ahead" of the first row we start. Lets us "scroll" our rows
|
||
Indexes at 1</p><h2 id="proc">Proc Details</h2><h3 id="proc/ButtonNumberToScreenCoords"><aside class="declaration">proc </aside>ButtonNumberToScreenCoords<aside>(number, landing) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L515"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 515"></a></aside></h3><p>Accepts a number represeting our position in the group, indexes at 0 to make the math nicer</p><h3 id="proc/clear_landing"><aside class="declaration">proc </aside>clear_landing<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L583"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 583"></a></aside></h3><p>Clears any landing objects we may currently have</p><h3 id="proc/generate_landing"><aside class="declaration">proc </aside>generate_landing<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L575"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 575"></a></aside></h3><p>Generates a landing object that can be dropped on to join this group</p><h3 id="proc/size"><aside class="declaration">proc </aside>size<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/_onclick/hud/hud.dm#L565"><img src="git.png" width="16" height="16" title="code/_onclick/hud/hud.dm 565"></a></aside></h3><p>Returns the amount of objects we're storing at the moment</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> |