stack

Vars
amount	How much is in this stack?
cost	Related to above. How much energy it costs from storage to use stack items
full_w_class	The weight class the stack has at amount > 2/3rds max_amount
is_cyborg	If TRUE, this stack is a module used by a cyborg (doesn't run out like normal / etc)
material_type	Datum material type that this stack is made of
mats_per_unit	List that tells you how much is in a single unit.
matter_amount	Amount of matter for RCD
max_amount	How much is allowed in this stack?
merge_type	This path and its children should merge with this stack, defaults to src.type
novariants	Determines whether the item should update it's sprites based on amount.
recipes	A list to all recipies this stack item can create.
singular_name	What's the name of just 1 of this stack. You have a stack of leather, but one piece of leather
source	Related to above. If present, the energy we draw from when using stack items, for cyborgs
strict	Does it merge strictly only with its type
Procs
add
build_recipe	Returns a list of properties of a given recipe
can_merge
is_valid_recipe	Checks if the recipe is valid to be used
is_zero_amount	Returns TRUE if the item stack is the equivalent of a 0 amount item.
merge	Merges as much of src into target_stack as possible. If present, the limit arg overrides target_stack.max_amount for transfer.
merge_without_del	Merges as much of src into target_stack as possible. If present, the limit arg overrides target_stack.max_amount for transfer.
recursively_build_recipes	Builds all recipes in a given recipe list and returns an association list containing them
set_custom_materials	Override to make things like metalgen accurately set custom materials
set_mats_per_unit
update_custom_materials	Updates the custom materials list of this stack.

Var Details

var
amount
–

How much is in this stack?

var
cost
–

Related to above. How much energy it costs from storage to use stack items

var
full_w_class
–

The weight class the stack has at amount > 2/3rds max_amount

var
is_cyborg
–

If TRUE, this stack is a module used by a cyborg (doesn't run out like normal / etc)

var
material_type
–

Datum material type that this stack is made of

var
mats_per_unit
– /list

List that tells you how much is in a single unit.

var
matter_amount
–

Amount of matter for RCD

var
max_amount
–

How much is allowed in this stack?

var
merge_type
–

This path and its children should merge with this stack, defaults to src.type

var
novariants
–

Determines whether the item should update it's sprites based on amount.

var
recipes
– /list/datum/stack_recipe

A list to all recipies this stack item can create.

var
singular_name
–

What's the name of just 1 of this stack. You have a stack of leather, but one piece of leather

var
source
– /datum/robot_energy_storage

Related to above. If present, the energy we draw from when using stack items, for cyborgs

var
strict
–

Does it merge strictly only with its type

Proc Details

proc
add
(_amount)

Adds some number of units to this stack.
Arguments:
- _amount: The number of units to add to this stack.

proc
build_recipe
(/datum/stack_recipe/R)

Returns a list of properties of a given recipe

Arguments:

R - The stack recipe we are using to get a list of properties

proc
can_merge
(/obj/item/stack/check, inhand)

Checks whether this stack can merge itself into another stack.
Arguments:
- check: The stack to check for mergeability.
- [inhand][boolean]: Whether or not the stack to check should act like it's in a mob's hand.

proc
is_valid_recipe
(/datum/stack_recipe/R, /list/recipe_list)

Checks if the recipe is valid to be used

Arguments:

R - The stack recipe we are checking if it is valid
recipe_list - The list of recipes we are using to check the given recipe

proc
is_zero_amount
(delete_if_zero)

Returns TRUE if the item stack is the equivalent of a 0 amount item.

Also deletes the item if delete_if_zero is TRUE and the stack does not have is_cyborg set to true.

proc
merge
(/obj/item/stack/target_stack, limit)

Merges as much of src into target_stack as possible. If present, the limit arg overrides target_stack.max_amount for transfer.

This proc deletes src if the remaining amount after the transfer is 0.

proc
merge_without_del
(/obj/item/stack/target_stack, limit)

Merges as much of src into target_stack as possible. If present, the limit arg overrides target_stack.max_amount for transfer.

This calls use() without check = FALSE, preventing the item from qdeling itself if it reaches 0 stack size.

As a result, this proc can leave behind a 0 amount stack.

proc
recursively_build_recipes
(/list/recipe_to_iterate)

Builds all recipes in a given recipe list and returns an association list containing them

Arguments:

recipe_to_iterate - The list of recipes we are using to build recipes

↑
set_custom_materials
(/list/materials, multiplier, is_update)

Override to make things like metalgen accurately set custom materials

proc
set_mats_per_unit
(/list/mats, multiplier)

Sets the amount of materials per unit for this stack.
Arguments:
- mats: The value to set the mats per unit to.
- multiplier: The amount to multiply the mats per unit by. Defaults to 1.

proc
update_custom_materials
()

Updates the custom materials list of this stack.

/obj/item/stack

Vars

Procs

Var Details

var amount –

var cost –

var full_w_class –

var is_cyborg –

var material_type –

var mats_per_unit – /list

var matter_amount –

var max_amount –

var merge_type –

var novariants –

var recipes – /list/datum/stack_recipe

var singular_name –

var source – /datum/robot_energy_storage

var strict –

Proc Details

proc add(_amount)

proc build_recipe(/datum/stack_recipe/R)

proc can_merge(/obj/item/stack/check, inhand)

proc is_valid_recipe(/datum/stack_recipe/R, /list/recipe_list)

proc is_zero_amount(delete_if_zero)

proc merge(/obj/item/stack/target_stack, limit)

proc merge_without_del(/obj/item/stack/target_stack, limit)

proc recursively_build_recipes(/list/recipe_to_iterate)

↑set_custom_materials(/list/materials, multiplier, is_update)

proc set_mats_per_unit(/list/mats, multiplier)

proc update_custom_materials()

var
amount
–

var
cost
–

var
full_w_class
–

var
is_cyborg
–

var
material_type
–

var
mats_per_unit
– /list

var
matter_amount
–

var
max_amount
–

var
merge_type
–

var
novariants
–

var
recipes
– /list/datum/stack_recipe

var
singular_name
–

var
source
– /datum/robot_energy_storage

var
strict
–

proc
add
(_amount)

proc
build_recipe
(/datum/stack_recipe/R)

proc
can_merge
(/obj/item/stack/check, inhand)

proc
is_valid_recipe
(/datum/stack_recipe/R, /list/recipe_list)

proc
is_zero_amount
(delete_if_zero)

proc
merge
(/obj/item/stack/target_stack, limit)

proc
merge_without_del
(/obj/item/stack/target_stack, limit)

proc
recursively_build_recipes
(/list/recipe_to_iterate)

↑
set_custom_materials
(/list/materials, multiplier, is_update)

proc
set_mats_per_unit
(/list/mats, multiplier)

proc
update_custom_materials
()