vending

Vars
__typeinfo_path
active	Is the machine active (No sales pitches if off)!
age_restrictions	Whether our age check is currently functional
canload_access_list	ID's that can load this vending machine wtih refills
contained_cash	Money inside us.
contraband	List of products this machine sells when you hack it
default_price	Default price of items if not overridden
discount_access	Access that gets the non-premium content for free
extended_inventory	can we access the hidden inventory?
extra_price	Default price ADDED to the default price of premium items if they don't have one set.
icon_deny	Icon to flash when user is denied a vend
icon_vend	Icon when vending an item to the user
input_display_header	Display header on the input view
last_reply	Last world tick we sent a vent reply
last_shopper	The ref of the last mob to shop with us
last_slogan	Last world tick we sent a slogan message out
light_mask	Name of lighting mask for the vending machine
loaded_items	how many items have been inserted in a vendor
onstation	Is this item on station or not
onstation_override	A variable to change on a per instance basis on the map that allows the instance to force cost and ID requirements
panel_type	Icon for the maintenance panel overlay
premium	List of premium products this machine sells
product_ads	String of small ad messages in the vending screen - random chance
product_slogans	String of slogans separated by semicolons, optional
products	List of products this machine sells
purchase_message_cooldown	Next world time to send a purchase message
scan_id	Are we checking the users ID
seconds_electrified	World ticks the machine is electified for
shoot_inventory	When this is TRUE, we fire items at customers! We're broken!
shoot_inventory_chance	How likely this is to happen (prob 100) per second
slogan_delay	How many ticks until we can send another
small_ads	Small ad messages in the vending screen - random chance of popping up whenever you open it
vend_ready	Are we ready to vend?? Is it time??
vend_reply	Message sent post vend (Thank you for shopping!)
Procs
Initialize	Initialize the vending machine
build_inventory	Build the inventory of the vending machine from it's product and record lists
canLoadItem	Are we able to load the item passed in
can_user_vend	Checks if the user can purchase an item from this machine.
compartmentLoadAccessCheck	Is the passed in user allowed to load this vending machines compartments
complete_vend	Complete the vend.
dispense_cash	Dispense all contained cash to the user.
dispense_item	Dispense the item to the user.
give_or_drop_dispensed_item	It's in the name.
on_cash_moved	Called when contained_cash moves.
pay_for_vend	Pay for the fuckin' item. Returns -1 if the item was unable to be purchased. Otherwise, returns the amount of money spent.
pre_throw	A callback called before an item is tossed out
refill_inventory	Refill our inventory from the passed in product list into the record list
reset_prices	Reassign the prices of the vending machine using the multiplier argument
restock	Refill a vending machine from a refill canister
sanitize_vend	Sanitizes the input of vend().
shock	Shock the passed in user
speak	Speak the given message verbally
thank_shopper	Thank our patron.
throw_impact	Crush the mob that the vending machine got thrown at
throw_item	Throw an item from our internal inventory out in front of us
tilt	Tilts ontop of the atom supplied, if crit is true some extra shit can happen. Returns TRUE if it dealt damage to something.
unbuild_inventory	Given a record list, go through and and return a list of type -> amount
update_canister	Set up a refill canister that matches this machines products
vend	The core vend proc used by normal vendors.
vend_delay_animation	Animation/effects to play while doing a delayed vend. Returns the duration of the animation in deciseconds.

Var Details

↑
__typeinfo_path

vending machines

Captalism in the year 2525, everything in a vending machine, even love

var
active

Is the machine active (No sales pitches if off)!

var
age_restrictions

Whether our age check is currently functional

var
canload_access_list
– /list

ID's that can load this vending machine wtih refills

var
contained_cash
– /obj/item/stack/spacecash

Money inside us.

var
contraband
– /list

List of products this machine sells when you hack it

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

var
default_price

Default price of items if not overridden

var
discount_access
– /list

Access that gets the non-premium content for free

var
extended_inventory

can we access the hidden inventory?

var
extra_price

Default price ADDED to the default price of premium items if they don't have one set.

var
icon_deny

Icon to flash when user is denied a vend

var
icon_vend

Icon when vending an item to the user

var
input_display_header

Display header on the input view

var
last_reply

Last world tick we sent a vent reply

var
last_shopper

The ref of the last mob to shop with us

var
last_slogan

Last world tick we sent a slogan message out

var
light_mask

Name of lighting mask for the vending machine

var
loaded_items

how many items have been inserted in a vendor

var
onstation

Is this item on station or not

if it doesn't originate from off-station during mapload, everything is free

var
onstation_override

A variable to change on a per instance basis on the map that allows the instance to force cost and ID requirements

var
panel_type

Icon for the maintenance panel overlay

var
premium
– /list

List of premium products this machine sells

form should be list(/type/path, /type/path2) as there is only ever one in stock

var
product_ads

String of small ad messages in the vending screen - random chance

var
product_slogans

String of slogans separated by semicolons, optional

var
products
– /list

List of products this machine sells

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

var
purchase_message_cooldown

Next world time to send a purchase message

var
scan_id

Are we checking the users ID

var
seconds_electrified

World ticks the machine is electified for

var
shoot_inventory

When this is TRUE, we fire items at customers! We're broken!

var
shoot_inventory_chance

How likely this is to happen (prob 100) per second

var
slogan_delay

How many ticks until we can send another

var
small_ads
– /list

Small ad messages in the vending screen - random chance of popping up whenever you open it

var
vend_ready

Are we ready to vend?? Is it time??

var
vend_reply

Message sent post vend (Thank you for shopping!)

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

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

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

This builds up a full set of /datum/data/vending_products 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
startempty - should we set vending_product record amount from the product list (so it's prefilled at roundstart)

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

Are we able to load the item passed in

Arguments:

I - the item being loaded
user - the user doing the loading

proc
can_user_vend
(user, silent)

Checks if the user can purchase an item from this machine.

proc
compartmentLoadAccessCheck
(/mob/user)

Is the passed in user allowed to load this vending machines compartments

Arguments:

user - mob that is doing the loading of the vending machine

proc
complete_vend
(/mob/user, /datum/data/vending_product/vend_datum, /list/greyscale_colors)

Complete the vend.

proc
dispense_cash
(/mob/user)

Dispense all contained cash to the user.

proc
dispense_item
(/mob/user, /datum/data/vending_product/vend_datum)

Dispense the item to the user.

proc
give_or_drop_dispensed_item
(/mob/user, /obj/item/vended_item)

It's in the name.

proc
on_cash_moved
(/datum/source)

Called when contained_cash moves.

proc
pay_for_vend
(/mob/vendor, /datum/data/vending_product/vend_datum)

Pay for the fuckin' item. Returns -1 if the item was unable to be purchased. Otherwise, returns the amount of money spent.

proc
pre_throw
(/obj/item/I)

A callback called before an item is tossed out

Override this if you need to do any special case handling

Arguments:

I - obj/item being thrown

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
reset_prices
(/list/recordlist, /list/premiumlist, multiplier)

Reassign the prices of the vending machine using the multiplier argument

This rebuilds both /datum/data/vending_products lists for premium and standard products based on their most relevant pricing values. Arguments:

recordlist - the list of standard product datums in the vendor to refresh their prices.
premiumlist - the list of premium product datums in the vendor to refresh their prices.

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
sanitize_vend
(/mob/user, /datum/data/vending_product/vend_datum)

Sanitizes the input of vend().

proc
shock
(/mob/living/user, prb)

Shock the passed in user

This checks we have power and that the passed in prob is passed, then generates some sparks and calls electrocute_mob on the user

Arguments:

user - the user to shock
prb - probability the shock happens

proc
speak
(message)

Speak the given message verbally

Checks if the machine is powered and the message exists

Arguments:

message - the message to speak

proc
thank_shopper
(/mob/shopper)

Thank our patron.

throw_impact
(/atom/hit_atom, /datum/thrownthing/throwingdatum)

Crush the mob that the vending machine got thrown at

proc
throw_item
()

Throw an item from our internal inventory out in front of us

This is called when we are hacked, it selects a random product from the records that has an amount > 0 This item is then created and tossed out in front of us with a visible message

proc
tilt
(/atom/fatty, crit)

Tilts ontop of the atom supplied, if crit is true some extra shit can happen. Returns TRUE if it dealt damage to something.

proc
unbuild_inventory
(/list/recordlist)

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

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"

proc
vend
(/mob/user, delayed, /datum/data/vending_product/vend_datum, /list/greyscale_colors)

The core vend proc used by normal vendors.

proc
vend_delay_animation
() as num

Animation/effects to play while doing a delayed vend. Returns the duration of the animation in deciseconds.

vending /obj/machinery/vending

Vars

Procs

Var Details

↑__typeinfo_path

vending machines

var active

var age_restrictions

var canload_access_list – /list

var contained_cash – /obj/item/stack/spacecash

var contraband – /list

var default_price

var discount_access – /list

var extended_inventory

var extra_price

var icon_deny

var icon_vend

var input_display_header

var last_reply

var last_shopper

var last_slogan

var light_mask

var loaded_items

var onstation

var onstation_override

var panel_type

var premium – /list

var product_ads

var product_slogans

var products – /list

var purchase_message_cooldown

var scan_id

var seconds_electrified

var shoot_inventory

var shoot_inventory_chance

var slogan_delay

var small_ads – /list

var vend_ready

var vend_reply

Proc Details

↑Initialize(mapload)

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

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

proc can_user_vend(user, silent)

proc compartmentLoadAccessCheck(/mob/user)

proc complete_vend(/mob/user, /datum/data/vending_product/vend_datum, /list/greyscale_colors)

proc dispense_cash(/mob/user)

proc dispense_item(/mob/user, /datum/data/vending_product/vend_datum)

proc give_or_drop_dispensed_item(/mob/user, /obj/item/vended_item)

proc on_cash_moved(/datum/source)

proc pay_for_vend(/mob/vendor, /datum/data/vending_product/vend_datum)

proc pre_throw(/obj/item/I)

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

proc reset_prices(/list/recordlist, /list/premiumlist, multiplier)

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

proc sanitize_vend(/mob/user, /datum/data/vending_product/vend_datum)

proc shock(/mob/living/user, prb)

proc speak(message)

proc thank_shopper(/mob/shopper)

throw_impact(/atom/hit_atom, /datum/thrownthing/throwingdatum)

proc throw_item()

proc tilt(/atom/fatty, crit)

proc unbuild_inventory(/list/recordlist)

proc update_canister()

proc vend(/mob/user, delayed, /datum/data/vending_product/vend_datum, /list/greyscale_colors)

proc vend_delay_animation() as num

vending
/obj/machinery/vending

↑
__typeinfo_path

var
active

var
age_restrictions

var
canload_access_list
– /list

var
contained_cash
– /obj/item/stack/spacecash

var
contraband
– /list

var
default_price

var
discount_access
– /list

var
extended_inventory

var
extra_price

var
icon_deny

var
icon_vend

var
input_display_header

var
last_reply

var
last_shopper

var
last_slogan

var
light_mask

var
loaded_items

var
onstation

var
onstation_override

var
panel_type

var
premium
– /list

var
product_ads

var
product_slogans

var
products
– /list

var
purchase_message_cooldown

var
scan_id

var
seconds_electrified

var
shoot_inventory

var
shoot_inventory_chance

var
slogan_delay

var
small_ads
– /list

var
vend_ready

var
vend_reply

↑
Initialize
(mapload)

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

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

proc
can_user_vend
(user, silent)

proc
compartmentLoadAccessCheck
(/mob/user)

proc
complete_vend
(/mob/user, /datum/data/vending_product/vend_datum, /list/greyscale_colors)

proc
dispense_cash
(/mob/user)

proc
dispense_item
(/mob/user, /datum/data/vending_product/vend_datum)

proc
give_or_drop_dispensed_item
(/mob/user, /obj/item/vended_item)

proc
on_cash_moved
(/datum/source)

proc
pay_for_vend
(/mob/vendor, /datum/data/vending_product/vend_datum)

proc
pre_throw
(/obj/item/I)

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

proc
reset_prices
(/list/recordlist, /list/premiumlist, multiplier)

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

proc
sanitize_vend
(/mob/user, /datum/data/vending_product/vend_datum)

proc
shock
(/mob/living/user, prb)

proc
speak
(message)

proc
thank_shopper
(/mob/shopper)

throw_impact
(/atom/hit_atom, /datum/thrownthing/throwingdatum)

proc
throw_item
()

proc
tilt
(/atom/fatty, crit)

proc
unbuild_inventory
(/list/recordlist)

proc
update_canister
()

proc
vend
(/mob/user, delayed, /datum/data/vending_product/vend_datum, /list/greyscale_colors)

proc
vend_delay_animation
() as num