mirror of
https://github.com/ParadiseSS13/Paradise.git
synced 2026-08-27 05:57:24 +01:00
30 lines
7.6 KiB
HTML
30 lines
7.6 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/controller/subsystem/ghost_spawns - 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/controller/subsystem/ghost_spawns.html#var">Var Details</a> - <a href="datum/controller/subsystem/ghost_spawns.html#proc">Proc Details</a></header><main><h1>ghost_spawns <aside>/<a href="datum.html">datum</a>/<a href="datum/controller.html">controller</a>/<a href="datum/controller/subsystem.html">subsystem</a>/<a href="datum/controller/subsystem/ghost_spawns.html">ghost_spawns</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSghost_spawns.dm#L1"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSghost_spawns.dm 1"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/controller/subsystem/ghost_spawns.html#var/currently_polling">currently_polling</a></th><td>List of polls currently ongoing, to be checked on next fire()</td></tr><tr><th><a href="datum/controller/subsystem/ghost_spawns.html#var/next_poll_to_finish">next_poll_to_finish</a></th><td>The poll that's closest to finishing</td></tr><tr><th><a href="datum/controller/subsystem/ghost_spawns.html#var/polls_active">polls_active</a></th><td>Whether there are active polls or not</td></tr><tr><th><a href="datum/controller/subsystem/ghost_spawns.html#var/total_polls">total_polls</a></th><td>Number of polls performed since the start</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/controller/subsystem/ghost_spawns.html#proc/is_eligible">is_eligible</a></th><td>Returns whether an observer is eligible to be an event mob</td></tr><tr><th><a href="datum/controller/subsystem/ghost_spawns.html#proc/poll_candidates">poll_candidates</a></th><td>Polls for candidates with a question and a preview of the role</td></tr><tr><th><a href="datum/controller/subsystem/ghost_spawns.html#proc/polling_finished">polling_finished</a></th><td>Called by the subsystem when a poll's timer runs out</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/currently_polling"><aside class="declaration">var </aside>currently_polling <aside>– /list/<a href="datum.html">datum</a>/<a href="datum/candidate_poll.html">candidate_poll</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSghost_spawns.dm#L10"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSghost_spawns.dm 10"></a></h3><p>List of polls currently ongoing, to be checked on next fire()</p><h3 id="var/next_poll_to_finish"><aside class="declaration">var </aside>next_poll_to_finish <aside>– /<a href="datum.html">datum</a>/<a href="datum/candidate_poll.html">candidate_poll</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSghost_spawns.dm#L16"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSghost_spawns.dm 16"></a></h3><p>The poll that's closest to finishing</p><h3 id="var/polls_active"><aside class="declaration">var </aside>polls_active <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSghost_spawns.dm#L12"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSghost_spawns.dm 12"></a></h3><p>Whether there are active polls or not</p><h3 id="var/total_polls"><aside class="declaration">var </aside>total_polls <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSghost_spawns.dm#L14"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSghost_spawns.dm 14"></a></h3><p>Number of polls performed since the start</p><h2 id="proc">Proc Details</h2><h3 id="proc/is_eligible"><aside class="declaration">proc </aside>is_eligible<aside>(/<a href="mob.html">mob</a>/M, role, antag_age_check, role_text, min_hours, check_antaghud, ignore_respawnability) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSghost_spawns.dm#L168"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSghost_spawns.dm 168"></a></aside></h3><p>Returns whether an observer is eligible to be an event mob</p>
|
||
<p>Arguments:</p>
|
||
<ul>
|
||
<li>M - The mob to check eligibility</li>
|
||
<li>role - The role to check eligibility for. Checks 1. the client has enabled the role 2. the account's age for this role if antag_age_check is TRUE</li>
|
||
<li>antag_age_check - Whether to check the account's age or not for the given role.</li>
|
||
<li>role_text - The role's clean text. Used for checking job bans to determine eligibility</li>
|
||
<li>min_hours - The amount of minimum hours the client needs before being eligible</li>
|
||
<li>check_antaghud - Whether to consider a client who enabled AntagHUD ineligible or not</li>
|
||
</ul><h3 id="proc/poll_candidates"><aside class="declaration">proc </aside>poll_candidates<aside>(question, role, antag_age_check, poll_time, ignore_respawnability, min_hours, flash_window, check_antaghud, source, role_cleanname, reason, dont_play_notice_sound) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSghost_spawns.dm#L46"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSghost_spawns.dm 46"></a></aside></h3><p>Polls for candidates with a question and a preview of the role</p>
|
||
<p>This proc replaces /proc/pollCandidates.
|
||
Should NEVER be used in a proc that has waitfor set to FALSE/0 (due to #define UNTIL)
|
||
Arguments:</p>
|
||
<ul>
|
||
<li>question - The question to ask to potential candidates</li>
|
||
<li>role - The role to poll for. Should be a ROLE_x enum. If set, potential candidates who aren't eligible will be ignored</li>
|
||
<li>antag_age_check - Whether to filter out potential candidates who don't have an old enough account</li>
|
||
<li>poll_time - How long to poll for in deciseconds</li>
|
||
<li>ignore_respawnability - Whether to ignore the player's respawnability</li>
|
||
<li>min_hours - The amount of hours needed for a potential candidate to be eligible</li>
|
||
<li>flash_window - Whether the poll should flash a potential candidate's game window</li>
|
||
<li>check_antaghud - Whether to filter out potential candidates who enabled AntagHUD</li>
|
||
<li>source - The atom, atom prototype, icon or mutable appearance to display as an icon in the alert</li>
|
||
<li>role_cleanname - The name override to display to clients</li>
|
||
</ul><h3 id="proc/polling_finished"><aside class="declaration">proc </aside>polling_finished<aside>(/<a href="datum.html">datum</a>/<a href="datum/candidate_poll.html">candidate_poll</a>/P) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSghost_spawns.dm#L200"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSghost_spawns.dm 200"></a></aside></h3><p>Called by the subsystem when a poll's timer runs out</p>
|
||
<p>Can be called manually to finish a poll prematurely
|
||
Arguments:</p>
|
||
<ul>
|
||
<li>P - The poll to finish</li>
|
||
</ul></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> |