mirror of
https://github.com/ParadiseSS13/Paradise.git
synced 2026-08-27 05:57:24 +01:00
1 line
9.0 KiB
HTML
1 line
9.0 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/component/ghost_direct_control - Space Station 13</title></head><body><header><a href="index.html">Space Station 13</a> - <a href="index.html#modules">Modules</a> - <a href="index.html#types">Types</a> — <a href="datum/component/ghost_direct_control.html#var">Var Details</a> - <a href="datum/component/ghost_direct_control.html#proc">Proc Details</a></header><main><h1>ghost_direct_control <aside>/<a href="datum.html">datum</a>/<a href="datum/component.html">component</a>/<a href="datum/component/ghost_direct_control.html">ghost_direct_control</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/ghost_direct_control.dm#L4"><img src="git.png" width="16" height="16" title="code/datums/components/ghost_direct_control.dm 4"></a></h1><p>Component which lets ghosts click on a mob to take control of it</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/component/ghost_direct_control.html#var/after_assumed_control">after_assumed_control</a></th><td>Callback run after someone successfully takes over the body</td></tr><tr><th><a href="datum/component/ghost_direct_control.html#var/assumed_control_message">assumed_control_message</a></th><td>Message to display upon successful possession</td></tr><tr><th><a href="datum/component/ghost_direct_control.html#var/awaiting_ghosts">awaiting_ghosts</a></th><td>If we're currently awaiting the results of a ghost poll</td></tr><tr><th><a href="datum/component/ghost_direct_control.html#var/ban_type">ban_type</a></th><td>Type of ban you can get to prevent you from accepting this role</td></tr><tr><th><a href="datum/component/ghost_direct_control.html#var/extra_control_checks">extra_control_checks</a></th><td>Any extra checks which need to run before we take over</td></tr><tr><th><a href="datum/component/ghost_direct_control.html#var/is_antag_spawner">is_antag_spawner</a></th><td>Is this an antagonist spawner, so we check ROLE_SYNDICATE</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/component/ghost_direct_control.html#proc/assume_direct_control">assume_direct_control</a></th><td>Grant possession of our mob, component is now no longer required</td></tr><tr><th><a href="datum/component/ghost_direct_control.html#proc/attempt_possession">attempt_possession</a></th><td>We got far enough to establish that this mob is a valid target, let's try to posssess it</td></tr><tr><th><a href="datum/component/ghost_direct_control.html#proc/on_examined">on_examined</a></th><td>Inform ghosts that they can possess this</td></tr><tr><th><a href="datum/component/ghost_direct_control.html#proc/on_ghost_clicked">on_ghost_clicked</a></th><td>A ghost clicked on us, they want to get in this body</td></tr><tr><th><a href="datum/component/ghost_direct_control.html#proc/on_login">on_login</a></th><td>When someone assumes control, get rid of our component</td></tr><tr><th><a href="datum/component/ghost_direct_control.html#proc/request_ghost_control">request_ghost_control</a></th><td>Send out a request for a brain</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/after_assumed_control"><aside class="declaration">var </aside>after_assumed_control <aside>– /<a href="datum.html">datum</a>/callback</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/ghost_direct_control.dm#L12"><img src="git.png" width="16" height="16" title="code/datums/components/ghost_direct_control.dm 12"></a></h3><p>Callback run after someone successfully takes over the body</p><h3 id="var/assumed_control_message"><aside class="declaration">var </aside>assumed_control_message <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/ghost_direct_control.dm#L6"><img src="git.png" width="16" height="16" title="code/datums/components/ghost_direct_control.dm 6"></a></h3><p>Message to display upon successful possession</p><h3 id="var/awaiting_ghosts"><aside class="declaration">var </aside>awaiting_ghosts <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/ghost_direct_control.dm#L14"><img src="git.png" width="16" height="16" title="code/datums/components/ghost_direct_control.dm 14"></a></h3><p>If we're currently awaiting the results of a ghost poll</p><h3 id="var/ban_type"><aside class="declaration">var </aside>ban_type <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/ghost_direct_control.dm#L8"><img src="git.png" width="16" height="16" title="code/datums/components/ghost_direct_control.dm 8"></a></h3><p>Type of ban you can get to prevent you from accepting this role</p><h3 id="var/extra_control_checks"><aside class="declaration">var </aside>extra_control_checks <aside>– /<a href="datum.html">datum</a>/callback</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/ghost_direct_control.dm#L10"><img src="git.png" width="16" height="16" title="code/datums/components/ghost_direct_control.dm 10"></a></h3><p>Any extra checks which need to run before we take over</p><h3 id="var/is_antag_spawner"><aside class="declaration">var </aside>is_antag_spawner <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/ghost_direct_control.dm#L16"><img src="git.png" width="16" height="16" title="code/datums/components/ghost_direct_control.dm 16"></a></h3><p>Is this an antagonist spawner, so we check ROLE_SYNDICATE</p><h2 id="proc">Proc Details</h2><h3 id="proc/assume_direct_control"><aside class="declaration">proc </aside>assume_direct_control<aside>(/<a href="mob.html">mob</a>/harbinger) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/ghost_direct_control.dm#L114"><img src="git.png" width="16" height="16" title="code/datums/components/ghost_direct_control.dm 114"></a></aside></h3><p>Grant possession of our mob, component is now no longer required</p><h3 id="proc/attempt_possession"><aside class="declaration">proc </aside>attempt_possession<aside>(/<a href="mob.html">mob</a>/our_mob, /<a href="mob.html">mob</a>/<a href="mob/dead/observer.html">dead/observer</a>/hopeful_ghost) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/ghost_direct_control.dm#L107"><img src="git.png" width="16" height="16" title="code/datums/components/ghost_direct_control.dm 107"></a></aside></h3><p>We got far enough to establish that this mob is a valid target, let's try to posssess it</p><h3 id="proc/on_examined"><aside class="declaration">proc </aside>on_examined<aside>(/<a href="datum.html">datum</a>/source, /<a href="mob.html">mob</a>/user, /list/examine_text) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/ghost_direct_control.dm#L59"><img src="git.png" width="16" height="16" title="code/datums/components/ghost_direct_control.dm 59"></a></aside></h3><p>Inform ghosts that they can possess this</p><h3 id="proc/on_ghost_clicked"><aside class="declaration">proc </aside>on_ghost_clicked<aside>(/<a href="mob.html">mob</a>/our_mob, /<a href="mob.html">mob</a>/<a href="mob/dead/observer.html">dead/observer</a>/hopeful_ghost) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/ghost_direct_control.dm#L90"><img src="git.png" width="16" height="16" title="code/datums/components/ghost_direct_control.dm 90"></a></aside></h3><p>A ghost clicked on us, they want to get in this body</p><h3 id="proc/on_login"><aside class="declaration">proc </aside>on_login<aside>(/<a href="mob.html">mob</a>/harbinger) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/ghost_direct_control.dm#L140"><img src="git.png" width="16" height="16" title="code/datums/components/ghost_direct_control.dm 140"></a></aside></h3><p>When someone assumes control, get rid of our component</p><h3 id="proc/request_ghost_control"><aside class="declaration">proc </aside>request_ghost_control<aside>(poll_question, role_name, poll_length) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/ghost_direct_control.dm#L69"><img src="git.png" width="16" height="16" title="code/datums/components/ghost_direct_control.dm 69"></a></aside></h3><p>Send out a request for a brain</p></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/8a8a00a2a9bec485351e5f219982b7315d3504fa">8a8a00a</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html> |