Paradise Station 13 - Modules - TypesVar Details - Proc Details

Syndicate Contract

Describes a contract that can be completed by a Contractor.

Vars

chosen_difficultyThe selected difficulty.
completed_timeFormatted station time at which the contract was completed, if applicable.
contractThe /datum/objective/contract associated to this contract.
credits_baseThe base credits reward upon completion. Multiplied by the two lower bounds below.
dead_extractionWhether the contract was completed with the victim being dead on extraction.
extraction_cooldownCooldown before making another extraction request in deciseconds.
extraction_deadlineThe world.time at which the current extraction fulton will vanish and another extraction can be requested.
extraction_flareThe flare indicating the extraction point.
extraction_portalThe extraction portal.
extraction_timer_handleDeadline reached timer handle. Deletes the portal and tells the agent to call extraction again.
fail_reasonVisual reason as to why the contract failed, if applicable.
fluff_messageFluff message explaining why the kidnapee is the target.
nt_am_board_resignedWhether the additional fluff story from any contractor completing all of their contracts was made already or not.
owning_hubThe owning contractor hub.
portal_durationHow long an extraction portal remains before going away. Should be less than /datum/syndicate_contract/var/extraction_cooldown.
prison_timeHow long a target remains in the Syndicate jail.
prisoner_timer_handlePrisoner jail timer handle. On completion, returns the prisoner back to station.
reward_creditsAmount of credits the contractor will receive upon completion.
reward_tcAmount of telecrystals the contract will receive upon completion, depending on the chosen difficulty. Structure: EXTRACTION_DIFFICULTY_(EASY|MEDIUM|HARD) => number
souvenirsList of items a target can get randomly after their return.
statusCurrent contract status.
target_nameName of the target to display on the UI.
target_photoThe target's photo to display on the UI.
temp_objsTemporary objects that are available to the kidnapee during their time in jail. These are deleted when the victim is returned.
victim_belongingsThe kidnapee's belongings. Set upon extraction by the contractor.

Procs

clean_upCleans up the contract.
completeMarks the contract as completed and gives the rewards to the contractor.
deadline_reachedCalled when the extraction window closes.
failMarks the contract as failed and stops it.
generateFills the contract with valid data to be used.
handle_target_experienceHandles the target's experience from extraction.
handle_target_returnHandles the target's return to station.
initiateBegins the contract if possible.
invalidateMarks the contract as invalid and effectively cancels it for later use.
notify_completionNotifies the uplink's holder that a contract has been completed.
open_extraction_portalOpens the extraction portal.
start_extraction_processInitiates the extraction process if conditions are met.
target_receivedCalled when a contract target has been extracted through the portal.

Var Details

chosen_difficulty

The selected difficulty.

completed_time

Formatted station time at which the contract was completed, if applicable.

contract

The /datum/objective/contract associated to this contract.

credits_base

The base credits reward upon completion. Multiplied by the two lower bounds below.

dead_extraction

Whether the contract was completed with the victim being dead on extraction.

extraction_cooldown

Cooldown before making another extraction request in deciseconds.

extraction_deadline

The world.time at which the current extraction fulton will vanish and another extraction can be requested.

extraction_flare

The flare indicating the extraction point.

extraction_portal

The extraction portal.

extraction_timer_handle

Deadline reached timer handle. Deletes the portal and tells the agent to call extraction again.

fail_reason

Visual reason as to why the contract failed, if applicable.

fluff_message

Fluff message explaining why the kidnapee is the target.

nt_am_board_resigned

Whether the additional fluff story from any contractor completing all of their contracts was made already or not.

owning_hub

The owning contractor hub.

portal_duration

How long an extraction portal remains before going away. Should be less than /datum/syndicate_contract/var/extraction_cooldown.

prison_time

How long a target remains in the Syndicate jail.

prisoner_timer_handle

Prisoner jail timer handle. On completion, returns the prisoner back to station.

reward_credits

Amount of credits the contractor will receive upon completion.

reward_tc

Amount of telecrystals the contract will receive upon completion, depending on the chosen difficulty. Structure: EXTRACTION_DIFFICULTY_(EASY|MEDIUM|HARD) => number

souvenirs

List of items a target can get randomly after their return.

status

Current contract status.

target_name

Name of the target to display on the UI.

target_photo

The target's photo to display on the UI.

temp_objs

Temporary objects that are available to the kidnapee during their time in jail. These are deleted when the victim is returned.

victim_belongings

The kidnapee's belongings. Set upon extraction by the contractor.

Proc Details

clean_up

Cleans up the contract.

complete

Marks the contract as completed and gives the rewards to the contractor.

Arguments:

deadline_reached

Called when the extraction window closes.

fail

Marks the contract as failed and stops it.

Arguments:

generate

Fills the contract with valid data to be used.

handle_target_experience

Handles the target's experience from extraction.

Arguments:

handle_target_return

Handles the target's return to station.

Arguments:

initiate

Begins the contract if possible.

Arguments:

invalidate

Marks the contract as invalid and effectively cancels it for later use.

notify_completion

Notifies the uplink's holder that a contract has been completed.

Arguments:

open_extraction_portal

Opens the extraction portal.

Arguments:

start_extraction_process

Initiates the extraction process if conditions are met.

Arguments:

target_received

Called when a contract target has been extracted through the portal.

Arguments: