game_mode

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.
antagonists	ALL antagonists, not just the roundstart ones
death_timers	A k:v list of mind:time of death.
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.
force_pre_setup_check	Even if the mode has no antag datum, force possible_antags to be built
max_pop	The maximum players this gamemode can roll
min_pop	The minimum players this gamemode can roll
permadead_antag_pool	A list of names of antagonists who are permanantly. This list will be cut down to spend on midrounds.
possible_antags	A list of minds that are elligible to be given antagonist at roundstart
protected_jobs	A list of jobs that should not be this antagonist
recommended_enemies	The recommended number of antag players for this round type
required_enemies	The number of antag players required for this round type to be considered
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.
setup_error	Dynamically set to what the problem was. Or the first problem, anyway.
votable	Is the gamemode votable? !Not implimented!
weight	This is a WEIGHT not a PROBABILITY
Procs
admin_panel	Mode specific admin panel.
check_for_errors	Pass in a list of players about to participate in roundstart, returns an error as a string if the round cannot start.
execute_roundstart	Try to start this gamemode, called by SSticker. Returns FALSE if it fails.
give_antag_datums	Actually send out the antag datums
init_mob_signals	Setup signals for the antagonist's mind and mob. Make sure it gets cleared in handle_antagonist_mind_transfer.
make_antag_chance	Handles late-join antag assignments
on_failed_execute	Clean up a mess we may have made during set up.
post_setup	Everyone should now be on the station and have their normal gear. This is the place to give the special roles extra things
pre_setup	Populate the possible_antags list of minds, and any child behavior.
process	Stub for reference that gamemodes do infact, process.
select_antagonist	Add a mind to pre_setup_antags and perform any work on it.
setup_antags	The absolute last thing called before the round starts. Setup gamemode info/antagonists.
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
antagonists
– /list/datum/mind

ALL antagonists, not just the roundstart ones

var
death_timers
– /list/datum/mind

A k:v list of mind:time of death.

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
force_pre_setup_check
–

Even if the mode has no antag datum, force possible_antags to be built

var
max_pop
–

The maximum players this gamemode can roll

var
min_pop
–

The minimum players this gamemode can roll

var
permadead_antag_pool
– /list

A list of names of antagonists who are permanantly. This list will be cut down to spend on midrounds.

var
possible_antags
– /list/datum/mind

A list of minds that are elligible to be given antagonist at roundstart

var
protected_jobs
– /list

A list of jobs that should not be this antagonist

var
recommended_enemies
–

The recommended number of antag players for this round type

var
required_enemies
–

The number of antag players required for this round type to be considered

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
setup_error
–

Dynamically set to what the problem was. Or the first problem, anyway.

var
votable
–

Is the gamemode votable? !Not implimented!

var
weight
–

This is a WEIGHT not a PROBABILITY

Proc Details

proc
admin_panel
()

Mode specific admin panel.

proc
check_for_errors
()

Pass in a list of players about to participate in roundstart, returns an error as a string if the round cannot start.

proc
execute_roundstart
()

Try to start this gamemode, called by SSticker. Returns FALSE if it fails.

proc
give_antag_datums
()

Actually send out the antag datums

proc
init_mob_signals
(/mob/M)

Setup signals for the antagonist's mind and mob. Make sure it gets cleared in handle_antagonist_mind_transfer.

proc
make_antag_chance
(/mob/living/carbon/human/character)

Handles late-join antag assignments

proc
on_failed_execute
()

Clean up a mess we may have made during set up.

proc
post_setup
(report)

Everyone should now be on the station and have their normal gear. This is the place to give the special roles extra things

proc
pre_setup
()

Populate the possible_antags list of minds, and any child behavior.

↑
process
(delta_time)

Stub for reference that gamemodes do infact, process.

proc
select_antagonist
(/datum/mind/M, /datum/antagonist/antag_path)

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

proc
setup_antags
()

The absolute last thing called before the round starts. Setup gamemode info/antagonists.

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.

game_mode /datum/game_mode

Vars

Procs

Var Details

var antag_datum – /datum/antagonist

var antag_flag –

var antag_flag_to_ban_check –

var antag_preference –

var antagonists – /list/datum/mind

var death_timers – /list/datum/mind

var exclusive_roles – /list

var force_pre_setup_check –

var max_pop –

var min_pop –

var permadead_antag_pool – /list

var possible_antags – /list/datum/mind

var protected_jobs – /list

var recommended_enemies –

var required_enemies –

var required_jobs – /list

var restricted_jobs – /list

var setup_error –

var votable –

var weight –