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 | |
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 |
not_enough_reputation | Checks if traitor has enough reputation to purchase an item |
on_update | Called whenever an update occurs on this uplink handler. Used for UIs |
update_objectives | Updates the objectives on the uplink and deletes |
Var Details
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
Proc Details
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
not_enough_reputation
Checks if traitor has enough reputation to purchase an item
on_update
Called whenever an update occurs on this uplink handler. Used for UIs
update_objectives
Updates the objectives on the uplink and deletes