byond - Modules - TypesVar Details - Proc Details

/datum/job

Vars

allow_additionalCan admins modify positions to it
current_positionsHow many players have this job
disp_titleDetermined on new(). Usually the same as the title, but doesn't have to be. Set this to override what the player sees in the game as their title.
faction_menuUnder what faction menu the job gets displayed in lobby
flags_startup_parametersThese flags are used to determine how to load the role, and some other parameters.
flags_whitelistOnly used by whitelisted roles. Can be a single whitelist flag, or a combination of them.
gear_presetGear preset name used for this job
gear_preset_whitelistGear preset name used for council snowflakes ;)
gets_emergency_kitIf TRUE, this job will spawn w/ a cryo emergency kit during evac/red alert
handle_spawn_and_equipWhen set to true, SSticker won't call spawn_in_player, instead calling the job's spawn_and_equip proc
job_optionsWhen set you will be able to choose between the different job options when selecting your role. Associated list. Main list elements - actual options, associated values - shorthands for job preferences menu (keep those short).
loadout_pointsHow many points people with this role selected get to pick from
minimum_playtimesIf you have use_timelocks config option enabled, this option will add a requirement for players to have the prerequisite roles have at least x minimum playtime before unlocking.
role_ban_alternativeIf the roleban title needs to be an extra check, like Xenomorphs = Alien.
scaledIf it can be scaled with playercount
selection_classJob Selection span class (for background color)
spawn_positionsHow many players can spawn in as this job
supervisorsSupervisors, who this person answers to directly. Should be a string, shown to the player when they enter the game.
titleThe internal title for the job, used for the job ban system and so forth. Don't change these, change the disp_title instead.
total_positionsHow many players can be this job
total_positions_so_farHow many slots were open in this round. Used to prevent slots locking with decreasing amount of alive players

Procs

can_play_role_in_scenarioWhether the client passes requirements for the scenario
filter_job_optionIntended to be overwritten to handle any requirements for specific job variations that can be selected
get_active_player_on_jobReturns the active player on this job, specifically for singleton jobs
handle_job_optionsIntended to be overwritten to handle when a job has variants that can be selected.
load_loadoutIf we have one, equip our mob with their job gear
on_cryoCalled when the job owner enters deep cryogenic storage

Var Details

allow_additional

Can admins modify positions to it

current_positions

How many players have this job

disp_title

Determined on new(). Usually the same as the title, but doesn't have to be. Set this to override what the player sees in the game as their title.

faction_menu

Under what faction menu the job gets displayed in lobby

flags_startup_parameters

These flags are used to determine how to load the role, and some other parameters.

flags_whitelist

Only used by whitelisted roles. Can be a single whitelist flag, or a combination of them.

gear_preset

Gear preset name used for this job

gear_preset_whitelist

Gear preset name used for council snowflakes ;)

gets_emergency_kit

If TRUE, this job will spawn w/ a cryo emergency kit during evac/red alert

handle_spawn_and_equip

When set to true, SSticker won't call spawn_in_player, instead calling the job's spawn_and_equip proc

job_options

When set you will be able to choose between the different job options when selecting your role. Associated list. Main list elements - actual options, associated values - shorthands for job preferences menu (keep those short).

loadout_points

How many points people with this role selected get to pick from

minimum_playtimes

If you have use_timelocks config option enabled, this option will add a requirement for players to have the prerequisite roles have at least x minimum playtime before unlocking.

role_ban_alternative

If the roleban title needs to be an extra check, like Xenomorphs = Alien.

scaled

If it can be scaled with playercount

selection_class

Job Selection span class (for background color)

spawn_positions

How many players can spawn in as this job

supervisors

Supervisors, who this person answers to directly. Should be a string, shown to the player when they enter the game.

title

The internal title for the job, used for the job ban system and so forth. Don't change these, change the disp_title instead.

total_positions

How many players can be this job

total_positions_so_far

How many slots were open in this round. Used to prevent slots locking with decreasing amount of alive players

Proc Details

can_play_role_in_scenario

Whether the client passes requirements for the scenario

filter_job_option

Intended to be overwritten to handle any requirements for specific job variations that can be selected

get_active_player_on_job

Returns the active player on this job, specifically for singleton jobs

handle_job_options

Intended to be overwritten to handle when a job has variants that can be selected.

load_loadout

If we have one, equip our mob with their job gear

on_cryo

Called when the job owner enters deep cryogenic storage