vending

Vars
active	No sales pitches if off
ads_list	List of ads to display in UI. Built from `slogan_list` upon Iniitialize()
aggressive	If the vendor should tip on anyone who walks by. Mainly used for brand intelligence
all_possible_crits	All possible crits that could be applied. We only need to build this up once
all_products_free	If this is set to TRUE, all products sold by the vending machine are free (cost nothing). If unset, this will get automatically set to TRUE during init if the machine originates from off-station during mapload. Defaults to null, set it to TRUE or FALSE explicitly on a per-machine basis if you want to force it to be a certain value.
broken_lightmask_overlay	Special lightmask for broken overlay. If vendor is BROKEN, but not dePOWERED we will see this, instead of `lightmask_overlay`.
broken_overlay	Damage overlay applied if vendor is damaged enough.
contraband	List of products this machine sells when you hack it
credits_contained	How many credits does this vending machine have? 20% of all sales go to this pool, and are given freely when the machine is restocked, or successfully tilted. Lost on deconstruction.
crit_damage_factor	Factor of extra damage to deal when triggering a crit
currently_vending	Item currently being bought
default_premium_price	Default price of premium items if not overridden
default_price	Default price of items if not overridden
deny_lightmask	Special lightmask that will override default `lightmask_overlay`, while machine is denying its wares.
deny_overlay	Overlay applied when machine is denying its wares.
deny_overlay_time	Amount of time until denying sequence is reseted.
extended_inventory	can we access the hidden inventory?
flick_sequence	Flags used to correctly manipulate with vend/deny sequences.
flickering	blocks further flickering while true
force_no_power_icon_state	do I look unpowered, even when powered?
hit_warning_cooldown_length	How long to wait before resetting the warning cooldown
inserted_item	the actual item inserted
item_slot	boolean, whether this vending machine can accept people inserting items into it, used for coffee vendors
last_hit_time	Cooldown for warning cooldowns
last_slogan	When did we last pitch?
lightmask_overlay	Lightmask used when vendor is working properly.
num_shards	number of shards to apply when a crit embeds
onstation	Is this item on station or not
onstation_override	DO NOT APPLY THIS GLOBALLY. For mapping var edits only. A variable to change on a per instance basis that allows the instance to avoid having onstation set for them during mapload. Setting this to TRUE means that the vending machine is treated as if it were still onstation if it spawns off-station during mapload. Useful to specify an off-station machine that will be affected by machine-brand intelligence for whatever reason.
panel_overlay	Overlay of vendor maintenance panel.
possible_crits	Possible crit effects from this vending machine tipping.
premium	List of premium products this machine sells
product_categories	List of products this machine sells, categorized. Can only be used as an alternative to `products`, not alongside it. Be aware that categories will be inherited by children object, and will override it's `products` list if children's categories aren't set to `null`.
products	List of products this machine sells
refill_canister	The type of refill canisters used by this machine.
scan_id	If true, enforce access checks on customers. Disabled by messing with wires.
screen_overlay	Overlay of a vendor screen, will not apply of stat is NOPOWER.
seconds_electrified	Allows people to access a vendor that's normally access restricted. Shocks people like an airlock
self_knockover_factor	Factor of extra damage to deal when you knock it over onto yourself
shoot_chance	How often are we firing the items? (prob(...))
shoot_inventory	Fire items at customers! We're broken!
shoot_speed	How hard are we firing the items?
shut_up	If true, prevent saying sales pitches
skip_non_primary_icon_updates	If `TRUE` machine will only react to BROKEN/NOPOWER stat, when updating overlays.
slogan_delay	How long until we can pitch again?
slogan_list	List of ads the vendor will say time to time.
squish_damage	Amount of damage to deal when tipped
tiltable	If this vending machine can be tipped or not
tilted	If this vendor is currently tipped
tilted_rotation	If tilted, this variable should always be the rotation that was applied when we were tilted. Stored for the purposes of unapplying it.
vend_delay	How long vendor takes to vend one item.
vend_lightmask	Special lightmask that will override default `lightmask_overlay`, while machine is vending goods.
vend_overlay	Overlay applied when machine is vending goods.
vend_overlay_time	Amount of time until vending sequence is reseted.
vend_ready	If off, vendor is busy and unusable until current action finishes
vend_reply	"Спас+ибо за пок+упку!" type phrases, which are said when someone buys something.
Procs
Initialize	Initialize the vending machine
RefreshParts	Better would be to make constructable child
build_inventories	Builds all available inventories for the vendor - standard, contraband and premium Arguments: start_empty - bool to pass into build_inventory that determines whether a product entry starts with available stock or not
build_inventory	Build the inventory of the vending machine from it's product and record lists
build_products_from_categories	Populates list of products with categorized products
choose_crit	Select a random valid crit.
create_categories_from	Returns a list of data about the category Arguments: name - string for the name of the category icon - string for the fontawesome icon to use in the UI for the category products - list of products available in the category
deploy_credits	Drop credits when the vendor is attacked.
do_vend	Override this proc to add handling for what to do with the vended product when you have a inserted item and remember to include a parent call for this generic handling
freebie	Dispenses free items from the standard stock. Arguments: freebies - number of free items to vend
item_slot_check	Override this proc to do per-machine checks on the inserted item, but remember to call the parent to handle these generic checks before your logic!
power_change	Intentionally leaving out a case for zero credits as it should be covered by the vending machine's stock being full, or covered by first case if items were returned.
refill_inventory	Refill our inventory from the passed in product list into the record list
restock	Refill a vending machine from a refill canister
tilt	Tilts the machine onto the atom passed in.
unbuild_inventory	Given a record list, go through and and return a list of type -> amount
unbuild_inventory_into	Unbuild product_records into categorized product lists to the machine's refill canister. Does not handle contraband/premium products, only standard stock and any other categories used by the vendor(see: ClothesMate). If a product has no category, puts it into standard stock category. Arguments: product_records - list of products of the vendor products - list of products of the refill canister product_categories - list of product categories of the refill canister
update_canister	Set up a refill canister that matches this machines products

Var Details

var
active

No sales pitches if off

var
ads_list
– /list

List of ads to display in UI. Built from slogan_list upon Iniitialize()

var
aggressive

If the vendor should tip on anyone who walks by. Mainly used for brand intelligence

var
all_possible_crits
– /static/list

All possible crits that could be applied. We only need to build this up once

var
all_products_free

If this is set to TRUE, all products sold by the vending machine are free (cost nothing). If unset, this will get automatically set to TRUE during init if the machine originates from off-station during mapload. Defaults to null, set it to TRUE or FALSE explicitly on a per-machine basis if you want to force it to be a certain value.

var
broken_lightmask_overlay

Special lightmask for broken overlay. If vendor is BROKEN, but not dePOWERED we will see this, instead of lightmask_overlay.

var
broken_overlay

Damage overlay applied if vendor is damaged enough.

var
contraband
– /list

List of products this machine sells when you hack it

form should be list(/type/path = amount, /type/path2 = amount2)

var
credits_contained

How many credits does this vending machine have? 20% of all sales go to this pool, and are given freely when the machine is restocked, or successfully tilted. Lost on deconstruction.

var
crit_damage_factor

Factor of extra damage to deal when triggering a crit

var
currently_vending
– /datum/data/vending_product

Item currently being bought

var
default_premium_price

Default price of premium items if not overridden

var
default_price

Default price of items if not overridden

var
deny_lightmask

Special lightmask that will override default lightmask_overlay, while machine is denying its wares.

var
deny_overlay

Overlay applied when machine is denying its wares.

var
deny_overlay_time

Amount of time until denying sequence is reseted.

var
extended_inventory

can we access the hidden inventory?

var
flick_sequence

Flags used to correctly manipulate with vend/deny sequences.

var
flickering

blocks further flickering while true

var
force_no_power_icon_state

do I look unpowered, even when powered?

var
hit_warning_cooldown_length

How long to wait before resetting the warning cooldown

var
inserted_item
– /obj/item

the actual item inserted

var
item_slot

boolean, whether this vending machine can accept people inserting items into it, used for coffee vendors

var
last_hit_time

Cooldown for warning cooldowns

var
last_slogan

When did we last pitch?

var
lightmask_overlay

Lightmask used when vendor is working properly.

var
num_shards

number of shards to apply when a crit embeds

var
onstation

Is this item on station or not

if it doesn't originate from off-station during mapload, all_products_free gets automatically set to TRUE if it was unset previously.

var
onstation_override

DO NOT APPLY THIS GLOBALLY. For mapping var edits only. A variable to change on a per instance basis that allows the instance to avoid having onstation set for them during mapload. Setting this to TRUE means that the vending machine is treated as if it were still onstation if it spawns off-station during mapload. Useful to specify an off-station machine that will be affected by machine-brand intelligence for whatever reason.

var
panel_overlay

Overlay of vendor maintenance panel.

var
possible_crits
– /list

Possible crit effects from this vending machine tipping.

var
premium
– /list

List of premium products this machine sells

form should be list(/type/path = amount, /type/path2 = amount2)

var
product_categories
– /list

List of products this machine sells, categorized. Can only be used as an alternative to products, not alongside it. Be aware that categories will be inherited by children object, and will override it's products list if children's categories aren't set to null.

Form should be list(

"name" = "Category Name",
"icon" = "UI Icon (Font Awesome)",
"products" = list(/type/path = amount, ...), )

var
products
– /list

List of products this machine sells

form should be list(/type/path = amount, /type/path2 = amount2)

var
refill_canister
– /obj/item/vending_refill

The type of refill canisters used by this machine.

var
scan_id

If true, enforce access checks on customers. Disabled by messing with wires.

var
screen_overlay

Overlay of a vendor screen, will not apply of stat is NOPOWER.

var
seconds_electrified

Allows people to access a vendor that's normally access restricted. Shocks people like an airlock

var
self_knockover_factor

Factor of extra damage to deal when you knock it over onto yourself

var
shoot_chance

How often are we firing the items? (prob(...))

var
shoot_inventory

Fire items at customers! We're broken!

var
shoot_speed

How hard are we firing the items?

var
shut_up

If true, prevent saying sales pitches

var
skip_non_primary_icon_updates

If TRUE machine will only react to BROKEN/NOPOWER stat, when updating overlays.

var
slogan_delay

How long until we can pitch again?

var
slogan_list
– /list

List of ads the vendor will say time to time.

var
squish_damage

Amount of damage to deal when tipped

var
tiltable

If this vending machine can be tipped or not

var
tilted

If this vendor is currently tipped

var
tilted_rotation

If tilted, this variable should always be the rotation that was applied when we were tilted. Stored for the purposes of unapplying it.

var
vend_delay

How long vendor takes to vend one item.

var
vend_lightmask

Special lightmask that will override default lightmask_overlay, while machine is vending goods.

var
vend_overlay

Overlay applied when machine is vending goods.

var
vend_overlay_time

Amount of time until vending sequence is reseted.

var
vend_ready

If off, vendor is busy and unusable until current action finishes

var
vend_reply

"Спас+ибо за пок+упку!" type phrases, which are said when someone buys something.

Place "+" before stressed syllables for better Text-to-speech pronunciation.

Proc Details

↑
Initialize
(mapload)

Initialize the vending machine

Builds the vending machine inventory, sets up slogans and other such misc work

This also sets the onstation var to:

FALSE — if the machine was maploaded on a zlevel that doesn't pass the is_station_level check
TRUE — all other cases

RefreshParts
()

Better would be to make constructable child

proc
build_inventories
(start_empty)

Builds all available inventories for the vendor - standard, contraband and premium Arguments: start_empty - bool to pass into build_inventory that determines whether a product entry starts with available stock or not

proc
build_inventory
(/list/productlist, /list/recordlist, /list/categories, start_empty, premium)

Build the inventory of the vending machine from it's product and record lists

This builds up a full set of /datum/data/vending_product from the product list of the vending machine type Arguments:

productlist - the list of products that need to be converted
recordlist - the list containing /datum/data/vending_product datums
categories - account list in the format of product_categories to source category from
startempty - should we set vending_product record amount from the product list (so it's prefilled at roundstart)
premium - Whether the ending products shall have premium or default prices

proc
build_products_from_categories
()

Populates list of products with categorized products

proc
choose_crit
(/mob/living/carbon/victim)

Select a random valid crit.

proc
create_categories_from
(name, icon, products)

Returns a list of data about the category Arguments: name - string for the name of the category icon - string for the fontawesome icon to use in the UI for the category products - list of products available in the category

proc
deploy_credits
()

Drop credits when the vendor is attacked.

proc
do_vend
(/datum/data/vending_product/product_record, /mob/user, /list/greyscale_colors)

Override this proc to add handling for what to do with the vended product when you have a inserted item and remember to include a parent call for this generic handling

proc
freebie
(/mob/user, num_freebies)

Dispenses free items from the standard stock. Arguments: freebies - number of free items to vend

proc
item_slot_check
(/mob/user, /obj/item/I)

Override this proc to do per-machine checks on the inserted item, but remember to call the parent to handle these generic checks before your logic!

power_change
(forced)

Intentionally leaving out a case for zero credits as it should be covered by the vending machine's stock being full, or covered by first case if items were returned.

proc
refill_inventory
(/list/productlist, /list/recordlist)

Refill our inventory from the passed in product list into the record list

Arguments:

productlist - list of types -> amount
recordlist - existing record datums

proc
restock
(/obj/item/vending_refill/canister)

Refill a vending machine from a refill canister

This takes the products from the refill canister and then fills the products, contraband and premium product categories

Arguments:

canister - the vending canister we are refilling from

proc
tilt
(/atom/target_atom, crit, from_combat)

Tilts the machine onto the atom passed in.

Arguments:

target_atom - The thing the machine is falling on top of
crit - if true, some special damage effects might happen.
from_combat - If true, hold off on some of the additional damage and extra effects.

proc
unbuild_inventory
(/list/recordlist)

Given a record list, go through and and return a list of type -> amount

proc
unbuild_inventory_into
(/list/product_records, /list/products, /list/product_categories)

Unbuild product_records into categorized product lists to the machine's refill canister. Does not handle contraband/premium products, only standard stock and any other categories used by the vendor(see: ClothesMate). If a product has no category, puts it into standard stock category. Arguments: product_records - list of products of the vendor products - list of products of the refill canister product_categories - list of product categories of the refill canister

proc
update_canister
()

Set up a refill canister that matches this machines products

This is used when the machine is deconstructed, so the items aren't "lost"

vending /obj/machinery/vending

Vars

Procs

Var Details

var active

var ads_list – /list

var aggressive

var all_possible_crits – /static/list

var all_products_free

var broken_lightmask_overlay

var broken_overlay

var contraband – /list

var credits_contained

var crit_damage_factor

var currently_vending – /datum/data/vending_product

var default_premium_price

var default_price

var deny_lightmask

var deny_overlay

var deny_overlay_time

var extended_inventory

var flick_sequence

var flickering

var force_no_power_icon_state

var hit_warning_cooldown_length

var inserted_item – /obj/item

var item_slot

var last_hit_time

var last_slogan

var lightmask_overlay

var num_shards

var onstation

var onstation_override

var panel_overlay

var possible_crits – /list

var premium – /list

var product_categories – /list

var products – /list

var refill_canister – /obj/item/vending_refill

var scan_id

var screen_overlay

var seconds_electrified

var self_knockover_factor

var shoot_chance

var shoot_inventory

var shoot_speed

var shut_up

var skip_non_primary_icon_updates

var slogan_delay

var slogan_list – /list

var squish_damage

var tiltable

var tilted

var tilted_rotation

var vend_delay

var vend_lightmask

var vend_overlay

var vend_overlay_time

var vend_ready

var vend_reply

Proc Details

↑Initialize(mapload)

RefreshParts()

proc build_inventories(start_empty)

proc build_inventory(/list/productlist, /list/recordlist, /list/categories, start_empty, premium)

proc build_products_from_categories()

proc choose_crit(/mob/living/carbon/victim)

proc create_categories_from(name, icon, products)

proc deploy_credits()

proc do_vend(/datum/data/vending_product/product_record, /mob/user, /list/greyscale_colors)

proc freebie(/mob/user, num_freebies)

proc item_slot_check(/mob/user, /obj/item/I)

power_change(forced)

proc refill_inventory(/list/productlist, /list/recordlist)

proc restock(/obj/item/vending_refill/canister)

proc tilt(/atom/target_atom, crit, from_combat)

proc unbuild_inventory(/list/recordlist)

proc unbuild_inventory_into(/list/product_records, /list/products, /list/product_categories)

proc update_canister()

vending
/obj/machinery/vending

var
active

var
ads_list
– /list

var
aggressive

var
all_possible_crits
– /static/list

var
all_products_free

var
broken_lightmask_overlay

var
broken_overlay

var
contraband
– /list

var
credits_contained

var
crit_damage_factor

var
currently_vending
– /datum/data/vending_product

var
default_premium_price

var
default_price

var
deny_lightmask

var
deny_overlay

var
deny_overlay_time

var
extended_inventory

var
flick_sequence

var
flickering

var
force_no_power_icon_state

var
hit_warning_cooldown_length

var
inserted_item
– /obj/item

var
item_slot

var
last_hit_time

var
last_slogan

var
lightmask_overlay

var
num_shards

var
onstation

var
onstation_override

var
panel_overlay

var
possible_crits
– /list

var
premium
– /list

var
product_categories
– /list

var
products
– /list

var
refill_canister
– /obj/item/vending_refill

var
scan_id

var
screen_overlay

var
seconds_electrified

var
self_knockover_factor

var
shoot_chance

var
shoot_inventory

var
shoot_speed

var
shut_up

var
skip_non_primary_icon_updates

var
slogan_delay

var
slogan_list
– /list

var
squish_damage

var
tiltable

var
tilted

var
tilted_rotation

var
vend_delay

var
vend_lightmask

var
vend_overlay

var
vend_overlay_time

var
vend_ready

var
vend_reply

↑
Initialize
(mapload)

RefreshParts
()

proc
build_inventories
(start_empty)

proc
build_inventory
(/list/productlist, /list/recordlist, /list/categories, start_empty, premium)

proc
build_products_from_categories
()

proc
choose_crit
(/mob/living/carbon/victim)

proc
create_categories_from
(name, icon, products)

proc
deploy_credits
()

proc
do_vend
(/datum/data/vending_product/product_record, /mob/user, /list/greyscale_colors)

proc
freebie
(/mob/user, num_freebies)

proc
item_slot_check
(/mob/user, /obj/item/I)

power_change
(forced)

proc
refill_inventory
(/list/productlist, /list/recordlist)

proc
restock
(/obj/item/vending_refill/canister)

proc
tilt
(/atom/target_atom, crit, from_combat)

proc
unbuild_inventory
(/list/recordlist)

proc
unbuild_inventory_into
(/list/product_records, /list/products, /list/product_categories)

proc
update_canister
()