Files
Paradise/obj/item/painter.html

9 lines
7.6 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../"><link rel="stylesheet" href="dmdoc.css"><title>/obj/item/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="obj/item/painter.html#var">Var Details</a> - <a href="obj/item/painter.html#proc">Proc Details</a></header><main><h1>painter <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/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/devices/painter/painter.dm#L1"><img src="git.png" width="16" height="16" title="code/game/objects/items/devices/painter/painter.dm 1"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/item/painter.html#var/module_list">module_list</a></th><td>List of any instanced <a href="datum/painter.html" title="/datum/painter">/datum/painter</a>'s, to avoid spawning more than one of each.</td></tr><tr><th><a href="obj/item/painter.html#var/painter_icon_list">painter_icon_list</a></th><td>Associative list of painter types, with the value being the icon. (For use in the radial menu)</td></tr><tr><th><a href="obj/item/painter.html#var/painter_type_list">painter_type_list</a></th><td>Associative list of painter types, with the value being the datum. (For use in the radial menu)</td></tr><tr><th><a href="obj/item/painter.html#var/selected_module">selected_module</a></th><td>The <a href="datum/painter.html" title="/datum/painter">/datum/painter</a> which is currently active.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/item/painter.html#proc/CtrlClick">CtrlClick</a></th><td>Displays a radial menu for choosing a new painter module.</td></tr><tr><th><a href="obj/item/painter.html#proc/afterattack__legacy__attackchain">afterattack__legacy__attackchain</a></th><td>If adjacent, calls <code>paint_atom()</code> on the <code>selected_module</code>, then plays the <code>usesound</code>.</td></tr><tr><th><a href="obj/item/painter.html#proc/attack_self__legacy__attackchain">attack_self__legacy__attackchain</a></th><td>Calls <code>pick_color()</code> on the <code>selected_module</code>.</td></tr><tr><th><a href="obj/item/painter.html#proc/change_module">change_module</a></th><td>Changes the <code>selected_module</code> variable to <code>new_module</code>, and updates the painter to reflect the new type.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/module_list"><aside class="declaration">var </aside>module_list <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/devices/painter/painter.dm#L29"><img src="git.png" width="16" height="16" title="code/game/objects/items/devices/painter/painter.dm 29"></a></h3><p>List of any instanced <a href="datum/painter.html" title="/datum/painter">/datum/painter</a>'s, to avoid spawning more than one of each.</p><h3 id="var/painter_icon_list"><aside class="declaration">var </aside>painter_icon_list <aside> /static/list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/devices/painter/painter.dm#L19"><img src="git.png" width="16" height="16" title="code/game/objects/items/devices/painter/painter.dm 19"></a></h3><p>Associative list of painter types, with the value being the icon. (For use in the radial menu)</p><h3 id="var/painter_type_list"><aside class="declaration">var </aside>painter_type_list <aside> /static/list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/devices/painter/painter.dm#L11"><img src="git.png" width="16" height="16" title="code/game/objects/items/devices/painter/painter.dm 11"></a></h3><p>Associative list of painter types, with the value being the datum. (For use in the radial menu)</p><h3 id="var/selected_module"><aside class="declaration">var </aside>selected_module <aside> /<a href="datum.html">datum</a>/<a href="datum/painter.html">painter</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/devices/painter/painter.dm#L27"><img src="git.png" width="16" height="16" title="code/game/objects/items/devices/painter/painter.dm 27"></a></h3><p>The <a href="datum/painter.html" title="/datum/painter">/datum/painter</a> which is currently active.</p><h2 id="proc">Proc Details</h2><h3 id="proc/CtrlClick">CtrlClick<aside>(/<a href="mob.html">mob</a>/user) <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/devices/painter/painter.dm#L101"><img src="git.png" width="16" height="16" title="code/game/objects/items/devices/painter/painter.dm 101"></a></aside></h3><p>Displays a radial menu for choosing a new painter module.</p><h3 id="proc/afterattack__legacy__attackchain"><aside class="parent"><a title="/obj/item" href="obj/item.html#proc/afterattack__legacy__attackchain"></a></aside>afterattack__legacy__attackchain<aside>(/<a href="atom.html">atom</a>/target, /<a href="mob.html">mob</a>/user, proximity, params) <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/devices/painter/painter.dm#L91"><img src="git.png" width="16" height="16" title="code/game/objects/items/devices/painter/painter.dm 91"></a></aside></h3><p>If adjacent, calls <code>paint_atom()</code> on the <code>selected_module</code>, then plays the <code>usesound</code>.</p><h3 id="proc/attack_self__legacy__attackchain"><aside class="parent"><a title="/obj/item" href="obj/item.html#proc/attack_self__legacy__attackchain"></a></aside>attack_self__legacy__attackchain<aside>(/<a href="mob.html">mob</a>/user) <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/devices/painter/painter.dm#L85"><img src="git.png" width="16" height="16" title="code/game/objects/items/devices/painter/painter.dm 85"></a></aside></h3><p>Calls <code>pick_color()</code> on the <code>selected_module</code>.</p><h3 id="proc/change_module"><aside class="declaration">proc </aside>change_module<aside>(/<a href="datum.html">datum</a>/<a href="datum/painter.html">painter</a>/new_module, /<a href="mob.html">mob</a>/user) <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/game/objects/items/devices/painter/painter.dm#L59"><img src="git.png" width="16" height="16" title="code/game/objects/items/devices/painter/painter.dm 59"></a></aside></h3><p>Changes the <code>selected_module</code> variable to <code>new_module</code>, and updates the painter to reflect the new type.</p>
<p>If <code>new_module</code> is already present in <code>module_list</code>, then that will be used instead.
Otherwise a new datum will be spawned and added to <code>module_list</code>.
The Name, Description, Icon State, and Item State of the painter will be updated using variables from the <code>new_module</code> datum.</p>
<p>Arguments:</p>
<ul>
<li>datum/painter/new_module - The new painter datum which will be used.</li>
<li>mob/user - The user interacting with the painter.</li>
</ul></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7">c8dfcda</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html>