mirror of
https://github.com/ParadiseSS13/Paradise.git
synced 2026-08-26 21:48:21 +01:00
4 lines
6.0 KiB
HTML
4 lines
6.0 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/painter - Space Station 13</title></head><body><header><a href="index.html">Space Station 13</a> - <a href="index.html#modules">Modules</a> - <a href="index.html#types">Types</a> — <a href="datum/painter.html#var">Var Details</a> - <a href="datum/painter.html#proc">Proc Details</a></header><main><h1>Painter Datum <aside>/<a href="datum.html">datum</a>/<a href="datum/painter.html">painter</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/items/devices/painter/painter.dm#L154"><img src="git.png" width="16" height="16" title="code/game/objects/items/devices/painter/painter.dm 154"></a></h1><p>Contains variables for updating <code>holder</code>, as well as procs for choosing a colour and painting an atom.</p>
|
||
<p>The <code>parent_painter</code> argument is REQUIRED when spawning this in order to link the datum to an <a href="obj/item/painter.html" title="/obj/item/painter">/obj/item/painter</a>.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/painter.html#var/holder">holder</a></th><td>The parent <a href="obj/item/painter.html" title="/obj/item/painter">/obj/item/painter</a> which this datum is linked to.</td></tr><tr><th><a href="datum/painter.html#var/module_desc">module_desc</a></th><td>Desc of the <code>holder</code> when using this module.</td></tr><tr><th><a href="datum/painter.html#var/module_name">module_name</a></th><td>Name of the <code>holder</code> when using this module.</td></tr><tr><th><a href="datum/painter.html#var/module_state">module_state</a></th><td>Icon and Item state of the <code>holder</code> when using this module.</td></tr><tr><th><a href="datum/painter.html#var/paint_setting">paint_setting</a></th><td>The current colour or icon state setting.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/painter.html#proc/paint_atom">paint_atom</a></th><td>Contains code to apply the <code>paint_setting</code> variable onto the target atom.</td></tr><tr><th><a href="datum/painter.html#proc/pick_color">pick_color</a></th><td>Contains code to choose a new colour or icon state for the <code>paint_setting</code> variable.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/holder"><aside class="declaration">var </aside>holder <aside>– /<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/<a href="obj/item/painter.html">painter</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/items/devices/painter/painter.dm#L163"><img src="git.png" width="16" height="16" title="code/game/objects/items/devices/painter/painter.dm 163"></a></h3><p>The parent <a href="obj/item/painter.html" title="/obj/item/painter">/obj/item/painter</a> which this datum is linked to.</p><h3 id="var/module_desc"><aside class="declaration">var </aside>module_desc <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/items/devices/painter/painter.dm#L158"><img src="git.png" width="16" height="16" title="code/game/objects/items/devices/painter/painter.dm 158"></a></h3><p>Desc of the <code>holder</code> when using this module.</p><h3 id="var/module_name"><aside class="declaration">var </aside>module_name <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/items/devices/painter/painter.dm#L156"><img src="git.png" width="16" height="16" title="code/game/objects/items/devices/painter/painter.dm 156"></a></h3><p>Name of the <code>holder</code> when using this module.</p><h3 id="var/module_state"><aside class="declaration">var </aside>module_state <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/items/devices/painter/painter.dm#L160"><img src="git.png" width="16" height="16" title="code/game/objects/items/devices/painter/painter.dm 160"></a></h3><p>Icon and Item state of the <code>holder</code> when using this module.</p><h3 id="var/paint_setting"><aside class="declaration">var </aside>paint_setting <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/items/devices/painter/painter.dm#L166"><img src="git.png" width="16" height="16" title="code/game/objects/items/devices/painter/painter.dm 166"></a></h3><p>The current colour or icon state setting.</p><h2 id="proc">Proc Details</h2><h3 id="proc/paint_atom"><aside class="declaration">proc </aside>paint_atom<aside>(/<a href="atom.html">atom</a>/target, /<a href="mob.html">mob</a>/user) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/items/devices/painter/painter.dm#L189"><img src="git.png" width="16" height="16" title="code/game/objects/items/devices/painter/painter.dm 189"></a></aside></h3><p>Contains code to apply the <code>paint_setting</code> variable onto the target atom.</p>
|
||
<p>Called by <code>afterattack()</code> on the <code>holder</code> object.</p><h3 id="proc/pick_color"><aside class="declaration">proc </aside>pick_color<aside>(/<a href="mob.html">mob</a>/user) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/items/devices/painter/painter.dm#L181"><img src="git.png" width="16" height="16" title="code/game/objects/items/devices/painter/painter.dm 181"></a></aside></h3><p>Contains code to choose a new colour or icon state for the <code>paint_setting</code> variable.</p>
|
||
<p>Called by <code>attack_self()</code> on the <code>holder</code> object.</p></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/8a8a00a2a9bec485351e5f219982b7315d3504fa">8a8a00a</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html> |