syndicate_contract

Describes a contract that can be completed by a Contractor.

Vars
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
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.
Procs
clean_up	Cleans up the contract.
complete	Marks the contract as completed and gives the rewards to the contractor.
deadline_reached	Called when the extraction window closes.
default_damage	Default damage if no injury is possible.
fail	Marks the contract as failed and stops it.
generate	Fills the contract with valid data to be used.
handle_target_experience	Handles the target's experience from extraction.
handle_target_return	Handles the target's return to station.
initiate	Begins the contract if possible.
injure_target	Handles the target's injury/interrogation at the Syndicate Jail.
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.
open_extraction_portal	Opens the extraction portal.
start_extraction_process	Initiates the extraction process if conditions are met.
target_received	Called when a contract target has been extracted through the portal.

Var Details

var
chosen_difficulty
–

The selected difficulty.

var
completed_time
–

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

var
contract
– /datum/objective/contract

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

var
credits_base
–

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

var
dead_extraction
–

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

var
extraction_cooldown
–

Cooldown before making another extraction request in deciseconds.

var
extraction_deadline
–

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

var
extraction_flare
– /obj/effect/contractor_flare

The flare indicating the extraction point.

var
extraction_portal
– /obj/effect/portal/advanced/contractor

The extraction portal.

var
extraction_timer_handle
–

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

var
fail_reason
–

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

var
fluff_message
–

Fluff message explaining why the kidnapee is the target.

var
nt_am_board_resigned
– /static

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

var
owning_hub
– /datum/contractor_hub

The owning contractor hub.

var
portal_duration
–

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

var
prison_time
–

How long a target remains in the Syndicate jail.

var
prisoner_timer_handle
–

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

var
reward_credits
–

Amount of credits the contractor will receive upon completion.

var
reward_tc
– /list

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

var
status
–

Current contract status.

var
target_name
–

Name of the target to display on the UI.

var
target_photo
– /image

The target's photo to display on the UI.

var
temp_objs
– /list/obj

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

var
victim_belongings
– /list/obj/item

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

Proc Details

proc
clean_up
()

Cleans up the contract.

proc
complete
(target_dead)

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

Arguments:

target_dead - Whether the target was extracted dead.

proc
deadline_reached
()

Called when the extraction window closes.

proc
default_damage
(/mob/living/M)

Default damage if no injury is possible.

Arguments:

M - The target mob.

proc
fail
(reason)

Marks the contract as failed and stops it.

Arguments:

difficulty - The visual reason as to why the contract failed.

proc
generate
(target_override)

Fills the contract with valid data to be used.

proc
handle_target_experience
(/mob/living/M, /obj/effect/portal/advanced/contractor/P)

Handles the target's experience from extraction.

Arguments:

M - The target mob.
P - The extraction portal.

proc
handle_target_return
(/mob/living/M)

Handles the target's return to station.

Arguments:

M - The target mob.

proc
initiate
(/mob/living/M, difficulty)

Begins the contract if possible.

Arguments:

M - The contractor.
difficulty - The chosen difficulty level.

proc
injure_target
(/mob/living/M)

Handles the target's injury/interrogation at the Syndicate Jail.

Arguments:

M - The target mob.

proc
invalidate
()

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

proc
notify_completion
(tc, creds, target_dead)

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

Arguments:

tc - How many telecrystals they have received.
creds - How many credits they have received.
target_dead - Whether the target was extracted dead.

proc
open_extraction_portal
(/obj/item/contractor_uplink/U, /mob/living/carbon/human/M, /obj/effect/contractor_flare/F)

Opens the extraction portal.

Arguments:

U - The uplink.
M - The contractor.
F - The flare.

proc
start_extraction_process
(/obj/item/contractor_uplink/U, /mob/living/carbon/human/M)

Initiates the extraction process if conditions are met.

Arguments:

M - The contractor.

proc
target_received
(/mob/living/M, /obj/effect/portal/advanced/contractor/P)

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

Arguments:

M - The target mob.
P - The extraction portal.

Syndicate Contract /datum/syndicate_contract

Vars

Procs

Var Details

var chosen_difficulty –

var completed_time –

var contract – /datum/objective/contract

var credits_base –

var dead_extraction –

var extraction_cooldown –

var extraction_deadline –

var extraction_flare – /obj/effect/contractor_flare

var extraction_portal – /obj/effect/portal/advanced/contractor

var extraction_timer_handle –

var fail_reason –

var fluff_message –

var nt_am_board_resigned – /static

var owning_hub – /datum/contractor_hub

var portal_duration –

var prison_time –

var prisoner_timer_handle –

var reward_credits –

var reward_tc – /list

var status –

var target_name –

var target_photo – /image

var temp_objs – /list/obj

var victim_belongings – /list/obj/item

Proc Details

proc clean_up()

proc complete(target_dead)

proc deadline_reached()

proc default_damage(/mob/living/M)

proc fail(reason)

proc generate(target_override)

proc handle_target_experience(/mob/living/M, /obj/effect/portal/advanced/contractor/P)

proc handle_target_return(/mob/living/M)

proc initiate(/mob/living/M, difficulty)

proc injure_target(/mob/living/M)

proc invalidate()

proc notify_completion(tc, creds, target_dead)

proc open_extraction_portal(/obj/item/contractor_uplink/U, /mob/living/carbon/human/M, /obj/effect/contractor_flare/F)

proc start_extraction_process(/obj/item/contractor_uplink/U, /mob/living/carbon/human/M)

proc target_received(/mob/living/M, /obj/effect/portal/advanced/contractor/P)

Syndicate Contract
/datum/syndicate_contract

var
chosen_difficulty
–

var
completed_time
–

var
contract
– /datum/objective/contract

var
credits_base
–

var
dead_extraction
–

var
extraction_cooldown
–

var
extraction_deadline
–

var
extraction_flare
– /obj/effect/contractor_flare

var
extraction_portal
– /obj/effect/portal/advanced/contractor

var
extraction_timer_handle
–

var
fail_reason
–

var
fluff_message
–

var
nt_am_board_resigned
– /static

var
owning_hub
– /datum/contractor_hub

var
portal_duration
–

var
prison_time
–

var
prisoner_timer_handle
–

var
reward_credits
–

var
reward_tc
– /list

var
status
–

var
target_name
–

var
target_photo
– /image

var
temp_objs
– /list/obj

var
victim_belongings
– /list/obj/item

proc
clean_up
()

proc
complete
(target_dead)

proc
deadline_reached
()

proc
default_damage
(/mob/living/M)

proc
fail
(reason)

proc
generate
(target_override)

proc
handle_target_experience
(/mob/living/M, /obj/effect/portal/advanced/contractor/P)

proc
handle_target_return
(/mob/living/M)

proc
initiate
(/mob/living/M, difficulty)

proc
injure_target
(/mob/living/M)

proc
invalidate
()

proc
notify_completion
(tc, creds, target_dead)

proc
open_extraction_portal
(/obj/item/contractor_uplink/U, /mob/living/carbon/human/M, /obj/effect/contractor_flare/F)

proc
start_extraction_process
(/obj/item/contractor_uplink/U, /mob/living/carbon/human/M)

proc
target_received
(/mob/living/M, /obj/effect/portal/advanced/contractor/P)