material_container

Vars
after_insert	A callback invoked after materials are inserted into this container
allowed_item_typecache	The typecache of things that this material container can accept
allowed_materials	The list of materials that this material container can accept
insertion_check	A callback for checking wheter we can insert a material into this container
last_inserted_id	The last main material that was inserted into this container
mat_container_flags	The material container flags. See __DEFINES/materials.dm.
materials	Map of material ref -> amount
max_amount	The maximum amount of materials this material container can contain
precise_insertion	Whether or not this material container allows specific amounts from sheets to be inserted
precondition	A callback invoked before materials are inserted into this container
total_amount	The total amount of materials this material container contains
Procs
Initialize	Sets up the proper signals and fills the list of materials with the appropriate references.
amount2sheet	Turns a material amount into the amount of sheets it should output
can_hold_material	The default check for whether we can add materials to this material container.
can_insert_amount_mat	Proc for checking if there is room in the component, returning the amount or else the amount lacking.
get_categories	Returns all the categories in a recipe.
get_item_material_amount	returns the amount of material relevant to this container; if this container does not support glass, any glass in 'I' will not be taken into account
get_material_amount	Returns the amount of a specific material in this container.
has_enough_of_category	Returns TRUE if you have enough of a specified material category (Which could be multiple materials)
has_enough_of_material	Returns TRUE if you have enough of the specified material.
has_materials	Checks if its possible to afford a certain amount of materials. Takes a dictionary of materials.
has_space	Proc that returns TRUE if the container has space
insert_amount_mat	For inserting an amount of material
insert_item	Proc specifically for inserting items, returns the amount of materials entered.
insert_item_materials	Inserts the relevant materials from an item into this material container.
on_attackby	Proc that allows players to fill the parent with mats
retrieve_all	Proc to get all the materials and dump them as sheets
retrieve_sheets	For spawning mineral sheets at a specific location. Used by machines to output sheets.
sheet2amount	Turns an amount of sheets into the amount of material amount it should output
transer_amt_to	Proc for transfering materials to another container.
ui_data	List format is list(material_name = list(amount = ..., ref = ..., etc.))
use_amount_mat	Uses an amount of a specific material, effectively removing it.
use_materials	For consuming a dictionary of materials. mats is the map of materials to use and the corresponding amounts, example: list(M/datum/material/glass =100, datum/material/iron=200)
user_insert	Proc used for when player inserts materials

Var Details

var
after_insert
– /datum/callback

A callback invoked after materials are inserted into this container

var
allowed_item_typecache
– /list

The typecache of things that this material container can accept

var
allowed_materials
– /list

The list of materials that this material container can accept

var
insertion_check
– /datum/callback

A callback for checking wheter we can insert a material into this container

var
last_inserted_id
–

The last main material that was inserted into this container

var
mat_container_flags
–

The material container flags. See __DEFINES/materials.dm.

var
materials
– /list

Map of material ref -> amount

var
max_amount
–

The maximum amount of materials this material container can contain

var
precise_insertion
–

Whether or not this material container allows specific amounts from sheets to be inserted

var
precondition
– /datum/callback

A callback invoked before materials are inserted into this container

var
total_amount
–

The total amount of materials this material container contains

Proc Details

↑
Initialize
(/list/init_mats, max_amt, _mat_container_flags, /list/allowed_mats, /list/allowed_items, /datum/callback/_insertion_check, /datum/callback/_precondition, /datum/callback/_after_insert)

Sets up the proper signals and fills the list of materials with the appropriate references.

proc
amount2sheet
(amt)

Turns a material amount into the amount of sheets it should output

proc
can_hold_material
(/datum/material/mat)

The default check for whether we can add materials to this material container.

Arguments:

mat: The material we are checking for insertability.

proc
can_insert_amount_mat
(amt, /datum/material/mat)

Proc for checking if there is room in the component, returning the amount or else the amount lacking.

proc
get_categories
(/list/mats)

Returns all the categories in a recipe.

proc
get_item_material_amount
(/obj/item/I, breakdown_flags)

returns the amount of material relevant to this container; if this container does not support glass, any glass in 'I' will not be taken into account

proc
get_material_amount
(/datum/material/mat)

Returns the amount of a specific material in this container.

proc
has_enough_of_category
(category, amount, multiplier)

Returns TRUE if you have enough of a specified material category (Which could be multiple materials)

proc
has_enough_of_material
(/datum/material/req_mat, amount, multiplier)

Returns TRUE if you have enough of the specified material.

proc
has_materials
(/list/mats, multiplier)

Checks if its possible to afford a certain amount of materials. Takes a dictionary of materials.

proc
has_space
(amt)

Proc that returns TRUE if the container has space

proc
insert_amount_mat
(amt, /datum/material/mat)

For inserting an amount of material

proc
insert_item
(/obj/item/I, multiplier, stack_amt, breakdown_flags)

Proc specifically for inserting items, returns the amount of materials entered.

proc
insert_item_materials
(/obj/item/source, multiplier, breakdown_flags)

Inserts the relevant materials from an item into this material container.

Arguments:

source: The source of the materials we are inserting.
multiplier: The multiplier for the materials being inserted.
breakdown_flags: The breakdown bitflags that will be used to retrieve the materials from the source

proc
on_attackby
(/datum/source, /obj/item/I, /mob/living/user)

Proc that allows players to fill the parent with mats

proc
retrieve_all
(target)

Proc to get all the materials and dump them as sheets

proc
retrieve_sheets
(sheet_amt, /datum/material/M, /atom/target)

For spawning mineral sheets at a specific location. Used by machines to output sheets.

proc
sheet2amount
(sheet_amt)

Turns an amount of sheets into the amount of material amount it should output

proc
transer_amt_to
(/datum/component/material_container/T, amt, /datum/material/mat)

Proc for transfering materials to another container.

↑
ui_data
(/mob/user)

List format is list(material_name = list(amount = ..., ref = ..., etc.))

proc
use_amount_mat
(amt, /datum/material/mat)

Uses an amount of a specific material, effectively removing it.

proc
use_materials
(/list/mats, multiplier)

For consuming a dictionary of materials. mats is the map of materials to use and the corresponding amounts, example: list(M/datum/material/glass =100, datum/material/iron=200)

proc
user_insert
(/obj/item/held_item, /mob/living/user, breakdown_flags)

Proc used for when player inserts materials

material_container /datum/component/material_container

Vars

Procs

Var Details

var after_insert – /datum/callback

var allowed_item_typecache – /list

var allowed_materials – /list

var insertion_check – /datum/callback

var last_inserted_id –

var mat_container_flags –

var materials – /list

var max_amount –

var precise_insertion –

var precondition – /datum/callback

var total_amount –

Proc Details

↑Initialize(/list/init_mats, max_amt, _mat_container_flags, /list/allowed_mats, /list/allowed_items, /datum/callback/_insertion_check, /datum/callback/_precondition, /datum/callback/_after_insert)

proc amount2sheet(amt)

proc can_hold_material(/datum/material/mat)

proc can_insert_amount_mat(amt, /datum/material/mat)

proc get_categories(/list/mats)

proc get_item_material_amount(/obj/item/I, breakdown_flags)

proc get_material_amount(/datum/material/mat)

proc has_enough_of_category(category, amount, multiplier)

proc has_enough_of_material(/datum/material/req_mat, amount, multiplier)

proc has_materials(/list/mats, multiplier)

proc has_space(amt)

proc insert_amount_mat(amt, /datum/material/mat)

proc insert_item(/obj/item/I, multiplier, stack_amt, breakdown_flags)

proc insert_item_materials(/obj/item/source, multiplier, breakdown_flags)

proc on_attackby(/datum/source, /obj/item/I, /mob/living/user)

proc retrieve_all(target)

proc retrieve_sheets(sheet_amt, /datum/material/M, /atom/target)

proc sheet2amount(sheet_amt)

proc transer_amt_to(/datum/component/material_container/T, amt, /datum/material/mat)

↑ui_data(/mob/user)

proc use_amount_mat(amt, /datum/material/mat)

proc use_materials(/list/mats, multiplier)

proc user_insert(/obj/item/held_item, /mob/living/user, breakdown_flags)