mirror of
https://github.com/ParadiseSS13/Paradise.git
synced 2026-08-26 13:37:58 +01:00
13 lines
3.8 KiB
HTML
13 lines
3.8 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/candidate_poll - 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/candidate_poll.html#proc">Proc Details</a></header><main><h1>candidate_poll <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#L228"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSghost_spawns.dm 228"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/candidate_poll.html#proc/remove_candidate">remove_candidate</a></th><td>Attempts to remove a signed-up mob from a poll.</td></tr><tr><th><a href="datum/candidate_poll.html#proc/sign_up">sign_up</a></th><td>Attempts to sign a (controlled) mob up</td></tr><tr><th><a href="datum/candidate_poll.html#proc/time_left">time_left</a></th><td>Returns the time left for a poll</td></tr><tr><th><a href="datum/candidate_poll.html#proc/trim_candidates">trim_candidates</a></th><td>Deletes any candidates who may have disconnected from the list</td></tr></table><h2 id="proc">Proc Details</h2><h3 id="proc/remove_candidate"><aside class="declaration">proc </aside>remove_candidate<aside>(/<a href="mob.html">mob</a>/M, silent) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSghost_spawns.dm#L288"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSghost_spawns.dm 288"></a></aside></h3><p>Attempts to remove a signed-up mob from a poll.</p>
|
|
<p>Arguments:</p>
|
|
<ul>
|
|
<li>M - The mob to remove from the poll, if present.</li>
|
|
<li>silent - If TRUE, no messages will be sent to M about their removal.</li>
|
|
</ul><h3 id="proc/sign_up"><aside class="declaration">proc </aside>sign_up<aside>(/<a href="mob.html">mob</a>/M, silent) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSghost_spawns.dm#L255"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSghost_spawns.dm 255"></a></aside></h3><p>Attempts to sign a (controlled) mob up</p>
|
|
<p>Will fail if the mob is already signed up or the poll's timer ran out.
|
|
Does not check for eligibility
|
|
Arguments:</p>
|
|
<ul>
|
|
<li>M - The (controlled) mob to sign up</li>
|
|
<li>silent - Whether no messages should appear or not. If not TRUE, signing up to this poll will also sign the mob up for identical polls</li>
|
|
</ul><h3 id="proc/time_left"><aside class="declaration">proc </aside>time_left<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSghost_spawns.dm#L328"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSghost_spawns.dm 328"></a></aside></h3><p>Returns the time left for a poll</p><h3 id="proc/trim_candidates"><aside class="declaration">proc </aside>trim_candidates<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSghost_spawns.dm#L318"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSghost_spawns.dm 318"></a></aside></h3><p>Deletes any candidates who may have disconnected from the list</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> |