13 lines
8.6 KiB
HTML
13 lines
8.6 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../../"><link rel="stylesheet" href="dmdoc.css"><title>/obj/item/airlock_painter/decal - /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="obj/item/airlock_painter/decal.html#var">Var Details</a> - <a href="obj/item/airlock_painter/decal.html#proc">Proc Details</a></header><main><h1>decal <aside>/<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/<a href="obj/item/airlock_painter.html">airlock_painter</a>/<a href="obj/item/airlock_painter/decal.html">decal</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/airlock_painter.dm#L157"><img src="git.png" width="16" height="16" title="code/game/objects/items/airlock_painter.dm 157"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/item/airlock_painter/decal.html#var/color_list">color_list</a></th><td>List of color options as list(user-friendly label, color value to return)</td></tr><tr><th><a href="obj/item/airlock_painter/decal.html#var/decal_list">decal_list</a></th><td>List of decal options as list(user-friendly label, icon state base value to return)</td></tr><tr><th><a href="obj/item/airlock_painter/decal.html#var/dir_list">dir_list</a></th><td>List of direction options as list(user-friendly label, dir value to return)</td></tr><tr><th><a href="obj/item/airlock_painter/decal.html#var/spritesheet_type">spritesheet_type</a></th><td>The type path of the spritesheet being used for the frontend.</td></tr><tr><th><a href="obj/item/airlock_painter/decal.html#var/stored_color">stored_color</a></th><td>The current color of the decal being printed.</td></tr><tr><th><a href="obj/item/airlock_painter/decal.html#var/stored_custom_color">stored_custom_color</a></th><td>Current custom color</td></tr><tr><th><a href="obj/item/airlock_painter/decal.html#var/stored_decal">stored_decal</a></th><td>The current base icon state of the decal being printed.</td></tr><tr><th><a href="obj/item/airlock_painter/decal.html#var/stored_decal_total">stored_decal_total</a></th><td>The full icon state of the decal being printed.</td></tr><tr><th><a href="obj/item/airlock_painter/decal.html#var/stored_dir">stored_dir</a></th><td>The current direction of the decal being printed</td></tr><tr><th><a href="obj/item/airlock_painter/decal.html#var/supports_custom_color">supports_custom_color</a></th><td>Does this printer implementation support custom colors?</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/item/airlock_painter/decal.html#proc/get_decal_path">get_decal_path</a></th><td>Return the final icon_state for the given decal options</td></tr><tr><th><a href="obj/item/airlock_painter/decal.html#proc/paint_floor">paint_floor</a></th><td>Actually add current decal to the floor.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/color_list"><aside class="declaration">var </aside>color_list <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/airlock_painter.dm#L181"><img src="git.png" width="16" height="16" title="code/game/objects/items/airlock_painter.dm 181"></a></h3><p>List of color options as list(user-friendly label, color value to return)</p><h3 id="var/decal_list"><aside class="declaration">var </aside>decal_list <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/airlock_painter.dm#L194"><img src="git.png" width="16" height="16" title="code/game/objects/items/airlock_painter.dm 194"></a></h3><p>List of decal options as list(user-friendly label, icon state base value to return)</p><h3 id="var/dir_list"><aside class="declaration">var </aside>dir_list <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/airlock_painter.dm#L187"><img src="git.png" width="16" height="16" title="code/game/objects/items/airlock_painter.dm 187"></a></h3><p>List of direction options as list(user-friendly label, dir value to return)</p><h3 id="var/spritesheet_type"><aside class="declaration">var </aside>spritesheet_type <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/airlock_painter.dm#L175"><img src="git.png" width="16" height="16" title="code/game/objects/items/airlock_painter.dm 175"></a></h3><p>The type path of the spritesheet being used for the frontend.</p><h3 id="var/stored_color"><aside class="declaration">var </aside>stored_color <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/airlock_painter.dm#L169"><img src="git.png" width="16" height="16" title="code/game/objects/items/airlock_painter.dm 169"></a></h3><p>The current color of the decal being printed.</p><h3 id="var/stored_custom_color"><aside class="declaration">var </aside>stored_custom_color <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/airlock_painter.dm#L179"><img src="git.png" width="16" height="16" title="code/game/objects/items/airlock_painter.dm 179"></a></h3><p>Current custom color</p><h3 id="var/stored_decal"><aside class="declaration">var </aside>stored_decal <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/airlock_painter.dm#L171"><img src="git.png" width="16" height="16" title="code/game/objects/items/airlock_painter.dm 171"></a></h3><p>The current base icon state of the decal being printed.</p><h3 id="var/stored_decal_total"><aside class="declaration">var </aside>stored_decal_total <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/airlock_painter.dm#L173"><img src="git.png" width="16" height="16" title="code/game/objects/items/airlock_painter.dm 173"></a></h3><p>The full icon state of the decal being printed.</p><h3 id="var/stored_dir"><aside class="declaration">var </aside>stored_dir <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/airlock_painter.dm#L167"><img src="git.png" width="16" height="16" title="code/game/objects/items/airlock_painter.dm 167"></a></h3><p>The current direction of the decal being printed</p><h3 id="var/supports_custom_color"><aside class="declaration">var </aside>supports_custom_color <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/airlock_painter.dm#L177"><img src="git.png" width="16" height="16" title="code/game/objects/items/airlock_painter.dm 177"></a></h3><p>Does this printer implementation support custom colors?</p><h2 id="proc">Proc Details</h2><h3 id="proc/get_decal_path"><aside class="declaration">proc </aside>get_decal_path<aside>(decal, color, dir) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/airlock_painter.dm#L246"><img src="git.png" width="16" height="16" title="code/game/objects/items/airlock_painter.dm 246"></a></aside></h3><p>Return the final icon_state for the given decal options</p>
|
||
<p>Arguments:</p>
|
||
<ul>
|
||
<li>decal - the selected decal base icon state</li>
|
||
<li>color - the selected color</li>
|
||
<li>dir - the selected dir</li>
|
||
</ul><h3 id="proc/paint_floor"><aside class="declaration">proc </aside>paint_floor<aside>(/<a href="turf.html">turf</a>/<a href="turf/open.html">open</a>/<a href="turf/open/floor.html">floor</a>/target) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/airlock_painter.dm#L235"><img src="git.png" width="16" height="16" title="code/game/objects/items/airlock_painter.dm 235"></a></aside></h3><p>Actually add current decal to the floor.</p>
|
||
<p>Responsible for actually adding the element to the turf for maximum flexibility.area
|
||
Can be overriden for different decal behaviors.
|
||
Arguments:</p>
|
||
<ul>
|
||
<li>target - The turf being painted to</li>
|
||
</ul></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> |