job
/datum/job

Vars
allow_bureaucratic_error	Should this job be allowed to be picked for the bureaucratic error event?
allowed_auspice	List of Auspices that are allowed to do this job.
allowed_clans	List of Clans that are allowed to do this job.
allowed_splats	List of splats that are allowed to do this job.
allowed_tribes	List of Tribes that are allowed to do this job.
alt_titles	The list of alternative job titles people can pick from, null by default.
alternate_titles	Alternate titles to register as pointing to this job.
auto_deadmin_role_flags	Bitflags for the job
bounty_types	What types of bounty tasks can this job receive past the default? TODO, move to id trims.
config_tag	String key to track any variables we want to tie to this job in config, so we can avoid using the job title. We CAPITALIZE it in order to ensure it's unique and resistant to trivial formatting changes. You'll probably break someone's config if you change this, so it's best to not to.
current_positions	How many players have this job
department_for_prefs	If specified, this department will be used for the preferences menu.
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.
description	The description of the job, used for preferences menu. Keep it short and useful. Avoid in-jokes, these are for new players.
desensitized_base	How desensitized this job is to seeing death as a base - applied with the job
disallowed_clans	List of Clans that are disallowed to do this job.
exclusive_mail_goodies	If this job's mail goodies compete with generic goodies.
exp_granted_type	Experience type granted by playing in this job.
exp_required_type	Experience required to play this job, if the config is enabled, and `exp_required_type_department` is not enabled with the proper config.
exp_required_type_department	Department experience required to play this job, if the config is enabled.
exp_requirements	Minutes of experience-time required to play in this job. The type is determined by [exp_required_type] and [exp_required_type_department] depending on configs.
faction	Players will be allowed to spawn in as jobs that are set to "Station"
family_heirlooms	List of family heirlooms this job can get with the family heirloom quirk. List of types.
guestbook_flags	Guestbook flags, to establish who knowns who etc
head_announce	Tells the given channels that the given mob is the new department head. See communications.dm for valid channels.
job_flags	All values = (JOB_ANNOUNCE_ARRIVAL \| JOB_CREW_MANIFEST \| JOB_EQUIP_RANK \| JOB_CREW_MEMBER \| JOB_NEW_PLAYER_JOINABLE \| JOB_BOLD_SELECT_TEXT \| JOB_ASSIGN_QUIRKS \| JOB_CAN_BE_INTERN \| JOB_CANNOT_OPEN_SLOTS \| JOB_HEAD_OF_STAFF)
job_spawn_title	Job title to use for spawning. Allows a job to spawn without needing map edits.
job_tone	custom ringtone for this job
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.
maximum_immortal_age	Character must not be over this age (in years) since embrace (chronological_age - age) to join as role. (Defaults null, set to desired age.)
mind_traits	Traits added to the mind of the mob assigned this job
minimal_generation	Minimum vampire Generation necessary to do this job.
minimal_masquerade	Minimum Masquerade level necessary to do this job.
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.)
minimal_renown_rank	Minimum Renown Rank necessary to do this job.
minimal_skills	Innate skill levels unlocked at roundstart. Based on config.jobs_have_minimal_access config setting, for example with a full crew. Format is list(/datum/skill/foo = SKILL_EXP_NOVICE) with exp as an integer or as per code/_DEFINES/skills.dm
minimum_immortal_age	Character must be at least this age (in years) since embrace (chronological_age - age) to join as role.
paycheck	How much money does this crew member make in a single paycheck? Note that passive paychecks are capped to PAYCHECK_CREW in regular gameplay after roundstart.
paycheck_department	Which department does this paycheck pay from?
plasmaman_outfit	The job's outfit that will be assigned for plasmamen.
policy_index	String. If set to a non-empty one, it will be the key for the policy text value to show this role on spawn.
policy_override	If set, look for a policy with this instead of the job title
random_spawns_possible	Is this job affected by weird spawns like the ones from station traits
req_admin_notify	If this is set to 1, a text is printed to the player when jobs are assigned, telling him that he should let admins know that he has to disconnect.
required_character_age	Minimal character age for this job
rpg_title	RPG job names, for the memes
skills	Innate skill levels unlocked at roundstart. Based on config.jobs_have_minimal_access config setting, for example with a skeleton crew. Format is list(/datum/skill/foo = SKILL_EXP_NOVICE) with exp as an integer or as per code/_DEFINES/skills.dm
spawn_positions	How many players can spawn in as this job
spawn_type	What kind of mob type joining players with this job as their assigned role are spawned as.
splat_slots	List of species that are limited to a certain amount of that species doing this job. e.g: list(SPLAT_NONE = -1, SPLAT_GHOUL = -1, SPLAT_KINDRED = -1)
supervisors	Supervisors, who this person answers to directly
title	The name of the job , used for preferences, bans and more. Make sure you know what you're doing before changing this.
total_positions	How many players can be this job
voice_of_god_power	Multiplier for general usage of the voice of god.
voice_of_god_silence_power	Multiplier for the silence command of the voice of god.
whitelisted	If this job requires whitelisting before it can be selected for characters.
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()
announce_job	Announce that this job as joined the round to all crew members. Note the joining mob has no client at this point.
generate_traitor_objective	This proc may be called when someone of this job is made into a traitor to create custom objectives related to the job.
get_default_roundstart_spawn_point	Handles finding and picking a valid roundstart effect landmark spawn point, in case no uncommon different spawning events occur.
get_latejoin_spawn_point	Finds a valid latejoin spawn point, checking for events and special conditions.
get_lobby_icon	Returns a large (due to cropping) icon of this job's sechud icon state.
get_mail_goodies	An overridable getter for more dynamic goodies.
get_outfit	Return the outfit to use
get_radio_information	Returns information pertaining to this job's radio.
get_roundstart_spawn_point	Returns an atom where the mob should spawn in.
get_spawn_message	Gets the message that shows up when spawning as this job
get_spawn_message_information	Returns a list of strings that correspond to chat messages sent to this mob when they join the round.
get_spawn_mob	Spawns the mob to be played as, taking into account preferences and the desired spawn point.
map_check
on_respawn	Called when a mob that has this job is admin respawned

Var Details

var
allow_bureaucratic_error

Should this job be allowed to be picked for the bureaucratic error event?

var
allowed_auspice
– /list

List of Auspices that are allowed to do this job.

var
allowed_clans
– /list

List of Clans that are allowed to do this job.

var
allowed_splats
– /list

List of splats that are allowed to do this job.

var
allowed_tribes
– /list

List of Tribes that are allowed to do this job.

var
alt_titles
– /list

The list of alternative job titles people can pick from, null by default.

var
alternate_titles
– /list

Alternate titles to register as pointing to this job.

var
auto_deadmin_role_flags

Bitflags for the job

var
bounty_types

What types of bounty tasks can this job receive past the default? TODO, move to id trims.

var
config_tag

String key to track any variables we want to tie to this job in config, so we can avoid using the job title. We CAPITALIZE it in order to ensure it's unique and resistant to trivial formatting changes. You'll probably break someone's config if you change this, so it's best to not to.

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
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.

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
desensitized_base

How desensitized this job is to seeing death as a base - applied with the job

var
disallowed_clans
– /list

List of Clans that are disallowed to do this job.

var
exclusive_mail_goodies

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

var
exp_granted_type

Experience type granted by playing in this job.

var
exp_required_type

Experience required to play this job, if the config is enabled, and exp_required_type_department is not enabled with the proper config.

var
exp_required_type_department

Department experience required to play this job, if the config is enabled.

var
exp_requirements

Minutes of experience-time required to play in this job. The type is determined by [exp_required_type] and [exp_required_type_department] depending on configs.

var
faction

Players will be allowed to spawn in as jobs that are set to "Station"

var
family_heirlooms
– /list

List of family heirlooms this job can get with the family heirloom quirk. List of types.

var
guestbook_flags

Guestbook flags, to establish who knowns who etc

var
head_announce

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

var
job_flags

var
job_spawn_title

Job title to use for spawning. Allows a job to spawn without needing map edits.

var
job_tone

custom ringtone for this job

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
maximum_immortal_age

Character must not be over this age (in years) since embrace (chronological_age - age) to join as role. (Defaults null, set to desired age.)

var
mind_traits
– /list

Traits added to the mind of the mob assigned this job

var
minimal_generation

Minimum vampire Generation necessary to do this job.

var
minimal_masquerade

Minimum Masquerade level necessary to do this job.

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
minimal_renown_rank

Minimum Renown Rank necessary to do this job.

var
minimal_skills
– /list

Innate skill levels unlocked at roundstart. Based on config.jobs_have_minimal_access config setting, for example with a full crew. Format is list(/datum/skill/foo = SKILL_EXP_NOVICE) with exp as an integer or as per code/_DEFINES/skills.dm

var
minimum_immortal_age

Character must be at least this age (in years) since embrace (chronological_age - age) to join as role.

var
paycheck

How much money does this crew member make in a single paycheck? Note that passive paychecks are capped to PAYCHECK_CREW in regular gameplay after roundstart.

var
paycheck_department

Which department does this paycheck pay from?

var
plasmaman_outfit
– /datum/outfit/plasmaman

The job's outfit that will be assigned for plasmamen.

var
policy_index

String. If set to a non-empty one, it will be the key for the policy text value to show this role on spawn.

var
policy_override

If set, look for a policy with this instead of the job title

var
random_spawns_possible

Is this job affected by weird spawns like the ones from station traits

var
req_admin_notify

If this is set to 1, 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
required_character_age

Minimal character age for this job

var
rpg_title

RPG job names, for the memes

var
skills
– /list

Innate skill levels unlocked at roundstart. Based on config.jobs_have_minimal_access config setting, for example with a skeleton crew. Format is list(/datum/skill/foo = SKILL_EXP_NOVICE) with exp as an integer or as per code/_DEFINES/skills.dm

var
spawn_positions

How many players can spawn in as this job

var
spawn_type

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

var
splat_slots
– /list

List of species that are limited to a certain amount of that species doing this job. e.g: list(SPLAT_NONE = -1, SPLAT_GHOUL = -1, SPLAT_KINDRED = -1)

var
supervisors

Supervisors, who this person answers to directly

var
title

The name of the job , used for preferences, bans and more. Make sure you know what you're doing before changing this.

var
total_positions

How many players can be this job

var
voice_of_god_power

Multiplier for general usage of the voice of god.

var
voice_of_god_silence_power

Multiplier for the silence command of the voice of god.

var
whitelisted

If this job requires whitelisting before it can be selected for characters.

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
announce_job
(/mob/living/joining_mob, job_title)

Announce that this job as joined the round to all crew members. Note the joining mob has no client at this point.

proc
generate_traitor_objective
()

This proc may be called when someone of this job is made into a traitor to create custom objectives related to the job.

proc
get_default_roundstart_spawn_point
()

Handles finding and picking a valid roundstart effect landmark spawn point, in case no uncommon different spawning events occur.

proc
get_latejoin_spawn_point
()

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

proc
get_lobby_icon
() as /icon

Returns a large (due to cropping) icon of this job's sechud icon state.

proc
get_mail_goodies
(/mob/recipient)

An overridable getter for more dynamic goodies.

proc
get_outfit
(consistent)

Return the outfit to use

proc
get_radio_information
()

Returns information pertaining to this job's radio.

proc
get_roundstart_spawn_point
()

Returns an atom where the mob should spawn in.

proc
get_spawn_message
(alt_title)

Gets the message that shows up when spawning as this job

proc
get_spawn_message_information
(alt_title)

Returns a list of strings that correspond to chat messages sent to this mob when they join the round.

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

Spawns the mob to be played as, taking into account preferences and the desired spawn point.

proc
map_check
()

map_check

Checks the map config for job changes If they have 0 spawn and total positions in the config, the job is entirely removed from occupations prefs for the round.

proc
on_respawn
(/mob/new_character)

Called when a mob that has this job is admin respawned

job /datum/job

Vars

Procs

Var Details

var allow_bureaucratic_error

var allowed_auspice – /list

var allowed_clans – /list

var allowed_splats – /list

var allowed_tribes – /list

var alt_titles – /list

var alternate_titles – /list

var auto_deadmin_role_flags

var bounty_types

var config_tag

var current_positions

var department_for_prefs – /datum/job_department

var departments_bitflags

var departments_list – /list

var description

var desensitized_base

var disallowed_clans – /list

var exclusive_mail_goodies

var exp_granted_type

var exp_required_type

var exp_required_type_department

var exp_requirements

var faction

var family_heirlooms – /list

var guestbook_flags

var head_announce

var job_flags

var job_spawn_title

var job_tone

var liver_traits – /list

var mail_goodies – /list

var maximum_immortal_age

var mind_traits – /list

var minimal_generation

var minimal_masquerade

var minimal_player_age

var minimal_renown_rank

var minimal_skills – /list

var minimum_immortal_age

var paycheck

var paycheck_department

var plasmaman_outfit – /datum/outfit/plasmaman

var policy_index

var policy_override

var random_spawns_possible

var req_admin_notify

var required_character_age

var rpg_title

var skills – /list

var spawn_positions

var spawn_type

var splat_slots – /list

var supervisors

var title

var total_positions

var voice_of_god_power

var voice_of_god_silence_power

var whitelisted