antagonist_selector

Vars
antag_datum	Typepath of the antagonist datum to hand out at round start
antag_flag	The antagonist flag to check player prefs for, for example ROLE_WIZARD
antag_flag_to_ban_check	If a role is to be considered another for the purpose of banning.
antag_preference	If set, will check this preference instead of antag_flag.
candidates	Minds that may become an antagonist.
exclusive_roles	If set, rule will only accept candidates from those roles. If on a roundstart ruleset, requires the player to have the correct antag pref enabled and any of the possible roles enabled.
protected_jobs	A list of jobs that should not be this antagonist
required_jobs	Jobs required for this round type to function, k:v list of JOB_TITLE : NUM_JOB. list(list(cap=1),list(hos=1,sec=2)) translates to one captain OR one hos and two secmans
restricted_jobs	A list of jobs cannot physically be this antagonist, typically AI and borgs.
selected_antagonists	Minds selected for antagonist
selected_mobs	Mobs selected for antagonist. Cleared out after the selection process.
Procs
decide_antagonists	Selects minds to become an antagonist.
give_antag_datums	Sends out antagonist datums.
post_setup	Called by game_mode/proc/post_setup. Used for cleaning up random garbage.
select_antagonist	Add a mind to pre_setup_antags and perform any work on it.
trim_candidates	Return a list of players that have our antag flag checked in prefs and are not banned, among other criteria.

Var Details

var
antag_datum
– /datum/antagonist

Typepath of the antagonist datum to hand out at round start

var
antag_flag
–

The antagonist flag to check player prefs for, for example ROLE_WIZARD

var
antag_flag_to_ban_check
–

If a role is to be considered another for the purpose of banning.

var
antag_preference
–

If set, will check this preference instead of antag_flag.

var
candidates
– /list

Minds that may become an antagonist.

var
exclusive_roles
– /list

If set, rule will only accept candidates from those roles. If on a roundstart ruleset, requires the player to have the correct antag pref enabled and any of the possible roles enabled.

var
protected_jobs
– /list

A list of jobs that should not be this antagonist

var
required_jobs
– /list

Jobs required for this round type to function, k:v list of JOB_TITLE : NUM_JOB. list(list(cap=1),list(hos=1,sec=2)) translates to one captain OR one hos and two secmans

var
restricted_jobs
– /list

A list of jobs cannot physically be this antagonist, typically AI and borgs.

var
selected_antagonists
– /list

Minds selected for antagonist

var
selected_mobs
– /list

Mobs selected for antagonist. Cleared out after the selection process.

Proc Details

proc
decide_antagonists
(num_antagonists)

Selects minds to become an antagonist.

proc
give_antag_datums
(/datum/game_mode/gamemode)

Sends out antagonist datums.

proc
post_setup
()

Called by game_mode/proc/post_setup. Used for cleaning up random garbage.

proc
select_antagonist
(/mob/dead/new_player/player)

Add a mind to pre_setup_antags and perform any work on it.

proc
trim_candidates
(/list/candidates)

Return a list of players that have our antag flag checked in prefs and are not banned, among other criteria.

antagonist_selector /datum/antagonist_selector

Vars

Procs

Var Details

var antag_datum – /datum/antagonist

var antag_flag –

var antag_flag_to_ban_check –

var antag_preference –

var candidates – /list

var exclusive_roles – /list

var protected_jobs – /list

var required_jobs – /list

var restricted_jobs – /list

var selected_antagonists – /list

var selected_mobs – /list