shikix/GS13NG
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
gh-pages
GS13NG/datum/strippable_item.html
T
sheepishgoat 705fd9528e Deploying to gh-pages from @ e8e0068531 🚀
2025-02-05 06:19:18 +00:00

23 lines
10 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>/datum/strippable_item - /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="datum/strippable_item.html#var">Var Details</a> - <a href="datum/strippable_item.html#proc">Proc Details</a></header><main><h1>strippable_item <aside>/<a href="datum.html">datum</a>/<a href="datum/strippable_item.html">strippable_item</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/elements/strippable.dm#L63"><img src="git.png" width="16" height="16" title="code/datums/elements/strippable.dm 63"></a></h1><p>A representation of an item that can be stripped down</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/strippable_item.html#var/key">key</a></th><td>The STRIPPABLE_ITEM_* key</td></tr><tr><th><a href="datum/strippable_item.html#var/warn_dangerous_clothing">warn_dangerous_clothing</a></th><td>Should we warn about dangerous clothing?</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/strippable_item.html#proc/alternate_action">alternate_action</a></th><td>Performs an alternative action on this strippable_item.
<code>has_alternate_action</code> needs to be TRUE.</td></tr><tr><th><a href="datum/strippable_item.html#proc/finish_equip">finish_equip</a></th><td>The proc that places the item on the source. This should not yield.</td></tr><tr><th><a href="datum/strippable_item.html#proc/finish_unequip">finish_unequip</a></th><td>The proc that unequips the item from the source. This should not yield.</td></tr><tr><th><a href="datum/strippable_item.html#proc/get_alternate_action">get_alternate_action</a></th><td>Returns the ID of this item's strippable action.
Return <code>null</code> if there is no alternate action.
Any return value of this must be in StripMenu.</td></tr><tr><th><a href="datum/strippable_item.html#proc/get_item">get_item</a></th><td>Gets the item from the given source.</td></tr><tr><th><a href="datum/strippable_item.html#proc/get_obscuring">get_obscuring</a></th><td>Returns a STRIPPABLE_OBSCURING_* define to report on whether or not this is obscured.</td></tr><tr><th><a href="datum/strippable_item.html#proc/should_show">should_show</a></th><td>Returns whether or not this item should show.</td></tr><tr><th><a href="datum/strippable_item.html#proc/start_equip">start_equip</a></th><td>Start the equipping process. This is the proc you should yield in.
Returns TRUE/FALSE depending on if it is allowed.</td></tr><tr><th><a href="datum/strippable_item.html#proc/start_unequip">start_unequip</a></th><td>Start the unequipping process. This is the proc you should yield in.
Returns TRUE/FALSE depending on if it is allowed.</td></tr><tr><th><a href="datum/strippable_item.html#proc/try_equip">try_equip</a></th><td>Tries to equip the item onto the given source.
Returns TRUE/FALSE depending on if it is allowed.
This should be used for checking if an item CAN be equipped.
It should not perform the equipping itself.</td></tr><tr><th><a href="datum/strippable_item.html#proc/try_unequip">try_unequip</a></th><td>Tries to unequip the item from the given source.
Returns TRUE/FALSE depending on if it is allowed.
This should be used for checking if it CAN be unequipped.
It should not perform the unequipping itself.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/key"><aside class="declaration">var </aside>key <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/elements/strippable.dm#L65"><img src="git.png" width="16" height="16" title="code/datums/elements/strippable.dm 65"></a></h3><p>The STRIPPABLE_ITEM_* key</p><h3 id="var/warn_dangerous_clothing"><aside class="declaration">var </aside>warn_dangerous_clothing <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/elements/strippable.dm#L68"><img src="git.png" width="16" height="16" title="code/datums/elements/strippable.dm 68"></a></h3><p>Should we warn about dangerous clothing?</p><h2 id="proc">Proc Details</h2><h3 id="proc/alternate_action"><aside class="declaration">proc </aside>alternate_action<aside>(/<a href="atom.html">atom</a>/source, /<a href="mob.html">mob</a>/user) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/elements/strippable.dm#L183"><img src="git.png" width="16" height="16" title="code/datums/elements/strippable.dm 183"></a></aside></h3><p>Performs an alternative action on this strippable_item.
<code>has_alternate_action</code> needs to be TRUE.</p><h3 id="proc/finish_equip"><aside class="declaration">proc </aside>finish_equip<aside>(/<a href="atom.html">atom</a>/source, /<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/equipping, /<a href="mob.html">mob</a>/user) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/elements/strippable.dm#L110"><img src="git.png" width="16" height="16" title="code/datums/elements/strippable.dm 110"></a></aside></h3><p>The proc that places the item on the source. This should not yield.</p><h3 id="proc/finish_unequip"><aside class="declaration">proc </aside>finish_unequip<aside>(/<a href="atom.html">atom</a>/source, /<a href="mob.html">mob</a>/user) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/elements/strippable.dm#L166"><img src="git.png" width="16" height="16" title="code/datums/elements/strippable.dm 166"></a></aside></h3><p>The proc that unequips the item from the source. This should not yield.</p><h3 id="proc/get_alternate_action"><aside class="declaration">proc </aside>get_alternate_action<aside>(/<a href="atom.html">atom</a>/source, /<a href="mob.html">mob</a>/user) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/elements/strippable.dm#L176"><img src="git.png" width="16" height="16" title="code/datums/elements/strippable.dm 176"></a></aside></h3><p>Returns the ID of this item's strippable action.
Return <code>null</code> if there is no alternate action.
Any return value of this must be in StripMenu.</p><h3 id="proc/get_item"><aside class="declaration">proc </aside>get_item<aside>(/<a href="atom.html">atom</a>/source) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/elements/strippable.dm#L71"><img src="git.png" width="16" height="16" title="code/datums/elements/strippable.dm 71"></a></aside></h3><p>Gets the item from the given source.</p><h3 id="proc/get_obscuring"><aside class="declaration">proc </aside>get_obscuring<aside>(/<a href="atom.html">atom</a>/source) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/elements/strippable.dm#L169"><img src="git.png" width="16" height="16" title="code/datums/elements/strippable.dm 169"></a></aside></h3><p>Returns a STRIPPABLE_OBSCURING_* define to report on whether or not this is obscured.</p><h3 id="proc/should_show"><aside class="declaration">proc </aside>should_show<aside>(/<a href="atom.html">atom</a>/source, /<a href="mob.html">mob</a>/user) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/elements/strippable.dm#L189"><img src="git.png" width="16" height="16" title="code/datums/elements/strippable.dm 189"></a></aside></h3><p>Returns whether or not this item should show.</p><h3 id="proc/start_equip"><aside class="declaration">proc </aside>start_equip<aside>(/<a href="atom.html">atom</a>/source, /<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/equipping, /<a href="mob.html">mob</a>/user) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/elements/strippable.dm#L86"><img src="git.png" width="16" height="16" title="code/datums/elements/strippable.dm 86"></a></aside></h3><p>Start the equipping process. This is the proc you should yield in.
Returns TRUE/FALSE depending on if it is allowed.</p><h3 id="proc/start_unequip"><aside class="declaration">proc </aside>start_unequip<aside>(/<a href="atom.html">atom</a>/source, /<a href="mob.html">mob</a>/user) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/elements/strippable.dm#L134"><img src="git.png" width="16" height="16" title="code/datums/elements/strippable.dm 134"></a></aside></h3><p>Start the unequipping process. This is the proc you should yield in.
Returns TRUE/FALSE depending on if it is allowed.</p><h3 id="proc/try_equip"><aside class="declaration">proc </aside>try_equip<aside>(/<a href="atom.html">atom</a>/source, /<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/equipping, /<a href="mob.html">mob</a>/user) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/elements/strippable.dm#L77"><img src="git.png" width="16" height="16" title="code/datums/elements/strippable.dm 77"></a></aside></h3><p>Tries to equip the item onto the given source.
Returns TRUE/FALSE depending on if it is allowed.
This should be used for checking if an item CAN be equipped.
It should not perform the equipping itself.</p><h3 id="proc/try_unequip"><aside class="declaration">proc </aside>try_unequip<aside>(/<a href="atom.html">atom</a>/source, /<a href="mob.html">mob</a>/user) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/elements/strippable.dm#L118"><img src="git.png" width="16" height="16" title="code/datums/elements/strippable.dm 118"></a></aside></h3><p>Tries to unequip the item from the given source.
Returns TRUE/FALSE depending on if it is allowed.
This should be used for checking if it CAN be unequipped.
It should not perform the unequipping itself.</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>
Reference in New Issue View Git Blame Copy Permalink