uplink_item

Uplink Items

Items that can be spawned from an uplink. Can be limited by gamemode.

Vars
cant_discount	Whether this can be discounted or not
category	Category of the uplink
cost	Cost of the item.
cost_override_string	String to be shown instead of the price, e.g for the Random item.
desc	Description of the uplink
discounted	If discounted, is true. Used to send a signal to update reimbursement.
item	Path to the item to spawn.
limited_stock	How many items of this stock can be purchased.
lock_other_purchases	Whether this item locks all other items from being purchased. Used by syndicate balloon and a few other purchases. Can't be purchased if you've already bought other things Uses the purchase log, so items purchased that are not visible in the purchase log will not count towards this. However, they won't be purchasable afterwards.
name	Name of the uplink item
population_minimum	The minimum number of joined players (so not observers) needed for this item to be added to uplinks.
progression_minimum	The minimum amount of progression needed for this item to be added to uplinks.
purchasable_from	A bitfield to represent what uplinks can purchase this item. See [`code/__DEFINES/uplink.dm`].
purchase_log_vis	Whether this purchase is visible in the purchase log.
refund_amount	Amount of TC to refund, in case there's a TC penalty for refunds.
refundable	Whether this item is refundable or not.
restricted	Whether this purchase is restricted or not (VR/Events related)
restricted_roles	If this uplink item is only available to certain roles. Roles are dependent on the frequency chip or stored ID.
restricted_species	The species able to purchase this uplink item.
stock_key	If this value is changed on two items they will share stock, defaults to not sharing stock with any other item
uplink_item_flags	Flags related to if an item will provide illegal tech, or trips contraband detectors once spawned in as an item.
Procs
can_be_bought	For special overrides if an item can be bought or not.
get_discount	Returns by how much percentage do we reduce the price of the selected item
get_discount_value	Receives a traitor discount type value, returns the amount by which we will reduce the price
purchase	Spawns an item and logs its purchase
replace_pin	Used by spawn_item_for_generic_use to replace the pin of a gun with a normal one
spawn_item	Spawns an item in the world
spawn_item_for_generic_use	Used to create the uplink's item for generic use, rather than use by a Syndie specifically Can be used to "de-restrict" some items, such as Nukie guns spawning with Syndicate pins

Var Details

var
cant_discount
–

Whether this can be discounted or not

var
category
– /datum/uplink_category

Category of the uplink

var
cost
–

Cost of the item.

var
cost_override_string
–

String to be shown instead of the price, e.g for the Random item.

var
desc
–

Description of the uplink

var
discounted
–

If discounted, is true. Used to send a signal to update reimbursement.

var
item
–

Path to the item to spawn.

var
limited_stock
–

How many items of this stock can be purchased.

var
lock_other_purchases
–

Whether this item locks all other items from being purchased. Used by syndicate balloon and a few other purchases. Can't be purchased if you've already bought other things Uses the purchase log, so items purchased that are not visible in the purchase log will not count towards this. However, they won't be purchasable afterwards.

var
name
–

Name of the uplink item

var
population_minimum
–

The minimum number of joined players (so not observers) needed for this item to be added to uplinks.

var
progression_minimum
–

The minimum amount of progression needed for this item to be added to uplinks.

var
purchasable_from
–

A bitfield to represent what uplinks can purchase this item. See [code/__DEFINES/uplink.dm].

var
purchase_log_vis
–

Whether this purchase is visible in the purchase log.

var
refund_amount
–

Amount of TC to refund, in case there's a TC penalty for refunds.

var
refundable
–

Whether this item is refundable or not.

var
restricted
–

Whether this purchase is restricted or not (VR/Events related)

var
restricted_roles
– /list

If this uplink item is only available to certain roles. Roles are dependent on the frequency chip or stored ID.

var
restricted_species
– /list

The species able to purchase this uplink item.

var
stock_key
–

If this value is changed on two items they will share stock, defaults to not sharing stock with any other item

var
uplink_item_flags
–

Flags related to if an item will provide illegal tech, or trips contraband detectors once spawned in as an item.

Proc Details

proc
can_be_bought
(/datum/uplink_handler/source)

For special overrides if an item can be bought or not.

proc
get_discount
()

Returns by how much percentage do we reduce the price of the selected item

proc
get_discount_value
(discount_type)

Receives a traitor discount type value, returns the amount by which we will reduce the price

proc
purchase
(/mob/user, /datum/uplink_handler/uplink_handler, /atom/movable/source)

Spawns an item and logs its purchase

proc
replace_pin
(/obj/item/gun/gun_reward)

Used by spawn_item_for_generic_use to replace the pin of a gun with a normal one

proc
spawn_item
(spawn_path, /mob/user, /datum/uplink_handler/uplink_handler, /atom/movable/source)

Spawns an item in the world

proc
spawn_item_for_generic_use
(/mob/user)

Used to create the uplink's item for generic use, rather than use by a Syndie specifically Can be used to "de-restrict" some items, such as Nukie guns spawning with Syndicate pins

uplink_item /datum/uplink_item

Vars

Procs

Var Details

var cant_discount –

var category – /datum/uplink_category

var cost –

var cost_override_string –

var desc –

var discounted –

var item –

var limited_stock –

var lock_other_purchases –

var name –

var population_minimum –

var progression_minimum –

var purchasable_from –

var purchase_log_vis –

var refund_amount –

var refundable –

var restricted –

var restricted_roles – /list

var restricted_species – /list

var stock_key –

var uplink_item_flags –