Files
2025-02-05 06:19:18 +00:00

11 lines
5.0 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/paper - /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/paper.html#var">Var Details</a> - <a href="obj/item/paper.html#proc">Proc Details</a></header><main><h1>paper <aside>/<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/<a href="obj/item/paper.html">paper</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/paperwork/paper.dm#L19"><img src="git.png" width="16" height="16" title="code/modules/paperwork/paper.dm 19"></a></h1><p>Paper is now using markdown (like in github pull notes) for ALL rendering
so we do loose a bit of functionality but we gain in easy of use of
paper and getting rid of that crashing bug</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/item/paper.html#var/contact_poison">contact_poison</a></th><td>Overlay info</td></tr><tr><th><a href="obj/item/paper.html#var/form_fields">form_fields</a></th><td>When the sheet can be &quot;filled out&quot;
This is an associated list</td></tr><tr><th><a href="obj/item/paper.html#var/info">info</a></th><td>What's actually written on the paper.</td></tr><tr><th><a href="obj/item/paper.html#var/stamped">stamped</a></th><td>Positioning for the stamp in tgui</td></tr><tr><th><a href="obj/item/paper.html#var/stamps">stamps</a></th><td>The (text for the) stamps on the paper.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/item/paper.html#proc/copy">copy</a></th><td>This proc copies this sheet of paper to a new
sheet. Used by carbon papers and the photocopier machine.</td></tr><tr><th><a href="obj/item/paper.html#proc/setText">setText</a></th><td>This proc sets the text of the paper and updates the
icons. You can modify the pen_color after if need
be.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/contact_poison"><aside class="declaration">var </aside>contact_poison <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/paperwork/paper.dm#L49"><img src="git.png" width="16" height="16" title="code/modules/paperwork/paper.dm 49"></a></h3><p>Overlay info</p><h3 id="var/form_fields"><aside class="declaration">var </aside>form_fields <aside> /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/paperwork/paper.dm#L54"><img src="git.png" width="16" height="16" title="code/modules/paperwork/paper.dm 54"></a></h3><p>When the sheet can be &quot;filled out&quot;
This is an associated list</p><h3 id="var/info"><aside class="declaration">var </aside>info <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/paperwork/paper.dm#L42"><img src="git.png" width="16" height="16" title="code/modules/paperwork/paper.dm 42"></a></h3><p>What's actually written on the paper.</p><h3 id="var/stamped"><aside class="declaration">var </aside>stamped <aside> /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/paperwork/paper.dm#L47"><img src="git.png" width="16" height="16" title="code/modules/paperwork/paper.dm 47"></a></h3><p>Positioning for the stamp in tgui</p><h3 id="var/stamps"><aside class="declaration">var </aside>stamps <aside> /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/paperwork/paper.dm#L46"><img src="git.png" width="16" height="16" title="code/modules/paperwork/paper.dm 46"></a></h3><p>The (text for the) stamps on the paper.</p><h2 id="proc">Proc Details</h2><h3 id="proc/copy"><aside class="declaration">proc </aside>copy<aside>(paper_type, /<a href="atom.html">atom</a>/location, colored) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/paperwork/paper.dm#L68"><img src="git.png" width="16" height="16" title="code/modules/paperwork/paper.dm 68"></a></aside></h3><p>This proc copies this sheet of paper to a new
sheet. Used by carbon papers and the photocopier machine.</p><h3 id="proc/setText"><aside class="declaration">proc </aside>setText<aside>(text) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/paperwork/paper.dm#L89"><img src="git.png" width="16" height="16" title="code/modules/paperwork/paper.dm 89"></a></aside></h3><p>This proc sets the text of the paper and updates the
icons. You can modify the pen_color after if need
be.</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>