market_item

Vars
abstract_path	Used to exclude abstract/special paths from the unit test if the value matches the type itself.
availability_prob	Probability for this item to be available. Used by SSmarket on init.
category	The category this item belongs to, should be already declared in the market that this item is accessible in.
desc	Description for the item entry used in the uplink.
html_icon	If set, this icon will be shown in the UI.
identifier	The identifier for the market item, generated on runtime and used to access them in the market categories.
item	Path to or the item itself what this entry is for, this should be set even if you override spawn_item to spawn your item.
markets	"/datum/market"s that this item should be in, used by SSmarket on init.
name	Name for the item entry used in the uplink.
price	Price for the item, if not set creates a price according to the _min and _max vars.
price_max	Maximum price for the item if generated randomly.
price_min	Minimum price for the item if generated randomly.
restockable	Can this item be restocked
shipping_override	If set, these will override the shipment methods set by the market
stock	How many of this type of item is available, if not set creates a price according to the _min and _max vars.
stock_max	Maximum amount that there should be of this item in the market if generated randomly.
stock_min	Minimum amount that there should be of this item in the market if generated randomly. This defaults to 1 as most items will have it as 1.
Procs
buy	Buys the item and makes SSmarket handle it.
set_item	For 'dynamic' market items generated on runtime, this proc is to be used to properly sets the item, especially if it's a hardref.
spawn_item	Used for spawning the wanted item, override if you need to do something special with the item.

Var Details

var
abstract_path
–

Used to exclude abstract/special paths from the unit test if the value matches the type itself.

var
availability_prob
–

Probability for this item to be available. Used by SSmarket on init.

var
category
–

The category this item belongs to, should be already declared in the market that this item is accessible in.

var
desc
–

Description for the item entry used in the uplink.

var
html_icon
–

If set, this icon will be shown in the UI.

var
identifier
–

The identifier for the market item, generated on runtime and used to access them in the market categories.

var
item
– /atom/movable

Path to or the item itself what this entry is for, this should be set even if you override spawn_item to spawn your item.

var
markets
– /list

"/datum/market"s that this item should be in, used by SSmarket on init.

var
name
–

Name for the item entry used in the uplink.

var
price
–

Price for the item, if not set creates a price according to the *_min and *_max vars.

var
price_max
–

Maximum price for the item if generated randomly.

var
price_min
–

Minimum price for the item if generated randomly.

var
restockable
–

Can this item be restocked

var
shipping_override
– /list

If set, these will override the shipment methods set by the market

var
stock
–

How many of this type of item is available, if not set creates a price according to the *_min and *_max vars.

var
stock_max
–

Maximum amount that there should be of this item in the market if generated randomly.

var
stock_min
–

Minimum amount that there should be of this item in the market if generated randomly. This defaults to 1 as most items will have it as 1.

Proc Details

proc
buy
(/obj/item/market_uplink/uplink, /mob/buyer, shipping_method, legal_status)

Buys the item and makes SSmarket handle it.

@param uplink The uplink that is buying the item. @param buyer The mob that is buying the item. @param shipping_method The shipping method used to get the market item onto the station. @param legal_status The legal status of the market. Determines if the item to be spawned is contraband.

proc
set_item
(path_or_ref)

For 'dynamic' market items generated on runtime, this proc is to be used to properly sets the item, especially if it's a hardref.

proc
spawn_item
(loc, /datum/market_purchase/purchase)

Used for spawning the wanted item, override if you need to do something special with the item.

market_item /datum/market_item

Vars

Procs

Var Details

var abstract_path –

var availability_prob –

var category –

var desc –

var html_icon –

var identifier –

var item – /atom/movable

var markets – /list

var name –

var price –

var price_max –

var price_min –

var restockable –

var shipping_override – /list

var stock –

var stock_max –

var stock_min –