campaign_mission

Vars
attrition_point_rewards	attrition point rewards for the mission type
cash_rewards	cash rewards for the mission type
draw_reward_table	Possible rewards for a draw, used by Generate_rewards()
game_timer	Timer used to calculate how long till mission ends
game_timer_delay	Delay from shutter drop until game TIMER starts
hostile_faction	faction that did not choose the mission
hostile_faction_additional_rewards	Any additional rewards for the hostile faction, for display purposes
hostile_faction_mission_brief	Detailed mission description for the hostile faction
hostile_faction_mission_parameters	Optional mission parameters for the hostile faction. Some are autopopulated
hostile_faction_objective_description	The victory conditions for this mission for the hostile faction, for display purposes
intro_message	Map text intro message for the start of the mission
major_loss_reward_table	Possible rewards for a major loss, used by Generate_rewards()
major_victory_reward_table	Possible rewards for a major victory, used by Generate_rewards()
map_armor_color	Camo color associated with this map
map_file	path of map for this mission
map_light_colours	Lightings colours for the map. Typically all the same for consistancy, but not required
map_light_levels	Light levels for the map
map_name	map name for this mission
map_traits	map_traits, defaults to ZTRAIT_AWAY
max_game_time	The length of time until mission ends, if timed
max_time_reached	Whether the max game time has been reached
minor_loss_reward_table	Possible rewards for a minor loss, used by Generate_rewards()
minor_victory_reward_table	Possible rewards for a minor victory, used by Generate_rewards()
mission_flags	Any mission behavior flags
mission_icon	UI icon for the mission
mission_start_delay	Delay before the mission actually starts
mission_state	current state of the mission
mission_z_level	The actual z-level the mission is played on
mode	The current gamemode. Var as its referred to often
name	name of the mission
op_name_hostile	Operation name for hostile faction
op_name_starting	Operation name for starting faction
outcome	specific mission outcome
outro_message	Message to players when a mission ends
shutter_open_delay	Optional delay for each faction to be able to deploy, typically used in attacker/defender missions
start_timer	Timer for when the mission starts
starting_faction	faction that chose the mission
starting_faction_additional_rewards	Any additional rewards for the starting faction, for display purposes
starting_faction_mission_brief	Detailed mission description for the starting faction
starting_faction_mission_parameters	Optional mission parameters for the starting faction. Some are autopopulated
starting_faction_objective_description	The victory conditions for this mission for the starting faction, for display purposes
victory_point_rewards	Victory point rewards for the mission type
winning_faction	winning faction of the mission
Procs
Generate_rewards	Generates mission rewards, if there is variability involved
apply_cash_reward	applies mission cash bonuses to both factions
apply_draw	Apply outcomes for draw
apply_major_loss	Apply outcomes for major loss
apply_major_victory	Apply outcomes for major win
apply_minor_loss	Apply outcomes for minor loss
apply_minor_victory	Apply outcomes for minor win
apply_outcome	Applies the correct outcome for the mission
apply_victory_points	gives any victory points earned in the mission
check_mission_progress	Checks mission end criteria, and ends the mission if met
count_humans	checks how many marines and SOM are still alive
drop_blocker_disabled	Handles notification of a dropblocker being disabled
end_mission	Mission end wrap up
get_mission_deploy_message	Get a mission specific message for the deploying user if there is one
get_status_tab_items	Generates status tab info for the mission
load_map	Generates a new z level for the mission
load_mission	Sets up the mission once it has been selected
load_mission_brief	Generates the mission brief for the mission if it needs to be late loaded
load_objective_description	Generates the objective description for the mission if it needs to be late loaded
load_pre_mission_bonuses	Generates any mission specific assets/benefits for the two teams
map_text_broadcast	Sends a maptext message to a specified faction
mission_end_countdown	accesses the timer for status panel
modify_attrition_points	Modifies a faction's attrition points
pause_mission_timer	Pauses the gametimer, recording the remaining time left in max_game_time
play_outro	Outro when the mission is finished
play_selection_intro	Intro when the mission is selected
play_start_intro	Intro when the mission is started
remove_mission_flag	Removes a flag or flags from this mission
remove_mission_object	Removes the object from the campaign_structrures list if they are destroyed mid mission
resume_mission_timer	Attempts to resume the gametimer
set_loot_tables	Sets up the loot tables for this mission, if required
set_mission_timer	sets up the timer for the mission
spawn_mech	spawns mechs for a faction
spawn_tank	spawns mechs for a faction
start_mission	Mission start proper
tele_blocker_disabled	Handles notification of a teleblocker being disabled
unregister_mission_signals	Unregisters all signals when the mission finishes

Var Details

var
attrition_point_rewards
– /list

attrition point rewards for the mission type

var
cash_rewards
– /list

cash rewards for the mission type

var
draw_reward_table
– /list

Possible rewards for a draw, used by Generate_rewards()

var
game_timer
–

Timer used to calculate how long till mission ends

var
game_timer_delay
–

Delay from shutter drop until game TIMER starts

var
hostile_faction
–

faction that did not choose the mission

var
hostile_faction_additional_rewards
–

Any additional rewards for the hostile faction, for display purposes

var
hostile_faction_mission_brief
–

Detailed mission description for the hostile faction

var
hostile_faction_mission_parameters
–

Optional mission parameters for the hostile faction. Some are autopopulated

var
hostile_faction_objective_description
–

The victory conditions for this mission for the hostile faction, for display purposes

var
intro_message
– /list

Map text intro message for the start of the mission

var
major_loss_reward_table
– /list

Possible rewards for a major loss, used by Generate_rewards()

var
major_victory_reward_table
– /list

Possible rewards for a major victory, used by Generate_rewards()

var
map_armor_color
–

Camo color associated with this map

var
map_file
–

path of map for this mission

var
map_light_colours
– /list

Lightings colours for the map. Typically all the same for consistancy, but not required

var
map_light_levels
– /list

Light levels for the map

var
map_name
–

map name for this mission

var
map_traits
– /list

map_traits, defaults to ZTRAIT_AWAY

var
max_game_time
–

The length of time until mission ends, if timed

var
max_time_reached
–

Whether the max game time has been reached

var
minor_loss_reward_table
– /list

Possible rewards for a minor loss, used by Generate_rewards()

var
minor_victory_reward_table
– /list

Possible rewards for a minor victory, used by Generate_rewards()

var
mission_flags
–

Any mission behavior flags

var
mission_icon
–

UI icon for the mission

var
mission_start_delay
–

Delay before the mission actually starts

var
mission_state
–

current state of the mission

var
mission_z_level
– /datum/space_level

The actual z-level the mission is played on

var
mode
– /datum/game_mode/hvh/campaign

The current gamemode. Var as its referred to often

var
name
–

name of the mission

var
op_name_hostile
–

Operation name for hostile faction

var
op_name_starting
–

Operation name for starting faction

var
outcome
–

specific mission outcome

var
outro_message
– /list

Message to players when a mission ends

var
shutter_open_delay
– /list

Optional delay for each faction to be able to deploy, typically used in attacker/defender missions

var
start_timer
–

Timer for when the mission starts

var
starting_faction
–

faction that chose the mission

var
starting_faction_additional_rewards
–

Any additional rewards for the starting faction, for display purposes

var
starting_faction_mission_brief
–

Detailed mission description for the starting faction

var
starting_faction_mission_parameters
–

Optional mission parameters for the starting faction. Some are autopopulated

var
starting_faction_objective_description
–

The victory conditions for this mission for the starting faction, for display purposes

var
victory_point_rewards
– /list

Victory point rewards for the mission type

var
winning_faction
–

winning faction of the mission

Proc Details

proc
Generate_rewards
(reward_amount, faction)

Generates mission rewards, if there is variability involved

proc
apply_cash_reward
(start_team_cash, hostile_team_cash)

applies mission cash bonuses to both factions

proc
apply_draw
()

Apply outcomes for draw

proc
apply_major_loss
()

Apply outcomes for major loss

proc
apply_major_victory
()

Apply outcomes for major win

proc
apply_minor_loss
()

Apply outcomes for minor loss

proc
apply_minor_victory
()

Apply outcomes for minor win

proc
apply_outcome
()

Applies the correct outcome for the mission

proc
apply_victory_points
(start_team_points, hostile_team_points)

gives any victory points earned in the mission

proc
check_mission_progress
()

Checks mission end criteria, and ends the mission if met

proc
count_humans
(/list/z_levels, count_flags)

checks how many marines and SOM are still alive

proc
drop_blocker_disabled
(/obj/blocker, losing_faction)

Handles notification of a dropblocker being disabled

proc
end_mission
()

Mission end wrap up

proc
get_mission_deploy_message
(/mob/living/user, text_source, portrait_to_use, message)

Get a mission specific message for the deploying user if there is one

proc
get_status_tab_items
(/mob/source, /list/items)

Generates status tab info for the mission

proc
load_map
()

Generates a new z level for the mission

proc
load_mission
()

Sets up the mission once it has been selected

proc
load_mission_brief
()

Generates the mission brief for the mission if it needs to be late loaded

proc
load_objective_description
()

Generates the objective description for the mission if it needs to be late loaded

proc
load_pre_mission_bonuses
()

Generates any mission specific assets/benefits for the two teams

proc
map_text_broadcast
(faction, message, title, /atom/movable/screen/text/screen_text/picture/display_picture, sound_effect)

Sends a maptext message to a specified faction

proc
mission_end_countdown
()

accesses the timer for status panel

proc
modify_attrition_points
(start_team_points, hostile_team_points)

Modifies a faction's attrition points

proc
pause_mission_timer
(trait_source)

Pauses the gametimer, recording the remaining time left in max_game_time

proc
play_outro
()

Outro when the mission is finished

proc
play_selection_intro
()

Intro when the mission is selected

proc
play_start_intro
()

Intro when the mission is started

proc
remove_mission_flag
(/datum/source, blocker, removed_flags, losing_faction)

Removes a flag or flags from this mission

proc
remove_mission_object
(/obj/mission_obj)

Removes the object from the campaign_structrures list if they are destroyed mid mission

proc
resume_mission_timer
(trait_source, forced)

Attempts to resume the gametimer

proc
set_loot_tables
()

Sets up the loot tables for this mission, if required

proc
set_mission_timer
()

sets up the timer for the mission

proc
spawn_mech
(mech_faction, heavy_mech, medium_mech, light_mech, override_message)

spawns mechs for a faction

proc
spawn_tank
(tank_faction, quantity, override_message)

spawns mechs for a faction

proc
start_mission
()

Mission start proper

proc
tele_blocker_disabled
(/datum/blocker, losing_faction)

Handles notification of a teleblocker being disabled

proc
unregister_mission_signals
()

Unregisters all signals when the mission finishes

campaign_mission /datum/campaign_mission

Vars

Procs

Var Details

var attrition_point_rewards – /list

var cash_rewards – /list

var draw_reward_table – /list

var game_timer –

var game_timer_delay –

var hostile_faction –

var hostile_faction_additional_rewards –

var hostile_faction_mission_brief –

var hostile_faction_mission_parameters –

var hostile_faction_objective_description –

var intro_message – /list

var major_loss_reward_table – /list

var major_victory_reward_table – /list

var map_armor_color –

var map_file –

var map_light_colours – /list

var map_light_levels – /list

var map_name –

var map_traits – /list

var max_game_time –

var max_time_reached –

var minor_loss_reward_table – /list

var minor_victory_reward_table – /list

var mission_flags –

var mission_icon –

var mission_start_delay –

var mission_state –

var mission_z_level – /datum/space_level

var mode – /datum/game_mode/hvh/campaign

var name –

var op_name_hostile –

var op_name_starting –

var outcome –

var outro_message – /list

var shutter_open_delay – /list

var start_timer –

var starting_faction –

var starting_faction_additional_rewards –

var starting_faction_mission_brief –

var starting_faction_mission_parameters –

var starting_faction_objective_description –

var victory_point_rewards – /list

var winning_faction –