Files
GS13NG/datum/status_effect/offering.html
T

1 line
6.6 KiB
HTML
Raw 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/status_effect/offering - /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/status_effect/offering.html#var">Var Details</a> - <a href="datum/status_effect/offering.html#proc">Proc Details</a></header><main><h1>offering <aside>/<a href="datum.html">datum</a>/<a href="datum/status_effect.html">status_effect</a>/<a href="datum/status_effect/offering.html">offering</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/status_effects/neutral.dm#L88"><img src="git.png" width="16" height="16" title="code/datums/status_effects/neutral.dm 88"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/status_effect/offering.html#var/give_alert_type">give_alert_type</a></th><td>The type of alert given to people when offered, in case you need to override some behavior (like for high-fives)</td></tr><tr><th><a href="datum/status_effect/offering.html#var/offered_item">offered_item</a></th><td>The actual item being offered</td></tr><tr><th><a href="datum/status_effect/offering.html#var/possible_takers">possible_takers</a></th><td>The people who were offered this item at the start</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/status_effect/offering.html#proc/check_owner_in_range">check_owner_in_range</a></th><td>The offerer moved, see if anyone is out of range now</td></tr><tr><th><a href="datum/status_effect/offering.html#proc/check_taker_in_range">check_taker_in_range</a></th><td>One of our possible takers moved, see if they left us hanging</td></tr><tr><th><a href="datum/status_effect/offering.html#proc/dropped_item">dropped_item</a></th><td>We lost the item, give it up</td></tr><tr><th><a href="datum/status_effect/offering.html#proc/register_candidate">register_candidate</a></th><td>Hook up the specified carbon mob to be offered the item in question, give them the alert and signals and all</td></tr><tr><th><a href="datum/status_effect/offering.html#proc/remove_candidate">remove_candidate</a></th><td>Remove the alert and signals for the specified carbon mob. Automatically removes the status effect when we lost the last taker</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/give_alert_type"><aside class="declaration">var </aside>give_alert_type <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/status_effects/neutral.dm#L99"><img src="git.png" width="16" height="16" title="code/datums/status_effects/neutral.dm 99"></a></h3><p>The type of alert given to people when offered, in case you need to override some behavior (like for high-fives)</p><h3 id="var/offered_item"><aside class="declaration">var </aside>offered_item <aside> /<a href="obj.html">obj</a>/<a href="obj/item.html">item</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/status_effects/neutral.dm#L97"><img src="git.png" width="16" height="16" title="code/datums/status_effects/neutral.dm 97"></a></h3><p>The actual item being offered</p><h3 id="var/possible_takers"><aside class="declaration">var </aside>possible_takers <aside> /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/status_effects/neutral.dm#L95"><img src="git.png" width="16" height="16" title="code/datums/status_effects/neutral.dm 95"></a></h3><p>The people who were offered this item at the start</p><h2 id="proc">Proc Details</h2><h3 id="proc/check_owner_in_range"><aside class="declaration">proc </aside>check_owner_in_range<aside>(/<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/<a href="mob/living/carbon.html">carbon</a>/source) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/status_effects/neutral.dm#L156"><img src="git.png" width="16" height="16" title="code/datums/status_effects/neutral.dm 156"></a></aside></h3><p>The offerer moved, see if anyone is out of range now</p><h3 id="proc/check_taker_in_range"><aside class="declaration">proc </aside>check_taker_in_range<aside>(/<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/<a href="mob/living/carbon.html">carbon</a>/taker) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/status_effects/neutral.dm#L148"><img src="git.png" width="16" height="16" title="code/datums/status_effects/neutral.dm 148"></a></aside></h3><p>One of our possible takers moved, see if they left us hanging</p><h3 id="proc/dropped_item"><aside class="declaration">proc </aside>dropped_item<aside>(/<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/source) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/status_effects/neutral.dm#L165"><img src="git.png" width="16" height="16" title="code/datums/status_effects/neutral.dm 165"></a></aside></h3><p>We lost the item, give it up</p><h3 id="proc/register_candidate"><aside class="declaration">proc </aside>register_candidate<aside>(/<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/<a href="mob/living/carbon.html">carbon</a>/possible_candidate) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/status_effects/neutral.dm#L131"><img src="git.png" width="16" height="16" title="code/datums/status_effects/neutral.dm 131"></a></aside></h3><p>Hook up the specified carbon mob to be offered the item in question, give them the alert and signals and all</p><h3 id="proc/remove_candidate"><aside class="declaration">proc </aside>remove_candidate<aside>(/<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/<a href="mob/living/carbon.html">carbon</a>/removed_candidate) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/status_effects/neutral.dm#L140"><img src="git.png" width="16" height="16" title="code/datums/status_effects/neutral.dm 140"></a></aside></h3><p>Remove the alert and signals for the specified carbon mob. Automatically removes the status effect when we lost the last taker</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>