Files
GS13NG/obj/item/clipboard.html
2025-02-05 06:19:18 +00:00

4 lines
4.2 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/clipboard - /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/clipboard.html#var">Var Details</a> - <a href="obj/item/clipboard.html#proc">Proc Details</a></header><main><h1>clipboard <aside>/<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/<a href="obj/item/clipboard.html">clipboard</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/paperwork/clipboard.dm#L4"><img src="git.png" width="16" height="16" title="code/modules/paperwork/clipboard.dm 4"></a></h1><p>Clipboard</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/item/clipboard.html#var/integrated_pen">integrated_pen</a></th><td>Is the pen integrated?</td></tr><tr><th><a href="obj/item/clipboard.html#var/pen">pen</a></th><td>The stored pen</td></tr><tr><th><a href="obj/item/clipboard.html#var/toppaper_ref">toppaper_ref</a></th><td>Weakref of the topmost piece of paper</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/item/clipboard.html#proc/on_top_paper_change">on_top_paper_change</a></th><td>This is a simple proc to handle calling update_icon() upon receiving the top paper's <code>COMSIG_ATOM_UPDATE_APPEARANCE</code>.</td></tr><tr><th><a href="obj/item/clipboard.html#proc/remove_paper">remove_paper</a></th><td>Take out the topmost paper</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/integrated_pen"><aside class="declaration">var </aside>integrated_pen <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/paperwork/clipboard.dm#L18"><img src="git.png" width="16" height="16" title="code/modules/paperwork/clipboard.dm 18"></a></h3><p>Is the pen integrated?</p><h3 id="var/pen"><aside class="declaration">var </aside>pen <aside> /<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/pen</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/paperwork/clipboard.dm#L16"><img src="git.png" width="16" height="16" title="code/modules/paperwork/clipboard.dm 16"></a></h3><p>The stored pen</p><h3 id="var/toppaper_ref"><aside class="declaration">var </aside>toppaper_ref <aside> /<a href="datum.html">datum</a>/weakref</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/paperwork/clipboard.dm#L28"><img src="git.png" width="16" height="16" title="code/modules/paperwork/clipboard.dm 28"></a></h3><p>Weakref of the topmost piece of paper</p>
<p>This is used for the paper displayed on the clipboard's icon
and it is the one attacked, when attacking the clipboard.
(As you can't organise contents directly in BYOND)</p><h2 id="proc">Proc Details</h2><h3 id="proc/on_top_paper_change"><aside class="declaration">proc </aside>on_top_paper_change<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/paperwork/clipboard.dm#L199"><img src="git.png" width="16" height="16" title="code/modules/paperwork/clipboard.dm 199"></a></aside></h3><p>This is a simple proc to handle calling update_icon() upon receiving the top paper's <code>COMSIG_ATOM_UPDATE_APPEARANCE</code>.</p><h3 id="proc/remove_paper"><aside class="declaration">proc </aside>remove_paper<aside>(/<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/<a href="obj/item/paper.html">paper</a>/paper, /<a href="mob.html">mob</a>/user) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/paperwork/clipboard.dm#L49"><img src="git.png" width="16" height="16" title="code/modules/paperwork/clipboard.dm 49"></a></aside></h3><p>Take out the topmost paper</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>