traitor_objective

A traitor objective. Traitor objectives should not be deleted after they have been created and established, only failed. If a traitor objective needs to be removed from the failed/completed objective list of their handler, then you are doing something wrong and you should reconsider. When an objective is failed/completed, that is final and the only way you can change that is by refactoring the code.

Vars
abstract_type	Abstract type that won't be included as a possible objective
description	The description of the traitor objective
duplicate_type	The duplicate type that will be used to check for duplicates. If undefined, this will either take from the abstract type or the type of the objective itself
forced	Whether this objective was forced upon by an admin. Won't get autocleared by the traitor subsystem if progression surpasses an amount
global_progression_deviance_required	Determines how great the deviance has to be before progression starts to get reduced.
global_progression_influence_intensity	Determines how influential global progression will affect this objective. Set to 0 to disable.
global_progression_limit_coeff	Determines the minimum and maximum progression this objective can be worth as a result of being influenced by global progression Should only be smaller than or equal to 1
handler	The uplink handler holder to give the progression and telecrystals to.
name	The name of the traitor objective
needs_reward	Used only in unit testing. Can be used to explicitly skip the progression_reward and telecrystal_reward check for non-abstract objectives. Useful for final objectives as they don't need a reward.
objective_state	The current state of this objective
original_progression	The percentage that this objective has been increased or decreased by as a result of progression. Used by the UI
progression_cost_coeff	This gets added onto the coeff when calculating the updated progression cost. Used for variability and a slight bit of randomness
progression_cost_coeff_deviance	The deviance coefficient used to determine the randomness of the progression rewards.
progression_maximum	The maximum progression before this objective cannot appear anymore
progression_minimum	The minimum required progression points for this objective
progression_reward	The progression that is rewarded from completing this traitor objective. Can either be a list of list(min, max) or a direct value
skipped	Whether this objective was skipped by going from an inactive state to a failed state.
telecrystal_penalty	TC penalty for failing an objective or cancelling it
telecrystal_reward	The telecrystals that are rewarded from completing this traitor objective. Can either be a list of list(min,max) or a direct value
time_of_completion	The time at which this objective was completed
time_of_creation	The time at which this objective was first created
Procs
can_generate_objective	Called whenever the objective is about to be generated. Bypassed by forcefully adding objectives. Returning false or true will do the same as the generate_objective proc.
completion_payout	Called when rewards should be given to the user.
fail_objective	Used to fail objectives. Players can clear completed objectives in the UI
finish_objective	Called by player input, do not call directly. Validates whether the objective is finished and pays out the handler if it is.
generate_objective	Called when the objective should be generated. Should return if the objective has been successfully generated. If false is returned, the objective will be removed as a potential objective for the traitor it is being generated for. This is only temporary, it will run the proc again when objectives are generated for the traitor again.
generate_ui_buttons	Used for generating the UI buttons for the UI. Use ui_perform_action to respond to clicks.
handle_cleanup	Used to handle cleaning up the objective.
replace_in_name	Replaces a word in the name of the proc. Also does it for the description
succeed_objective	Used to succeed objectives. Allows the player to cash it out in the UI.
supported_configuration_changes	Returns a list of variables that can be changed by config, allows for balance through configuration. It is not recommended to finetweak any values of objectives on your server.
to_debug_string	Converts the type into a useful debug string to be used for logging and debug display.
ui_perform_action	Return TRUE to trigger a UI update
ungenerate_objective	Used to clean up signals and stop listening to states.
update_progression_reward	Updates the progression reward, scaling it depending on their current progression compared against the global progression
uplink_ui_data	Used for sending data to the uplink UI

Var Details

var
abstract_type
–

Abstract type that won't be included as a possible objective

var
description
–

The description of the traitor objective

var
duplicate_type
–

The duplicate type that will be used to check for duplicates. If undefined, this will either take from the abstract type or the type of the objective itself

var
forced
–

Whether this objective was forced upon by an admin. Won't get autocleared by the traitor subsystem if progression surpasses an amount

var
global_progression_deviance_required
–

Determines how great the deviance has to be before progression starts to get reduced.

var
global_progression_influence_intensity
–

Determines how influential global progression will affect this objective. Set to 0 to disable.

var
global_progression_limit_coeff
–

Determines the minimum and maximum progression this objective can be worth as a result of being influenced by global progression Should only be smaller than or equal to 1

var
handler
– /datum/uplink_handler

The uplink handler holder to give the progression and telecrystals to.

var
name
–

The name of the traitor objective

var
needs_reward
–

Used only in unit testing. Can be used to explicitly skip the progression_reward and telecrystal_reward check for non-abstract objectives. Useful for final objectives as they don't need a reward.

var
objective_state
–

The current state of this objective

var
original_progression
–

The percentage that this objective has been increased or decreased by as a result of progression. Used by the UI

var
progression_cost_coeff
–

This gets added onto the coeff when calculating the updated progression cost. Used for variability and a slight bit of randomness

var
progression_cost_coeff_deviance
–

The deviance coefficient used to determine the randomness of the progression rewards.

var
progression_maximum
–

The maximum progression before this objective cannot appear anymore

var
progression_minimum
–

The minimum required progression points for this objective

var
progression_reward
–

The progression that is rewarded from completing this traitor objective. Can either be a list of list(min, max) or a direct value

var
skipped
–

Whether this objective was skipped by going from an inactive state to a failed state.

var
telecrystal_penalty
–

TC penalty for failing an objective or cancelling it

var
telecrystal_reward
–

The telecrystals that are rewarded from completing this traitor objective. Can either be a list of list(min,max) or a direct value

var
time_of_completion
–

The time at which this objective was completed

var
time_of_creation
–

The time at which this objective was first created

Proc Details

proc
can_generate_objective
(/datum/mind/generating_for, /list/possible_duplicates)

Called whenever the objective is about to be generated. Bypassed by forcefully adding objectives. Returning false or true will do the same as the generate_objective proc.

proc
completion_payout
()

Called when rewards should be given to the user.

proc
fail_objective
(penalty_cost, trigger_update)

Used to fail objectives. Players can clear completed objectives in the UI

proc
finish_objective
(/mob/user)

Called by player input, do not call directly. Validates whether the objective is finished and pays out the handler if it is.

proc
generate_objective
(/datum/mind/generating_for, /list/possible_duplicates)

Called when the objective should be generated. Should return if the objective has been successfully generated. If false is returned, the objective will be removed as a potential objective for the traitor it is being generated for. This is only temporary, it will run the proc again when objectives are generated for the traitor again.

proc
generate_ui_buttons
(/mob/user)

Used for generating the UI buttons for the UI. Use ui_perform_action to respond to clicks.

proc
handle_cleanup
()

Used to handle cleaning up the objective.

proc
replace_in_name
(replace, word)

Replaces a word in the name of the proc. Also does it for the description

proc
succeed_objective
()

Used to succeed objectives. Allows the player to cash it out in the UI.

proc
supported_configuration_changes
()

Returns a list of variables that can be changed by config, allows for balance through configuration. It is not recommended to finetweak any values of objectives on your server.

proc
to_debug_string
()

Converts the type into a useful debug string to be used for logging and debug display.

proc
ui_perform_action
(/mob/user, action)

Return TRUE to trigger a UI update

proc
ungenerate_objective
()

Used to clean up signals and stop listening to states.

proc
update_progression_reward
()

Updates the progression reward, scaling it depending on their current progression compared against the global progression

proc
uplink_ui_data
(/mob/user)

Used for sending data to the uplink UI

traitor_objective /datum/traitor_objective

Vars

Procs

Var Details

var abstract_type –

var description –

var duplicate_type –

var forced –

var global_progression_deviance_required –

var global_progression_influence_intensity –

var global_progression_limit_coeff –

var handler – /datum/uplink_handler

var name –

var needs_reward –

var objective_state –

var original_progression –

var progression_cost_coeff –

var progression_cost_coeff_deviance –

var progression_maximum –

var progression_minimum –

var progression_reward –

var skipped –

var telecrystal_penalty –

var telecrystal_reward –

var time_of_completion –

var time_of_creation –