job
/datum/controller/subsystem/job

Vars
all_occupations	List of all jobs.
assigned_captain	If TRUE, some player has been assigned Captaincy or Acting Captaincy at some point during the shift and has been given the spare ID safe code.
chain_of_command	Keys should be assigned job roles. Values should be >= 1. Represents the chain of command on the station. Lower numbers mean higher priority. Used to give the Cap's Spare safe code to a an appropriate player. Assumed Captain is always the highest in the chain of command. See [/datum/controller/subsystem/ticker/proc/equip_characters]
config_documentation	This is just the message we prepen and put into all of the config files to ensure documentation. We use this in more than one place, so let's put it in the SS to make life a bit easier.
dynamic_forced_occupations	Lazylist of mob:occupation_string pairs.
experience_jobs_map	Dictionary of jobs indexed by the experience type they grant.
job_priorities_to_strings	Dictionary that maps job priorities to low/medium/high. Keys have to be number-strings as assoc lists cannot be indexed by integers. Set in setup_job_lists.
joinable_departments	List of all departments with joinable jobs.
joinable_departments_by_type	List of all joinable departments indexed by their typepath, sorted by their own display order.
joinable_occupations	List of jobs that can be joined through the starting menu.
legacy_mode	Are we using the old job config system (txt) or the new job config system (TOML)? IF we are going to use the txt file, then we are in "legacy mode", and this will flip to TRUE.
name_occupations	Dictionary of all jobs, keys are titles.
safe_code_request_loc	The loc to which the emergency safe code has been requested for delivery.
safe_code_requested	Whether the emergency safe code has been requested via a comms console on shifts with no Captain or Acting Captain.
safe_code_timer_id	Timer ID for the emergency safe code request.
type_occupations	Dictionary of all jobs, keys are types.
Procs
AssignRole	Assigns the given job role to the player.
CheckHeadPositions	Attempts to fill out all possible head positions for players with that job at a a given job priority level.
DivideOccupations
DropLandAtRandomHallwayPoint	Lands specified mob at a random spot in the hallways
FillHeadPosition	Will try to select a head, ignoring ALL non-head preferences for every level until.
assign_priority_positions	Blindly assigns the required roles to every player in the dynamic_forced_occupations list.
check_job_eligibility	Runs a standard suite of eligibility checks to make sure the player can take the reqeusted job.
export_toml	Proc that we call to generate a new jobconfig.toml file and send it to the requesting client. Returns TRUE if a file is successfully generated.
fill_ai_positions	Attempts to fill out all available AI positions.
generate_config	Called from an admin debug verb that generates the jobconfig.toml file and then allows the end user to download it to their machine. Returns TRUE if a file is successfully generated, FALSE otherwise.
get_all_heads	Returns a list of minds of all heads of staff
get_all_sec	Returns a list of minds of all security members
get_living_heads	Returns a list of minds of all heads of staff who are alive
get_living_sec	Returns a list of minds of all security members who are alive
job_priority_level_to_string	Takes a job priority #define such as JP_LOW and gets its string representation for logging.
load_jobs_from_config	Called in jobs subsystem initialize if LOAD_JOBS_FROM_TXT config flag is set: reads jobconfig.toml (or if in legacy mode, jobs.txt) to set all of the datum's values to what the server operator wants.
regenerate_job_config	If we add a new job or more fields to config a job with, quickly spin up a brand new config that inherits all of your old settings, but adds the new job with codebase defaults. Returns TRUE if a file is successfully generated, FALSE otherwise.
send_spare_id_safe_code	Send a drop pod containing a piece of paper with the spare ID safe code to loc
setup_job_lists	Builds various lists of jobs based on station, centcom and additional jobs with icons associated with them.

Var Details

var
all_occupations
– /list/datum/job

List of all jobs.

var
assigned_captain
–

If TRUE, some player has been assigned Captaincy or Acting Captaincy at some point during the shift and has been given the spare ID safe code.

var
chain_of_command
– /list

Keys should be assigned job roles. Values should be >= 1. Represents the chain of command on the station. Lower numbers mean higher priority. Used to give the Cap's Spare safe code to a an appropriate player. Assumed Captain is always the highest in the chain of command. See [/datum/controller/subsystem/ticker/proc/equip_characters]

var
config_documentation
–

This is just the message we prepen and put into all of the config files to ensure documentation. We use this in more than one place, so let's put it in the SS to make life a bit easier.

var
dynamic_forced_occupations
– /list

Lazylist of mob:occupation_string pairs.

var
experience_jobs_map
– /list

Dictionary of jobs indexed by the experience type they grant.

var
job_priorities_to_strings
– /list

Dictionary that maps job priorities to low/medium/high. Keys have to be number-strings as assoc lists cannot be indexed by integers. Set in setup_job_lists.

var
joinable_departments
– /list/datum/job_department

List of all departments with joinable jobs.

var
joinable_departments_by_type
– /list/datum/job_department

List of all joinable departments indexed by their typepath, sorted by their own display order.

var
joinable_occupations
– /list/datum/job

List of jobs that can be joined through the starting menu.

var
legacy_mode
–

Are we using the old job config system (txt) or the new job config system (TOML)? IF we are going to use the txt file, then we are in "legacy mode", and this will flip to TRUE.

var
name_occupations
– /list

Dictionary of all jobs, keys are titles.

var
safe_code_request_loc
– /turf

The loc to which the emergency safe code has been requested for delivery.

var
safe_code_requested
–

Whether the emergency safe code has been requested via a comms console on shifts with no Captain or Acting Captain.

var
safe_code_timer_id
–

Timer ID for the emergency safe code request.

var
type_occupations
– /list/datum/job

Dictionary of all jobs, keys are types.

Proc Details

proc
AssignRole
(/mob/dead/new_player/player, /datum/job/job, latejoin, do_eligibility_checks)

Assigns the given job role to the player.

Arguments:

player - The player to assign the job to
job - The job to assign
latejoin - Set to TRUE if this is a latejoin role assignment.
do_eligibility_checks - Set to TRUE to conduct all job eligibility tests and reject on failure. Set to FALSE if job eligibility has been tested elsewhere and they can be safely skipped.

proc
CheckHeadPositions
(level)

Attempts to fill out all possible head positions for players with that job at a a given job priority level.

Arguments:

level - One of the JP_LOW, JP_MEDIUM or JP_HIGH defines. Attempts to find candidates with head jobs at this priority only.

proc
DivideOccupations
()

Proc DivideOccupations
fills var "assigned_role" for all ready players.
This proc must not have any side effect besides of modifying "assigned_role".

proc
DropLandAtRandomHallwayPoint
(/mob/living/living_mob)

Lands specified mob at a random spot in the hallways

proc
FillHeadPosition
()

Will try to select a head, ignoring ALL non-head preferences for every level until.

Basically tries to ensure there is at least one head in every shift if anyone has that job preference enabled at all.

proc
assign_priority_positions
()

Blindly assigns the required roles to every player in the dynamic_forced_occupations list.

proc
check_job_eligibility
(/mob/dead/new_player/player, /datum/job/possible_job, debug_prefix, add_job_to_log)

Runs a standard suite of eligibility checks to make sure the player can take the reqeusted job.

Checks:

Role bans
How many days old the player account is
Whether the player has the required hours in other jobs to take that role
If the job is in the mind's restricted roles, for example if they have an antag datum that's incompatible with certain roles.

Arguments:

player - The player to check for job eligibility.
possible_job - The job to check for eligibility against.
debug_prefix - Logging prefix for the JobDebug log entries. For example, GRJ during GiveRandomJob or DO during DivideOccupations.
add_job_to_log - If TRUE, appends the job type to the log entry. If FALSE, does not. Set to FALSE when check is part of iterating over players for a specific job, set to TRUE when check is part of iterating over jobs for a specific player and you don't want extra log entry spam.

proc
export_toml
(/mob/user, data)

Proc that we call to generate a new jobconfig.toml file and send it to the requesting client. Returns TRUE if a file is successfully generated.

proc
fill_ai_positions
()

Attempts to fill out all available AI positions.

proc
generate_config
(/mob/user)

Called from an admin debug verb that generates the jobconfig.toml file and then allows the end user to download it to their machine. Returns TRUE if a file is successfully generated, FALSE otherwise.

proc
get_all_heads
()

Returns a list of minds of all heads of staff

proc
get_all_sec
()

Returns a list of minds of all security members

proc
get_living_heads
()

Returns a list of minds of all heads of staff who are alive

proc
get_living_sec
()

Returns a list of minds of all security members who are alive

proc
job_priority_level_to_string
(priority)

Takes a job priority #define such as JP_LOW and gets its string representation for logging.

proc
load_jobs_from_config
()

Called in jobs subsystem initialize if LOAD_JOBS_FROM_TXT config flag is set: reads jobconfig.toml (or if in legacy mode, jobs.txt) to set all of the datum's values to what the server operator wants.

proc
regenerate_job_config
(/mob/user)

If we add a new job or more fields to config a job with, quickly spin up a brand new config that inherits all of your old settings, but adds the new job with codebase defaults. Returns TRUE if a file is successfully generated, FALSE otherwise.

proc
send_spare_id_safe_code
(loc)

Send a drop pod containing a piece of paper with the spare ID safe code to loc

proc
setup_job_lists
()

Builds various lists of jobs based on station, centcom and additional jobs with icons associated with them.

job /datum/controller/subsystem/job

Vars

Procs

Var Details

var all_occupations – /list/datum/job

var assigned_captain –

var chain_of_command – /list

var config_documentation –

var dynamic_forced_occupations – /list

var experience_jobs_map – /list

var job_priorities_to_strings – /list

var joinable_departments – /list/datum/job_department

var joinable_departments_by_type – /list/datum/job_department

var joinable_occupations – /list/datum/job

var legacy_mode –

var name_occupations – /list

var safe_code_request_loc – /turf

var safe_code_requested –

var safe_code_timer_id –

var type_occupations – /list/datum/job

Proc Details

proc AssignRole(/mob/dead/new_player/player, /datum/job/job, latejoin, do_eligibility_checks)

proc CheckHeadPositions(level)

proc DivideOccupations()

proc DropLandAtRandomHallwayPoint(/mob/living/living_mob)

proc FillHeadPosition()

proc assign_priority_positions()

proc check_job_eligibility(/mob/dead/new_player/player, /datum/job/possible_job, debug_prefix, add_job_to_log)

proc export_toml(/mob/user, data)

proc fill_ai_positions()

proc generate_config(/mob/user)

proc get_all_heads()

proc get_all_sec()

proc get_living_heads()

proc get_living_sec()

proc job_priority_level_to_string(priority)

proc load_jobs_from_config()

proc regenerate_job_config(/mob/user)

proc send_spare_id_safe_code(loc)

proc setup_job_lists()

job
/datum/controller/subsystem/job

var
all_occupations
– /list/datum/job

var
assigned_captain
–

var
chain_of_command
– /list

var
config_documentation
–

var
dynamic_forced_occupations
– /list

var
experience_jobs_map
– /list

var
job_priorities_to_strings
– /list

var
joinable_departments
– /list/datum/job_department

var
joinable_departments_by_type
– /list/datum/job_department

var
joinable_occupations
– /list/datum/job

var
legacy_mode
–

var
name_occupations
– /list

var
safe_code_request_loc
– /turf

var
safe_code_requested
–

var
safe_code_timer_id
–

var
type_occupations
– /list/datum/job

proc
AssignRole
(/mob/dead/new_player/player, /datum/job/job, latejoin, do_eligibility_checks)

proc
CheckHeadPositions
(level)

proc
DivideOccupations
()

proc
DropLandAtRandomHallwayPoint
(/mob/living/living_mob)

proc
FillHeadPosition
()

proc
assign_priority_positions
()

proc
check_job_eligibility
(/mob/dead/new_player/player, /datum/job/possible_job, debug_prefix, add_job_to_log)

proc
export_toml
(/mob/user, data)

proc
fill_ai_positions
()

proc
generate_config
(/mob/user)

proc
get_all_heads
()

proc
get_all_sec
()

proc
get_living_heads
()

proc
get_living_sec
()

proc
job_priority_level_to_string
(priority)

proc
load_jobs_from_config
()

proc
regenerate_job_config
(/mob/user)

proc
send_spare_id_safe_code
(loc)

proc
setup_job_lists
()