antag_scenario

Vars
abstract	Whether scenario shouldn't be used in `Antag Mix` and which purpose is to be literally abstract. Scenario will crash in `/datum/antag_scenario/New()` if tried to instantiate
antag_cap	Number of player population, based on which the new scenario antag will be scaled. Can be specified using just number, which will be treated as hard cap, or in linear equation form: list("denominator" = 10, "offset" = 1), where 'denominator' is divider for current players population, and 'offset' is guaranteed amount of antag of scenario's type
antag_datum	Antag datum, that will be granted to chosen players on `execute` which will be called on post setup
antag_role	Role used to check if the player is banned from it. Example: `ROLE_TRAITOR`, `ROLE_CHANGELING`, etc.
antag_special_role	Special role, that will be assigned to chosen players. Example: `SPECIAL_ROLE_TRAITOR`, `SPECIAL_ROLE_CHANGELIN`, etc.
assigned	List of players that were drafted to be antagonists of this scenario
candidates	List of available candidates for this scenario
candidates_required	How many possible candidates are required for this scenario to be executed
config_tag	Configuration tag of scenario, which will be used on scenario configuration loading
cost	Cost of the antag scenario. Antag_mix antag generation is based on this value. Scenarios with `0` cost considered free and only limited by `max_antag_fraction` of `/datum/game_mode/antag_mix`
name	Name of the scenario. Will be used in round end statistics
protected_roles	Jobs that can't be chosen for the scenario if 'GLOB.configuration.gamemode.prevent_mindshield_antags' is TRUE
required_players	Amount of players required to start this scenario
restricted_roles	Jobs that can't be chosen for the scenario
restricted_species	Species that can't be chosen for the scenario
scaled_times	Amount of times, this scenario has been picked again
weight	Weight of the scenario. Will be taken into consideration by 'antag_mix' gamemode. Higher values make scenario more frequent, lower - less. Defaults to '1'
Procs
acceptable	Performs sanity check for this scenario to be run.
apply_configuration	Gets configuration params from [GLOB.configuration.antag_mix_gamemode.params_by_scenario], which are grouped by `config_tag` property of `/datum/antag_scenario`. If `config_tag` field is `null` - default scenario and write them into
execute	Called in `post_setup`, which means that all players already have jobs. Here antags should receive everything they need. Can fail here, but there is nothing we can do on this stage - all players already have their jobs.
get_antag_cap	Gets antag cap per one scenario.
get_total_antag_cap	Gets antag cap per this scenario, but taking `scaled_times` into calculation.
pre_execute	Called in `pre_setup` of /datum/game_mode/antag_mix gamemode. Here antags should be chosen.
ready	Checks whether this scenario is ready to be applied.
trim_candidates	Filter candidates scenario specific requirement vise.

Var Details

var
abstract
–

Whether scenario shouldn't be used in Antag Mix and which purpose is to be literally abstract. Scenario will crash in /datum/antag_scenario/New() if tried to instantiate

var
antag_cap
–

Number of player population, based on which the new scenario antag will be scaled. Can be specified using just number, which will be treated as hard cap, or in linear equation form: list("denominator" = 10, "offset" = 1), where 'denominator' is divider for current players population, and 'offset' is guaranteed amount of antag of scenario's type

var
antag_datum
– /datum/antagonist

Antag datum, that will be granted to chosen players on execute which will be called on post setup

var
antag_role
–

Role used to check if the player is banned from it. Example: ROLE_TRAITOR, ROLE_CHANGELING, etc.

var
antag_special_role
–

Special role, that will be assigned to chosen players. Example: SPECIAL_ROLE_TRAITOR, SPECIAL_ROLE_CHANGELIN, etc.

var
assigned
– /list/datum/mind

List of players that were drafted to be antagonists of this scenario

var
candidates
– /list/mob/new_player

List of available candidates for this scenario

var
candidates_required
–

How many possible candidates are required for this scenario to be executed

var
config_tag
–

Configuration tag of scenario, which will be used on scenario configuration loading

var
cost
–

Cost of the antag scenario. Antag_mix antag generation is based on this value. Scenarios with 0 cost considered free and only limited by max_antag_fraction of /datum/game_mode/antag_mix

var
name
–

Name of the scenario. Will be used in round end statistics

var
protected_roles
– /list

Jobs that can't be chosen for the scenario if 'GLOB.configuration.gamemode.prevent_mindshield_antags' is TRUE

var
required_players
–

Amount of players required to start this scenario

var
restricted_roles
– /list

Jobs that can't be chosen for the scenario

var
restricted_species
– /list

Species that can't be chosen for the scenario

var
scaled_times
–

Amount of times, this scenario has been picked again

var
weight
–

Weight of the scenario. Will be taken into consideration by 'antag_mix' gamemode. Higher values make scenario more frequent, lower - less. Defaults to '1'

Proc Details

proc
acceptable
(population)

Performs sanity check for this scenario to be run.

Returns: 'TRUE' if scenario is matching current situation (game has enough players, enough antags can be spawned). 'FALSE' returned otherwise.

proc
apply_configuration
()

Gets configuration params from [GLOB.configuration.antag_mix_gamemode.params_by_scenario], which are grouped by config_tag property of /datum/antag_scenario. If config_tag field is null - default scenario and write them into

proc
execute
()

Called in post_setup, which means that all players already have jobs. Here antags should receive everything they need. Can fail here, but there is nothing we can do on this stage - all players already have their jobs.

proc
get_antag_cap
(population)

Gets antag cap per one scenario.

proc
get_total_antag_cap
(population)

Gets antag cap per this scenario, but taking scaled_times into calculation.

proc
pre_execute
(population)

Called in pre_setup of /datum/game_mode/antag_mix gamemode. Here antags should be chosen.

Returns: 'TRUE' if successfully executed, for example antags successfully chosen, 'FALSE' otherwise.

proc
ready
()

Checks whether this scenario is ready to be applied.

Returns: 'TRUE' if all requirements are met for this scenario to be executed, 'FALSE' otherwise

proc
trim_candidates
()

Filter candidates scenario specific requirement vise.

antag_scenario /datum/antag_scenario

Vars

Procs

Var Details

var abstract –

var antag_cap –

var antag_datum – /datum/antagonist

var antag_role –

var antag_special_role –

var assigned – /list/datum/mind

var candidates – /list/mob/new_player

var candidates_required –

var config_tag –

var cost –

var name –

var protected_roles – /list

var required_players –

var restricted_roles – /list

var restricted_species – /list

var scaled_times –

var weight –