Files
GS13NG/datum/round_event.html
2025-02-05 06:19:18 +00:00

11 lines
6.0 KiB
HTML
Raw Permalink 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/round_event - /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/round_event.html#var">Var Details</a> - <a href="datum/round_event.html#proc">Proc Details</a></header><main><h1>round_event <aside>/<a href="datum.html">datum</a>/<a href="datum/round_event.html">round_event</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/events/_event.dm#L140"><img src="git.png" width="16" height="16" title="code/modules/events/_event.dm 140"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/round_event.html#var/activeFor">activeFor</a></th><td>How long the event has existed. You don't need to change this.</td></tr><tr><th><a href="datum/round_event.html#var/announce_chance">announce_chance</a></th><td>Probability of announcing, used in prob(), 0 to 100, default 100. Called in process, and for a second time in the ion storm event.</td></tr><tr><th><a href="datum/round_event.html#var/announce_when">announce_when</a></th><td>When in the lifetime to call announce(). If you don't want it to announce use announce_chance, below.
This is in seconds - so 1 = ~2 seconds in.</td></tr><tr><th><a href="datum/round_event.html#var/current_players">current_players</a></th><td>Amount of of alive, non-AFK human players on server at the time of event start</td></tr><tr><th><a href="datum/round_event.html#var/end_when">end_when</a></th><td>When in the lifetime the event should end.
This is in seconds - so 1 = ~2 seconds in.</td></tr><tr><th><a href="datum/round_event.html#var/fakeable">fakeable</a></th><td>Can be faked by fake news event.</td></tr><tr><th><a href="datum/round_event.html#var/start_when">start_when</a></th><td>When in the lifetime to call start().
This is in seconds - so 1 = ~2 seconds in.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/round_event.html#proc/announce_to_ghosts">announce_to_ghosts</a></th><td>Called after something followable has been spawned by an event
Provides ghosts a follow link to an atom if possible
Only called once.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/activeFor"><aside class="declaration">var </aside>activeFor <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/events/_event.dm#L157"><img src="git.png" width="16" height="16" title="code/modules/events/_event.dm 157"></a></h3><p>How long the event has existed. You don't need to change this.</p><h3 id="var/announce_chance"><aside class="declaration">var </aside>announce_chance <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/events/_event.dm#L151"><img src="git.png" width="16" height="16" title="code/modules/events/_event.dm 151"></a></h3><p>Probability of announcing, used in prob(), 0 to 100, default 100. Called in process, and for a second time in the ion storm event.</p><h3 id="var/announce_when"><aside class="declaration">var </aside>announce_when <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/events/_event.dm#L149"><img src="git.png" width="16" height="16" title="code/modules/events/_event.dm 149"></a></h3><p>When in the lifetime to call announce(). If you don't want it to announce use announce_chance, below.
This is in seconds - so 1 = ~2 seconds in.</p><h3 id="var/current_players"><aside class="declaration">var </aside>current_players <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/events/_event.dm#L159"><img src="git.png" width="16" height="16" title="code/modules/events/_event.dm 159"></a></h3><p>Amount of of alive, non-AFK human players on server at the time of event start</p><h3 id="var/end_when"><aside class="declaration">var </aside>end_when <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/events/_event.dm#L154"><img src="git.png" width="16" height="16" title="code/modules/events/_event.dm 154"></a></h3><p>When in the lifetime the event should end.
This is in seconds - so 1 = ~2 seconds in.</p><h3 id="var/fakeable"><aside class="declaration">var </aside>fakeable <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/events/_event.dm#L162"><img src="git.png" width="16" height="16" title="code/modules/events/_event.dm 162"></a></h3><p>Can be faked by fake news event.</p><h3 id="var/start_when"><aside class="declaration">var </aside>start_when <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/events/_event.dm#L146"><img src="git.png" width="16" height="16" title="code/modules/events/_event.dm 146"></a></h3><p>When in the lifetime to call start().
This is in seconds - so 1 = ~2 seconds in.</p><h2 id="proc">Proc Details</h2><h3 id="proc/announce_to_ghosts"><aside class="declaration">proc </aside>announce_to_ghosts<aside>(/<a href="atom.html">atom</a>/atom_of_interest) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/events/_event.dm#L185"><img src="git.png" width="16" height="16" title="code/modules/events/_event.dm 185"></a></aside></h3><p>Called after something followable has been spawned by an event
Provides ghosts a follow link to an atom if possible
Only called once.</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>