/datum/job

Vars
added_access	Additional accesses for the job if config.jobs_have_minimal_access is set to false
alt_titles	Alternate titles for the job
antag_rep	How much antag rep this job gets increase antag chances next round unless its overriden in antag_rep.txt
auto_deadmin_role_flags	Automatic deadmin for a job. Usually head/security positions
base_access	This job comes with these accesses by default
current_positions	How many players have this job
department_for_prefs	If specified, this department will be used for the preferences menu.
department_head	Who is responsible for demoting them
departments_bitflags	Bitfield of departments this job belongs to. These get setup when adding the job into the department, on job datum creation.
departments_list	Lazy list with the departments this job belongs to. Required to be set for playable jobs. The first department will be used in the preferences menu, unless department_for_prefs is set. TODO: Currently not used so will always be empty! Change this to department datums
description	The description of the job, used for preferences menu. Keep it short and useful. Avoid in-jokes, these are for new players.
display_order	Display order of the job
exclusive_mail_goodies	If this job's mail goodies compete with generic goodies.
exp_requirements	How many minutes are required to unlock this job
exp_type	Which type of XP is required see `EXP_TYPE_` in __DEFINES/preferences.dm
exp_type_department	Department XP required YOGS THIS IS NOT FUCKING SET FOR EVERY JOB I HATE WHOEVER DID THIS
head_announce	Tells the given channels that the given mob is the new department head. See communications.dm for valid channels.
lightup_areas	A list of job-specific areas to enable lights for if this job is present at roundstart, whenever minimal access is not in effect. This will be combined with minimal_lightup_areas, so no need to duplicate entries. Areas within their department will have their lights turned on automatically, so you should really only use this for areas outside of their department.
liver_traits	Lazylist of traits added to the liver of the mob assigned this job (used for the classic "cops heal from donuts" reaction, among others)
mail_goodies	Goodies that can be received via the mail system. Keep the _job definition for this empty and use /obj/item/mail to define general gifts.
mind_traits	Traits added to the mind of the mob assigned this job
minimal_character_age	This is the IC age requirement for the players character in order to be this job.
minimal_lightup_areas	A list of job-specific areas to enable lights for if this job is present at roundstart. Areas within their department will have their lights turned on automatically, so you should really only use this for areas outside of their department.
minimal_player_age	If you have the use_age_restriction_for_jobs config option enabled and the database set up, this option will add a requirement for players to be at least minimal_player_age days old. (meaning they first signed in at least that many days before.)
orbit_icon	Icons to be displayed in the orbit ui. Source: FontAwesome v5.
outfit	Outfit of the job
paycheck	Base pay of the job
paycheck_department	Where to pull money to pay people
req_admin_notify	If this is set to TRUE, a text is printed to the player when jobs are assigned, telling him that he should let admins know that he has to disconnect.
smells_like	The text a person using olfaction will see for the job of the target's scent
space_law_notify	If this is set to 1, a text is printed to the player when jobs are assigned, telling them that space law has been updated.
spawn_positions	How many can start the round as this job
spawn_type	What kind of mob type joining players with this job as their assigned role are spawned as.
supervisors	Supervisors, who this person answers to directly
title	The name of the job used for preferences, bans, etc.
total_positions	How many max open slots for this job
Procs
after_latejoin_spawn	Called after a successful latejoin spawn. Client is in the mob. This happens after after_spawn()
after_roundstart_spawn	Called after a successful roundstart spawn. Client is not yet in the mob. This happens after after_spawn()
get_default_roundstart_spawn_point	Returns an atom where the mob should spawn in. Handles finding and picking a valid roundstart effect landmark spawn point, in case no uncommon different spawning events occur.
get_mail_goodies	An overridable getter for more dynamic goodies.
get_spawn_mob	Finds a valid latejoin spawn point, checking for events and special conditions.

Var Details

var
added_access
– /list

Additional accesses for the job if config.jobs_have_minimal_access is set to false

var
alt_titles
– /list

Alternate titles for the job

var
antag_rep
–

How much antag rep this job gets increase antag chances next round unless its overriden in antag_rep.txt

var
auto_deadmin_role_flags
–

Automatic deadmin for a job. Usually head/security positions

var
base_access
– /list

This job comes with these accesses by default

var
current_positions
–

How many players have this job

var
department_for_prefs
– /datum/job_department

If specified, this department will be used for the preferences menu.

var
department_head
–

Who is responsible for demoting them

var
departments_bitflags
–

Bitfield of departments this job belongs to. These get setup when adding the job into the department, on job datum creation.

var
departments_list
– /list

Lazy list with the departments this job belongs to. Required to be set for playable jobs. The first department will be used in the preferences menu, unless department_for_prefs is set. TODO: Currently not used so will always be empty! Change this to department datums

var
description
–

The description of the job, used for preferences menu. Keep it short and useful. Avoid in-jokes, these are for new players.

var
display_order
–

Display order of the job

var
exclusive_mail_goodies
–

If this job's mail goodies compete with generic goodies.

var
exp_requirements
–

How many minutes are required to unlock this job

var
exp_type
–

Which type of XP is required see EXP_TYPE_ in __DEFINES/preferences.dm

var
exp_type_department
–

Department XP required YOGS THIS IS NOT FUCKING SET FOR EVERY JOB I HATE WHOEVER DID THIS

var
head_announce
– /list

Tells the given channels that the given mob is the new department head. See communications.dm for valid channels.

var
lightup_areas
– /list

A list of job-specific areas to enable lights for if this job is present at roundstart, whenever minimal access is not in effect. This will be combined with minimal_lightup_areas, so no need to duplicate entries. Areas within their department will have their lights turned on automatically, so you should really only use this for areas outside of their department.

var
liver_traits
– /list

Lazylist of traits added to the liver of the mob assigned this job (used for the classic "cops heal from donuts" reaction, among others)

var
mail_goodies
– /list

Goodies that can be received via the mail system. Keep the _job definition for this empty and use /obj/item/mail to define general gifts.

var
mind_traits
– /list

Traits added to the mind of the mob assigned this job

var
minimal_character_age
–

This is the IC age requirement for the players character in order to be this job.

var
minimal_lightup_areas
– /list

A list of job-specific areas to enable lights for if this job is present at roundstart. Areas within their department will have their lights turned on automatically, so you should really only use this for areas outside of their department.

var
minimal_player_age
–

If you have the use_age_restriction_for_jobs config option enabled and the database set up, this option will add a requirement for players to be at least minimal_player_age days old. (meaning they first signed in at least that many days before.)

var
orbit_icon
–

Icons to be displayed in the orbit ui. Source: FontAwesome v5.

var
outfit
–

Outfit of the job

var
paycheck
–

Base pay of the job

var
paycheck_department
–

Where to pull money to pay people

var
req_admin_notify
–

If this is set to TRUE, a text is printed to the player when jobs are assigned, telling him that he should let admins know that he has to disconnect.

var
smells_like
–

The text a person using olfaction will see for the job of the target's scent

var
space_law_notify
–

If this is set to 1, a text is printed to the player when jobs are assigned, telling them that space law has been updated.

var
spawn_positions
–

How many can start the round as this job

var
spawn_type
–

What kind of mob type joining players with this job as their assigned role are spawned as.

var
supervisors
–

Supervisors, who this person answers to directly

var
title
–

The name of the job used for preferences, bans, etc.

var
total_positions
–

How many max open slots for this job

Proc Details

proc
after_latejoin_spawn
(/mob/living/spawning)

Called after a successful latejoin spawn. Client is in the mob. This happens after after_spawn()

proc
after_roundstart_spawn
(/mob/living/spawning, /client/player_client)

Called after a successful roundstart spawn. Client is not yet in the mob. This happens after after_spawn()

proc
get_default_roundstart_spawn_point
()

Returns an atom where the mob should spawn in. Handles finding and picking a valid roundstart effect landmark spawn point, in case no uncommon different spawning events occur.

proc
get_mail_goodies
(/mob/recipient)

An overridable getter for more dynamic goodies.

proc
get_spawn_mob
(/client/player_client, /atom/spawn_point)

Finds a valid latejoin spawn point, checking for events and special conditions.

/datum/job

Vars

Procs

Var Details

var added_access – /list

var alt_titles – /list

var antag_rep –

var auto_deadmin_role_flags –

var base_access – /list

var current_positions –

var department_for_prefs – /datum/job_department

var department_head –

var departments_bitflags –

var departments_list – /list

var description –

var display_order –

var exclusive_mail_goodies –

var exp_requirements –

var exp_type –

var exp_type_department –

var head_announce – /list

var lightup_areas – /list

var liver_traits – /list

var mail_goodies – /list

var mind_traits – /list

var minimal_character_age –

var minimal_lightup_areas – /list

var minimal_player_age –

var orbit_icon –

var outfit –

var paycheck –

var paycheck_department –

var req_admin_notify –

var smells_like –

var space_law_notify –

var spawn_positions –

var spawn_type –

var supervisors –

var title –

var total_positions –