mirror of
https://github.com/evilew/GS13-Citadel.git
synced 2026-08-25 06:07:36 +01:00
1 line
7.5 KiB
HTML
1 line
7.5 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../"><link rel="stylesheet" href="dmdoc.css"><title>/atom/movable/plane_master_controller - /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="atom/movable/plane_master_controller.html#var">Var Details</a> - <a href="atom/movable/plane_master_controller.html#proc">Proc Details</a></header><main><h1>plane_master_controller <aside>/<a href="atom.html">atom</a>/<a href="atom/movable.html">movable</a>/<a href="atom/movable/plane_master_controller.html">plane_master_controller</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/26e2b96b19428762e9aa55b5eca88d72c6c6b7ed/code/_onclick/hud/plane_master_controller.dm#L2"><img src="git.png" width="16" height="16" title="code/_onclick/hud/plane_master_controller.dm 2"></a></h1><p>Atom that manages and controls multiple planes. It's an atom so we can hook into add_filter etc. Multiple controllers can control one plane.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="atom/movable/plane_master_controller.html#var/controlled_planes">controlled_planes</a></th><td>List of planes in this controllers control. Initially this is a normal list, but becomes an assoc list of plane numbers as strings | plane instance</td></tr><tr><th><a href="atom/movable/plane_master_controller.html#var/owner_hud">owner_hud</a></th><td>hud that owns this controller</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="atom/movable/plane_master_controller.html#proc/Initialize">Initialize</a></th><td>Ensures that all the planes are correctly in the controlled_planes list.</td></tr><tr><th><a href="atom/movable/plane_master_controller.html#proc/add_atom_colour">add_atom_colour</a></th><td>Full override so we can just use filterrific</td></tr><tr><th><a href="atom/movable/plane_master_controller.html#proc/add_filter">add_filter</a></th><td>Full override so we can just use filterrific</td></tr><tr><th><a href="atom/movable/plane_master_controller.html#proc/get_filters">get_filters</a></th><td>Gets all filters for this controllers plane masters</td></tr><tr><th><a href="atom/movable/plane_master_controller.html#proc/remove_atom_colour">remove_atom_colour</a></th><td>Removes an instance of colour_type from the atom's atom_colours list</td></tr><tr><th><a href="atom/movable/plane_master_controller.html#proc/remove_filter">remove_filter</a></th><td>Full override so we can just use filterrific</td></tr><tr><th><a href="atom/movable/plane_master_controller.html#proc/transition_filter">transition_filter</a></th><td>Transitions all filters owned by this plane master controller</td></tr><tr><th><a href="atom/movable/plane_master_controller.html#proc/update_atom_colour">update_atom_colour</a></th><td>Resets the atom's color to null, and then sets it to the highest priority colour available</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/controlled_planes"><aside class="declaration">var </aside>controlled_planes <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/26e2b96b19428762e9aa55b5eca88d72c6c6b7ed/code/_onclick/hud/plane_master_controller.dm#L4"><img src="git.png" width="16" height="16" title="code/_onclick/hud/plane_master_controller.dm 4"></a></h3><p>List of planes in this controllers control. Initially this is a normal list, but becomes an assoc list of plane numbers as strings | plane instance</p><h3 id="var/owner_hud"><aside class="declaration">var </aside>owner_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/26e2b96b19428762e9aa55b5eca88d72c6c6b7ed/code/_onclick/hud/plane_master_controller.dm#L9"><img src="git.png" width="16" height="16" title="code/_onclick/hud/plane_master_controller.dm 9"></a></h3><p>hud that owns this controller</p><h2 id="proc">Proc Details</h2><h3 id="proc/Initialize"><aside class="parent"><a title="/atom" href="atom.html#proc/Initialize">↑</a></aside>Initialize<aside>(mapload, /<a href="datum.html">datum</a>/<a href="datum/hud.html">hud</a>/hud) <a href="https://github.com/evilew/GS13-Citadel/blob/26e2b96b19428762e9aa55b5eca88d72c6c6b7ed/code/_onclick/hud/plane_master_controller.dm#L12"><img src="git.png" width="16" height="16" title="code/_onclick/hud/plane_master_controller.dm 12"></a></aside></h3><p>Ensures that all the planes are correctly in the controlled_planes list.</p><h3 id="proc/add_atom_colour">add_atom_colour<aside>(coloration, colour_priority) <a href="https://github.com/evilew/GS13-Citadel/blob/26e2b96b19428762e9aa55b5eca88d72c6c6b7ed/code/_onclick/hud/plane_master_controller.dm#L66"><img src="git.png" width="16" height="16" title="code/_onclick/hud/plane_master_controller.dm 66"></a></aside></h3><p>Full override so we can just use filterrific</p><h3 id="proc/add_filter">add_filter<aside>(name, priority, /list/params) <a href="https://github.com/evilew/GS13-Citadel/blob/26e2b96b19428762e9aa55b5eca88d72c6c6b7ed/code/_onclick/hud/plane_master_controller.dm#L32"><img src="git.png" width="16" height="16" title="code/_onclick/hud/plane_master_controller.dm 32"></a></aside></h3><p>Full override so we can just use filterrific</p><h3 id="proc/get_filters"><aside class="declaration">proc </aside>get_filters<aside>(name) <a href="https://github.com/evilew/GS13-Citadel/blob/26e2b96b19428762e9aa55b5eca88d72c6c6b7ed/code/_onclick/hud/plane_master_controller.dm#L52"><img src="git.png" width="16" height="16" title="code/_onclick/hud/plane_master_controller.dm 52"></a></aside></h3><p>Gets all filters for this controllers plane masters</p><h3 id="proc/remove_atom_colour">remove_atom_colour<aside>(colour_priority, coloration) <a href="https://github.com/evilew/GS13-Citadel/blob/26e2b96b19428762e9aa55b5eca88d72c6c6b7ed/code/_onclick/hud/plane_master_controller.dm#L74"><img src="git.png" width="16" height="16" title="code/_onclick/hud/plane_master_controller.dm 74"></a></aside></h3><p>Removes an instance of colour_type from the atom's atom_colours list</p><h3 id="proc/remove_filter">remove_filter<aside>(name_or_names) <a href="https://github.com/evilew/GS13-Citadel/blob/26e2b96b19428762e9aa55b5eca88d72c6c6b7ed/code/_onclick/hud/plane_master_controller.dm#L39"><img src="git.png" width="16" height="16" title="code/_onclick/hud/plane_master_controller.dm 39"></a></aside></h3><p>Full override so we can just use filterrific</p><h3 id="proc/transition_filter">transition_filter<aside>(name, time, /list/new_params, easing, loop) <a href="https://github.com/evilew/GS13-Citadel/blob/26e2b96b19428762e9aa55b5eca88d72c6c6b7ed/code/_onclick/hud/plane_master_controller.dm#L59"><img src="git.png" width="16" height="16" title="code/_onclick/hud/plane_master_controller.dm 59"></a></aside></h3><p>Transitions all filters owned by this plane master controller</p><h3 id="proc/update_atom_colour">update_atom_colour<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/26e2b96b19428762e9aa55b5eca88d72c6c6b7ed/code/_onclick/hud/plane_master_controller.dm#L82"><img src="git.png" width="16" height="16" title="code/_onclick/hud/plane_master_controller.dm 82"></a></aside></h3><p>Resets the atom's color to null, and then sets it to the highest priority colour available</p></main><footer>tgstation.dme <a href="https://github.com/evilew/GS13-Citadel/tree/26e2b96b19428762e9aa55b5eca88d72c6c6b7ed">26e2b96</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.9.0</a></footer></body></html> |