stack

Vars
absorption_capacity	How much blood this stack can absorb until the owner starts loosing blood again.
absorption_rate_modifier	How much this stack reduces blood flow, multiplier
amount	The amount of STUFF currently in the stack.
burn_cleanliness_bonus	Like splint_factor but for burns instead of bone wounds. This is a multiplier used to speed up burn recoveries
dynamically_set_name	If TRUE, dynamically adjust the name of the item based on singular/plural quantities.
full_w_class	The weight class the stack should have at amount > 2/3rds max_amount
has_unique_girder	Does this stack require a unique girder in order to make a wall?
is_cyborg	It's TRUE if module is used by a cyborg, and uses its storage
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	The maximum amount of STUFF this stack can hold. also see stack recipes initialisation, param "max_res_amount" must be equal to this max_amount
merge_type	This path and its children should merge with this stack, defaults to src.type
multiple_gender	The gender of the stack.
novariants	If FALSE, the stack changes icon state based on the ratio of amount to max amount.
singular_gender	The gender of a single instance of the stack.
singular_name	The name of one piece of the stack.
splint_slowdown	If set and this used as a splint for a broken bone wound, this is used as a multiplier for applicable slowdowns (lower = better) (also for speeding up burn recoveries)
stack_name	The name used to describe the group of objects.
Procs
absorb_blood	Absorb an incoming bleed amount, return the amount we failed to absorb.
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.
on_movable_entered_occupied_turf	Signal handler for connect_loc element. Called when a movable enters the turf we're currently occupying. Merges if possible.
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
split_stack
update_custom_materials	Updates the custom materials list of this stack.
update_gender	Update the gender var based on if the stack contains 1 or more items.
update_maptext	Set the maptext for the item that shows how much junk is inside the trunk.

Var Details

var
absorption_capacity
–

How much blood this stack can absorb until the owner starts loosing blood again.

var
absorption_rate_modifier
–

How much this stack reduces blood flow, multiplier

var
amount
–

The amount of STUFF currently in the stack.

var
burn_cleanliness_bonus
–

Like splint_factor but for burns instead of bone wounds. This is a multiplier used to speed up burn recoveries

var
dynamically_set_name
–

If TRUE, dynamically adjust the name of the item based on singular/plural quantities.

var
full_w_class
–

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

var
has_unique_girder
–

Does this stack require a unique girder in order to make a wall?

var
is_cyborg
–

It's TRUE if module is used by a cyborg, and uses its storage

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
–

The maximum amount of STUFF this stack can hold. also see stack recipes initialisation, param "max_res_amount" must be equal to this max_amount

var
merge_type
–

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

var
multiple_gender
–

The gender of the stack.

var
novariants
–

If FALSE, the stack changes icon state based on the ratio of amount to max amount.

var
singular_gender
–

The gender of a single instance of the stack.

var
singular_name
–

The name of one piece of the stack.

var
splint_slowdown
–

If set and this used as a splint for a broken bone wound, this is used as a multiplier for applicable slowdowns (lower = better) (also for speeding up burn recoveries)

var
stack_name
–

The name used to describe the group of objects.

Proc Details

proc
absorb_blood
(bleed_amt, /mob/living/carbon/owner)

Absorb an incoming bleed amount, return the amount we failed to absorb.

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
on_movable_entered_occupied_turf
(/datum/source, /atom/movable/arrived)

Signal handler for connect_loc element. Called when a movable enters the turf we're currently occupying. Merges if possible.

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
split_stack
(/mob/user, amount, spawn_loc)

Splits the stack into two stacks.
Arguments:
- user: The mob splitting the stack.
- amount: The number of units to split from this stack.
- spawn_loc: The place to spawn the new stack, accepts null.

proc
update_custom_materials
()

Updates the custom materials list of this stack.

proc
update_gender
()

Update the gender var based on if the stack contains 1 or more items.

proc
update_maptext
()

Set the maptext for the item that shows how much junk is inside the trunk.

stack /obj/item/stack

Vars

Procs

Var Details

var absorption_capacity –

var absorption_rate_modifier –

var amount –

var burn_cleanliness_bonus –

var dynamically_set_name –

var full_w_class –

var has_unique_girder –

var is_cyborg –

var material_type –

var mats_per_unit – /list

var matter_amount –

var max_amount –

var merge_type –

var multiple_gender –

var novariants –

var singular_gender –

var singular_name –

var splint_slowdown –

var stack_name –

Proc Details

proc absorb_blood(bleed_amt, /mob/living/carbon/owner)

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 on_movable_entered_occupied_turf(/datum/source, /atom/movable/arrived)

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 split_stack(/mob/user, amount, spawn_loc)

proc update_custom_materials()

proc update_gender()

proc update_maptext()

stack
/obj/item/stack

var
absorption_capacity
–

var
absorption_rate_modifier
–

var
amount
–

var
burn_cleanliness_bonus
–

var
dynamically_set_name
–

var
full_w_class
–

var
has_unique_girder
–

var
is_cyborg
–

var
material_type
–

var
mats_per_unit
– /list

var
matter_amount
–

var
max_amount
–

var
merge_type
–

var
multiple_gender
–

var
novariants
–

var
singular_gender
–

var
singular_name
–

var
splint_slowdown
–

var
stack_name
–

proc
absorb_blood
(bleed_amt, /mob/living/carbon/owner)

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
on_movable_entered_occupied_turf
(/datum/source, /atom/movable/arrived)

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
split_stack
(/mob/user, amount, spawn_loc)

proc
update_custom_materials
()

proc
update_gender
()

proc
update_maptext
()