uplink_handler

Uplink Handler

The uplink handler, used to handle a traitor's TC and experience points and the uplink UI.

Vars
active_objectives	Current objectives taken
assigned_role	The role that this uplink handler is associated to.
assigned_species	The species this uplink handler is associated to.
can_replace_objectives	Callback which returns true if you can choose to replace your objectives with different ones
can_take_objectives	Whether this uplink handler can TAKE objectives.
completed_objectives	Objectives that have been completed.
contractor_hub	Reference to a contractor hub that the infiltrator can run, if they purchase it.
debug_mode	Whether this is in debug mode or not. If in debug mode, allows all purchases. Bypasses the shop lock.
extra_purchasable	Extra stuff that can be purchased by an uplink, regardless of flag.
final_objective	Text of the final objective, once assigned. Used for uplink data and traitor greentext. Empty string means not yet reached.
has_objectives	Whether this uplink handler has objectives.
has_progression	This uplink has progression
item_stock	Associative array of stock keys = stock left. For items that don't share stock, the key is their typepath
maximum_active_objectives	The maximum number of objectives that can be taken
maximum_potential_objectives	The maximum number of potential objectives that can exist.
owner	The owner of this uplink handler.
potential_duplicate_objectives	All objectives assigned by type to handle any duplicates
potential_objectives	Potential objectives that can be taken
primary_objectives	Objectives that must be completed for traitor greentext. Set by the traitor datum.
progression_points	The amount of experience points this traitor has
purchase_log	The purchase log of this uplink handler
replace_objectives	Callback which performs that operation
shop_locked	Whether the shop is locked or not. If set to true, nothing can be purchased.
telecrystals	The amount of telecrystals contained in this traitor has
uplink_flag	The current uplink flag of this uplink
Procs
add_telecrystals	Helper to add telecrystals to the uplink handler, calling set_telecrystals.
check_if_restricted	Checks for uplink flags as well as items restricted to roles and species
complete_objective	Used to complete objectives, failed or successful.
generate_objectives	Generates objectives for this uplink handler
on_update	Called whenever an update occurs on this uplink handler. Used for UIs
set_telecrystals	Sets how many telecrystals the uplink handler has, then updates the UI for any players watching.
update_objectives	Updates the objectives on the uplink and deletes

Var Details

var
active_objectives
– /list

Current objectives taken

var
assigned_role
–

The role that this uplink handler is associated to.

var
assigned_species
–

The species this uplink handler is associated to.

var
can_replace_objectives
– /datum/callback

Callback which returns true if you can choose to replace your objectives with different ones

var
can_take_objectives
–

Whether this uplink handler can TAKE objectives.

var
completed_objectives
– /list

Objectives that have been completed.

var
contractor_hub
– /datum/contractor_hub

Reference to a contractor hub that the infiltrator can run, if they purchase it.

var
debug_mode
–

Whether this is in debug mode or not. If in debug mode, allows all purchases. Bypasses the shop lock.

var
extra_purchasable
– /list

Extra stuff that can be purchased by an uplink, regardless of flag.

var
final_objective
–

Text of the final objective, once assigned. Used for uplink data and traitor greentext. Empty string means not yet reached.

var
has_objectives
–

Whether this uplink handler has objectives.

var
has_progression
–

This uplink has progression

var
item_stock
– /list

Associative array of stock keys = stock left. For items that don't share stock, the key is their typepath

var
maximum_active_objectives
–

The maximum number of objectives that can be taken

var
maximum_potential_objectives
–

The maximum number of potential objectives that can exist.

var
owner
– /datum/mind

The owner of this uplink handler.

var
potential_duplicate_objectives
– /list

All objectives assigned by type to handle any duplicates

var
potential_objectives
– /list

Potential objectives that can be taken

var
primary_objectives
– /list

Objectives that must be completed for traitor greentext. Set by the traitor datum.

var
progression_points
–

The amount of experience points this traitor has

var
purchase_log
– /datum/uplink_purchase_log

The purchase log of this uplink handler

var
replace_objectives
– /datum/callback

Callback which performs that operation

var
shop_locked
–

Whether the shop is locked or not. If set to true, nothing can be purchased.

var
telecrystals
–

The amount of telecrystals contained in this traitor has

var
uplink_flag
–

The current uplink flag of this uplink

Proc Details

proc
add_telecrystals
(amount)

Helper to add telecrystals to the uplink handler, calling set_telecrystals.

proc
check_if_restricted
(/datum/uplink_item/to_purchase)

Checks for uplink flags as well as items restricted to roles and species

proc
complete_objective
(/datum/traitor_objective/to_remove)

Used to complete objectives, failed or successful.

proc
generate_objectives
()

Generates objectives for this uplink handler

proc
on_update
()

Called whenever an update occurs on this uplink handler. Used for UIs

proc
set_telecrystals
(amount)

Sets how many telecrystals the uplink handler has, then updates the UI for any players watching.

proc
update_objectives
()

Updates the objectives on the uplink and deletes

uplink_handler /datum/uplink_handler

Vars

Procs

Var Details

var active_objectives – /list

var assigned_role –

var assigned_species –

var can_replace_objectives – /datum/callback

var can_take_objectives –

var completed_objectives – /list

var contractor_hub – /datum/contractor_hub

var debug_mode –

var extra_purchasable – /list

var final_objective –

var has_objectives –

var has_progression –

var item_stock – /list

var maximum_active_objectives –

var maximum_potential_objectives –

var owner – /datum/mind

var potential_duplicate_objectives – /list

var potential_objectives – /list

var primary_objectives – /list

var progression_points –

var purchase_log – /datum/uplink_purchase_log

var replace_objectives – /datum/callback

var shop_locked –

var telecrystals –

var uplink_flag –