sheepishgoat
13 lines
5.5 KiB
HTML
13 lines
5.5 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../"><link rel="stylesheet" href="dmdoc.css"><title>/obj/item/organ - /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/organ.html#var">Var Details</a> - <a href="obj/item/organ.html#proc">Proc Details</a></header><main><h1>organ <aside>/<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/<a href="obj/item/organ.html">organ</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/surgery/organs/organ_internal.dm#L1"><img src="git.png" width="16" height="16" title="code/modules/surgery/organs/organ_internal.dm 1"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/item/organ.html#var/healing_factor">healing_factor</a></th><td>Healing factor and decay factor function on % of maxhealth, and do not work by applying a static number per tick</td></tr><tr><th><a href="obj/item/organ.html#var/prev_damage">prev_damage</a></th><td>Organ variables for determining what we alert the owner with when they pass/clear the damage thresholds</td></tr><tr><th><a href="obj/item/organ.html#var/useable">useable</a></th><td>When you take a bite you cant jam it in for surgery anymore.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/item/organ.html#proc/applyOrganDamage">applyOrganDamage</a></th><td>Adjusts an organ's damage by the amount "d", up to a maximum amount, which is by default max damage</td></tr><tr><th><a href="obj/item/organ.html#proc/check_damage_thresholds">check_damage_thresholds</a></th><td></td></tr><tr><th><a href="obj/item/organ.html#proc/setOrganDamage">setOrganDamage</a></th><td>SETS an organ's damage to the amount "d", and in doing so clears or sets the failing flag, good for when you have an effect that should fix an organ if broken</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/healing_factor"><aside class="declaration">var </aside>healing_factor <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/surgery/organs/organ_internal.dm#L15"><img src="git.png" width="16" height="16" title="code/modules/surgery/organs/organ_internal.dm 15"></a></h3><p>Healing factor and decay factor function on % of maxhealth, and do not work by applying a static number per tick</p><h3 id="var/prev_damage"><aside class="declaration">var </aside>prev_damage <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/surgery/organs/organ_internal.dm#L22"><img src="git.png" width="16" height="16" title="code/modules/surgery/organs/organ_internal.dm 22"></a></h3><p>Organ variables for determining what we alert the owner with when they pass/clear the damage thresholds</p><h3 id="var/useable"><aside class="declaration">var </aside>useable <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/surgery/organs/organ_internal.dm#L31"><img src="git.png" width="16" height="16" title="code/modules/surgery/organs/organ_internal.dm 31"></a></h3><p>When you take a bite you cant jam it in for surgery anymore.</p><h2 id="proc">Proc Details</h2><h3 id="proc/applyOrganDamage"><aside class="declaration">proc </aside>applyOrganDamage<aside>(d, maximum) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/surgery/organs/organ_internal.dm#L189"><img src="git.png" width="16" height="16" title="code/modules/surgery/organs/organ_internal.dm 189"></a></aside></h3><p>Adjusts an organ's damage by the amount "d", up to a maximum amount, which is by default max damage</p><h3 id="proc/check_damage_thresholds"><aside class="declaration">proc </aside>check_damage_thresholds<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/surgery/organs/organ_internal.dm#L209"><img src="git.png" width="16" height="16" title="code/modules/surgery/organs/organ_internal.dm 209"></a></aside></h3><ul>
|
||
<li>check_damage_thresholds
|
||
<ul>
|
||
<li>input: M (a mob, the owner of the organ we call the proc on)</li>
|
||
<li>output: returns a message should get displayed.</li>
|
||
<li>description: By checking our current damage against our previous damage, we can decide whether we've passed an organ threshold.</li>
|
||
<li>
|
||
<pre><code> If we have, send the corresponding threshold message to the owner, if such a message exists.
|
||
</code></pre>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul><h3 id="proc/setOrganDamage"><aside class="declaration">proc </aside>setOrganDamage<aside>(d) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/surgery/organs/organ_internal.dm#L200"><img src="git.png" width="16" height="16" title="code/modules/surgery/organs/organ_internal.dm 200"></a></aside></h3><p>SETS an organ's damage to the amount "d", and in doing so clears or sets the failing flag, good for when you have an effect that should fix an organ if broken</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> |