Files
Paradise/datum/ruleset.html

1 line
11 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/ruleset - 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/ruleset.html#var">Var Details</a></header><main><h1>ruleset <aside>/<a href="datum.html">datum</a>/<a href="datum/ruleset.html">ruleset</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L4"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 4"></a></h1><p>These are gamemode rulesets for the dynamic gamemode type. They determine what antagonists spawn during a round.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/ruleset.html#var/antag_amount">antag_amount</a></th><td>How many antagonists to spawn</td></tr><tr><th><a href="datum/ruleset.html#var/antag_cost">antag_cost</a></th><td>The cost to roll an antagonist of this ruleset</td></tr><tr><th><a href="datum/ruleset.html#var/antag_weight">antag_weight</a></th><td>The weight to roll an antagonist of this ruleset</td></tr><tr><th><a href="datum/ruleset.html#var/antagonist_type">antagonist_type</a></th><td>Antagonist datum to apply to users</td></tr><tr><th><a href="datum/ruleset.html#var/assign_job_role">assign_job_role</a></th><td>Applies the mind roll to assigned_role, preventing them from rolling a normal job. Good for wizards and nuclear operatives.</td></tr><tr><th><a href="datum/ruleset.html#var/banned_jobs">banned_jobs</a></th><td>These roles 100% cannot be this antagonist</td></tr><tr><th><a href="datum/ruleset.html#var/banned_mutual_rulesets">banned_mutual_rulesets</a></th><td>Rulesets that cannot be rolled while this ruleset is active. Used to prevent traitors from rolling while theres cultists, etc.</td></tr><tr><th><a href="datum/ruleset.html#var/banned_species">banned_species</a></th><td>A blacklist of species names that cannot play this antagonist</td></tr><tr><th><a href="datum/ruleset.html#var/banned_species_only">banned_species_only</a></th><td>If true, the species blacklist is now a species whitelist</td></tr><tr><th><a href="datum/ruleset.html#var/hijack_only_jobs">hijack_only_jobs</a></th><td>Roles that shouldn't be an antag if hijack isn't allowed.</td></tr><tr><th><a href="datum/ruleset.html#var/implied_ruleset_type">implied_ruleset_type</a></th><td>A ruleset to be added when this ruleset is selected by the gamemode</td></tr><tr><th><a href="datum/ruleset.html#var/latespawn_time">latespawn_time</a></th><td>If non-zero, how long from the start of the game should this role enable latespawns?</td></tr><tr><th><a href="datum/ruleset.html#var/latespawns_enabled">latespawns_enabled</a></th><td>Should this ruleset roll latespawns?</td></tr><tr><th><a href="datum/ruleset.html#var/name">name</a></th><td>What this ruleset is called</td></tr><tr><th><a href="datum/ruleset.html#var/pre_antags">pre_antags</a></th><td>All of the minds that we will make into our antagonist type</td></tr><tr><th><a href="datum/ruleset.html#var/protected_jobs">protected_jobs</a></th><td>These roles can't be antagonists because mindshielding or are command staff (this can be disabled via config)</td></tr><tr><th><a href="datum/ruleset.html#var/ruleset_cost">ruleset_cost</a></th><td>The cost to roll this ruleset</td></tr><tr><th><a href="datum/ruleset.html#var/ruleset_weight">ruleset_weight</a></th><td>The weight to roll this ruleset</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/antag_amount"><aside class="declaration">var </aside>antag_amount <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L61"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 61"></a></h3><p>How many antagonists to spawn</p><h3 id="var/antag_cost"><aside class="declaration">var </aside>antag_cost <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L12"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 12"></a></h3><p>The cost to roll an antagonist of this ruleset</p><h3 id="var/antag_weight"><aside class="declaration">var </aside>antag_weight <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L14"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 14"></a></h3><p>The weight to roll an antagonist of this ruleset</p><h3 id="var/antagonist_type"><aside class="declaration">var </aside>antagonist_type <aside> /<a href="datum.html">datum</a>/<a href="datum/antagonist.html">antagonist</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L16"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 16"></a></h3><p>Antagonist datum to apply to users</p><h3 id="var/assign_job_role"><aside class="declaration">var </aside>assign_job_role <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L48"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 48"></a></h3><p>Applies the mind roll to assigned_role, preventing them from rolling a normal job. Good for wizards and nuclear operatives.</p><h3 id="var/banned_jobs"><aside class="declaration">var </aside>banned_jobs <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L21"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 21"></a></h3><p>These roles 100% cannot be this antagonist</p><h3 id="var/banned_mutual_rulesets"><aside class="declaration">var </aside>banned_mutual_rulesets <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L55"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 55"></a></h3><p>Rulesets that cannot be rolled while this ruleset is active. Used to prevent traitors from rolling while theres cultists, etc.</p><h3 id="var/banned_species"><aside class="declaration">var </aside>banned_species <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L50"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 50"></a></h3><p>A blacklist of species names that cannot play this antagonist</p><h3 id="var/banned_species_only"><aside class="declaration">var </aside>banned_species_only <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L52"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 52"></a></h3><p>If true, the species blacklist is now a species whitelist</p><h3 id="var/hijack_only_jobs"><aside class="declaration">var </aside>hijack_only_jobs <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L44"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 44"></a></h3><p>Roles that shouldn't be an antag if hijack isn't allowed.</p><h3 id="var/implied_ruleset_type"><aside class="declaration">var </aside>implied_ruleset_type <aside> /<a href="datum.html">datum</a>/<a href="datum/ruleset.html">ruleset</a>/<a href="datum/ruleset/implied.html">implied</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L18"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 18"></a></h3><p>A ruleset to be added when this ruleset is selected by the gamemode</p><h3 id="var/latespawn_time"><aside class="declaration">var </aside>latespawn_time <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L65"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 65"></a></h3><p>If non-zero, how long from the start of the game should this role enable latespawns?</p><h3 id="var/latespawns_enabled"><aside class="declaration">var </aside>latespawns_enabled <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L67"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 67"></a></h3><p>Should this ruleset roll latespawns?</p><h3 id="var/name"><aside class="declaration">var </aside>name <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L6"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 6"></a></h3><p>What this ruleset is called</p><h3 id="var/pre_antags"><aside class="declaration">var </aside>pre_antags <aside> /list/<a href="datum.html">datum</a>/<a href="datum/mind.html">mind</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L63"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 63"></a></h3><p>All of the minds that we will make into our antagonist type</p><h3 id="var/protected_jobs"><aside class="declaration">var </aside>protected_jobs <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L23"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 23"></a></h3><p>These roles can't be antagonists because mindshielding or are command staff (this can be disabled via config)</p><h3 id="var/ruleset_cost"><aside class="declaration">var </aside>ruleset_cost <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L8"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 8"></a></h3><p>The cost to roll this ruleset</p><h3 id="var/ruleset_weight"><aside class="declaration">var </aside>ruleset_weight <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/gamemodes/dynamic/antag_rulesets.dm#L10"><img src="git.png" width="16" height="16" title="code/game/gamemodes/dynamic/antag_rulesets.dm 10"></a></h3><p>The weight to roll this ruleset</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>