export

Vars
allow_negative_cost	whether this export can have a negative impact on the cargo budget or not
amount_report_multiplier	The multiplier of the amount sold shown on the report. Useful for exports, such as material, which costs are not strictly per single units sold.
cost	Price per unit of an exported item
exclude_types	Types excluded from export
export_types	Type of the exported object. If none, the export datum is considered base type.
include_subtypes	Set to FALSE to make the datum apply only to a strict type.
k_elasticity	The percentage of an items real price that is earned when selling that item on cargo
k_hit_percentile	The percentage decrease on this exports elasticity per unit of item sold
k_recovery_time	Time taken for this exports elasticity to reach back to 100%
message	Message appended to the sale report
sales_market	Export market that this export applies to. Defaults to EXPORT_MARKET_STATION for items sold to the standard supply shuttle, replacements exist for pirates, etc.
scannable	Set to false if the cost shouldn't be determinable by an export scanner
unit_name	Unit name. Only used in "Received [total_amount] [name]s [message]."
Procs
applies_to	Checks if the item is fit for export datum.
get_base_cost	Returns the cost of 1 unit of the exported item
get_cost	Returns the cost of the xported item i.e. amount * base cost * elasticity if TRUE
sell_object	Calculates the exact export value of the object, while factoring in all the relivant variables.

Var Details

var
allow_negative_cost

whether this export can have a negative impact on the cargo budget or not

var
amount_report_multiplier

The multiplier of the amount sold shown on the report. Useful for exports, such as material, which costs are not strictly per single units sold.

var
cost

Price per unit of an exported item

var
exclude_types
– /list

Types excluded from export

var
export_types
– /list

Type of the exported object. If none, the export datum is considered base type.

var
include_subtypes

Set to FALSE to make the datum apply only to a strict type.

var
k_elasticity

The percentage of an items real price that is earned when selling that item on cargo

var
k_hit_percentile

The percentage decrease on this exports elasticity per unit of item sold

var
k_recovery_time

Time taken for this exports elasticity to reach back to 100%

var
message

Message appended to the sale report

var
sales_market

Export market that this export applies to. Defaults to EXPORT_MARKET_STATION for items sold to the standard supply shuttle, replacements exist for pirates, etc.

var
scannable

Set to false if the cost shouldn't be determinable by an export scanner

var
unit_name

Unit name. Only used in "Received [total_amount] [name]s [message]."

Proc Details

proc
applies_to
(/obj/exported_item, apply_elastic, export_markets)

Checks if the item is fit for export datum.

proc
get_base_cost
(/obj/exported_item)

Returns the cost of 1 unit of the exported item

Arguments

obj/exported_item - the item we whos base cost we are trying to compute

proc
get_cost
(/obj/exported_item, apply_elastic)

Returns the cost of the xported item i.e. amount * base cost * elasticity if TRUE

Arguments

obj/exported_item - the item we are trying to export
apply_elastic - should we use elasticity

proc
sell_object
(/obj/sold_item, /datum/export_report/report, dry_run, apply_elastic)

Calculates the exact export value of the object, while factoring in all the relivant variables.

Called only once, when the object is actually sold by the datum. Adds item's cost and amount to the current export cycle. get_cost, get_amount and applies_to do not neccesary mean a successful sale.

export /datum/export

Vars

Procs

Var Details

var allow_negative_cost

var amount_report_multiplier

var cost

var exclude_types – /list

var export_types – /list

var include_subtypes

var k_elasticity

var k_hit_percentile

var k_recovery_time

var message

var sales_market

var scannable

var unit_name