sheepishgoat
1 line
8.8 KiB
HTML
1 line
8.8 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../"><link rel="stylesheet" href="dmdoc.css"><title>/obj/item/mail - /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/mail.html#var">Var Details</a> - <a href="obj/item/mail.html#proc">Proc Details</a></header><main><h1>mail <aside>/<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/<a href="obj/item/mail.html">mail</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/mail.dm#L2"><img src="git.png" width="16" height="16" title="code/game/objects/items/mail.dm 2"></a></h1><p>Mail is tamper-evident and unresealable, postmarked by CentCom for an individual recepient.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/item/mail.html#var/department_colors">department_colors</a></th><td>mail will have the color of the department the recipient is in.</td></tr><tr><th><a href="obj/item/mail.html#var/generic_goodies">generic_goodies</a></th><td>Goodies which can be given to anyone. The base weight for cash is 56. For there to be a 50/50 chance of getting a department item, they need 56 weight as well.</td></tr><tr><th><a href="obj/item/mail.html#var/goodie_count">goodie_count</a></th><td>How many goodies this mail contains.</td></tr><tr><th><a href="obj/item/mail.html#var/postmarked">postmarked</a></th><td>Does the letter have the postmark overlay?</td></tr><tr><th><a href="obj/item/mail.html#var/recipient_ref">recipient_ref</a></th><td>Weak reference to who this mail is for and who can open it.</td></tr><tr><th><a href="obj/item/mail.html#var/sort_tag">sort_tag</a></th><td>Destination tagging for the mail sorter.</td></tr><tr><th><a href="obj/item/mail.html#var/stamp_max">stamp_max</a></th><td>Maximum number of stamps on the letter.</td></tr><tr><th><a href="obj/item/mail.html#var/stamp_offset_x">stamp_offset_x</a></th><td>Physical offset of stamps on the object. X direction.</td></tr><tr><th><a href="obj/item/mail.html#var/stamp_offset_y">stamp_offset_y</a></th><td>Physical offset of stamps on the object. Y direction.</td></tr><tr><th><a href="obj/item/mail.html#var/stamped">stamped</a></th><td>Does the letter have a stamp overlay?</td></tr><tr><th><a href="obj/item/mail.html#var/stamps">stamps</a></th><td>List of all stamp overlays on the letter.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/item/mail.html#proc/initialize_for_recipient">initialize_for_recipient</a></th><td>Accepts a mind to initialize goodies for a piece of mail.</td></tr><tr><th><a href="obj/item/mail.html#proc/junk_mail">junk_mail</a></th><td>Alternate setup, just complete garbage inside and anyone can open</td></tr><tr><th><a href="obj/item/mail.html#proc/unwrap">unwrap</a></th><td>proc for unwrapping a mail. Goes just for an unwrapping procces, returns FALSE if it fails.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/department_colors"><aside class="declaration">var </aside>department_colors <aside>– /static/list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/mail.dm#L45"><img src="git.png" width="16" height="16" title="code/game/objects/items/mail.dm 45"></a></h3><p>mail will have the color of the department the recipient is in.</p><h3 id="var/generic_goodies"><aside class="declaration">var </aside>generic_goodies <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/mail.dm#L21"><img src="git.png" width="16" height="16" title="code/game/objects/items/mail.dm 21"></a></h3><p>Goodies which can be given to anyone. The base weight for cash is 56. For there to be a 50/50 chance of getting a department item, they need 56 weight as well.</p><h3 id="var/goodie_count"><aside class="declaration">var </aside>goodie_count <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/mail.dm#L19"><img src="git.png" width="16" height="16" title="code/game/objects/items/mail.dm 19"></a></h3><p>How many goodies this mail contains.</p><h3 id="var/postmarked"><aside class="declaration">var </aside>postmarked <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/mail.dm#L30"><img src="git.png" width="16" height="16" title="code/game/objects/items/mail.dm 30"></a></h3><p>Does the letter have the postmark overlay?</p><h3 id="var/recipient_ref"><aside class="declaration">var </aside>recipient_ref <aside>– /<a href="datum.html">datum</a>/weakref</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/mail.dm#L17"><img src="git.png" width="16" height="16" title="code/game/objects/items/mail.dm 17"></a></h3><p>Weak reference to who this mail is for and who can open it.</p><h3 id="var/sort_tag"><aside class="declaration">var </aside>sort_tag <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/mail.dm#L15"><img src="git.png" width="16" height="16" title="code/game/objects/items/mail.dm 15"></a></h3><p>Destination tagging for the mail sorter.</p><h3 id="var/stamp_max"><aside class="declaration">var </aside>stamp_max <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/mail.dm#L36"><img src="git.png" width="16" height="16" title="code/game/objects/items/mail.dm 36"></a></h3><p>Maximum number of stamps on the letter.</p><h3 id="var/stamp_offset_x"><aside class="declaration">var </aside>stamp_offset_x <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/mail.dm#L38"><img src="git.png" width="16" height="16" title="code/game/objects/items/mail.dm 38"></a></h3><p>Physical offset of stamps on the object. X direction.</p><h3 id="var/stamp_offset_y"><aside class="declaration">var </aside>stamp_offset_y <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/mail.dm#L40"><img src="git.png" width="16" height="16" title="code/game/objects/items/mail.dm 40"></a></h3><p>Physical offset of stamps on the object. Y direction.</p><h3 id="var/stamped"><aside class="declaration">var </aside>stamped <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/mail.dm#L32"><img src="git.png" width="16" height="16" title="code/game/objects/items/mail.dm 32"></a></h3><p>Does the letter have a stamp overlay?</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/game/objects/items/mail.dm#L34"><img src="git.png" width="16" height="16" title="code/game/objects/items/mail.dm 34"></a></h3><p>List of all stamp overlays on the letter.</p><h2 id="proc">Proc Details</h2><h3 id="proc/initialize_for_recipient"><aside class="declaration">proc </aside>initialize_for_recipient<aside>(/<a href="datum.html">datum</a>/<a href="datum/mind.html">mind</a>/recipient) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/mail.dm#L165"><img src="git.png" width="16" height="16" title="code/game/objects/items/mail.dm 165"></a></aside></h3><p>Accepts a mind to initialize goodies for a piece of mail.</p><h3 id="proc/junk_mail"><aside class="declaration">proc </aside>junk_mail<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/mail.dm#L211"><img src="git.png" width="16" height="16" title="code/game/objects/items/mail.dm 211"></a></aside></h3><p>Alternate setup, just complete garbage inside and anyone can open</p><h3 id="proc/unwrap"><aside class="declaration">proc </aside>unwrap<aside>(/<a href="mob.html">mob</a>/user) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/game/objects/items/mail.dm#L123"><img src="git.png" width="16" height="16" title="code/game/objects/items/mail.dm 123"></a></aside></h3><p>proc for unwrapping a mail. Goes just for an unwrapping procces, returns FALSE if it fails.</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> |