/datum/storage

a datum for atoms that allows holdable storage of items in a hud

Vars
can_hold	Types that can be held
can_hold_exact	Exact types that can be held, in addition to can_hold, if it has types
check_wclass	If set, if can_hold is used, an item not in can_hold or can_hold_exact can fit in the storage if its weight is low enough
hud	Storage hud attached to the storage
linked_item	The storage item linked to this datum
max_wclass	Maximum w_class that can be held
move_triggered	Does moving the linked storage item cause anything to happen to stored items
opens_if_worn	Prevent accessing storage when clicked when worn, ex. in pocket
prevent_holding	Types that have a w_class holdable but that the storage will not hold
slots	Number of storage slots, even numbers overlap the close button for the on-ground hud layout
sneaky	Don't print a visible message on use
stack_stackables	Whether or not this storage allows stacking stackables into its contents
stealthy_storage	Don't show the contents of the storage on its description
stored_items	All items stored
Procs
add_contents	when adding an item in
add_contents_extra	Available if add_contents needs to be overridden
add_contents_safe	use this versus add_contents() if you also want extra safety checks
check_can_hold	check if the storage can hold an item or not
get_all_contents	return recursive search of all contents
get_capacity_string	return outputtable capacity
get_contents	return stored contents
get_fullness	storage is full or not, or can hold some of the given item in it
get_hud_contents	return contents that can be seen in the hud
get_visible_slots	return number of visible slots in the hud
hide_hud	hide storage
hud_can_add	if an item can be added by clicking it on the visible hud
hud_shown	if user sees the storage hud
is_full	storage is full or not
make_my_stuff	creates initial contents in the storage
mousetrap_check	when reaching inside the storage item, check for traps
show_hud	show storage contents
storage_emp_act	emping storage emps everything inside
storage_item_after_attack	after attacking an object with the storage item
storage_item_attack_by	when clicking the storage item with an object `visible` is for when the click is fake and we're actually calling it from a safe store chain
storage_item_attack_hand	when clicking the storage item with an empty hand
storage_item_attack_self	using storage item in hand
storage_item_mouse_drop	storage item is mouse dropped onto something
storage_item_move_triggered	storage item moving triggers a movement of items inside
storage_item_on_drop	storage item is dropped
transfer_stored_item	when transfering something in the storage out
transfer_stored_item_extra	for use if transfer_stored_item is overridden
try_stack_contents	For adding an item by trying to stack it with other items. Returns the item the input was stacked into if that happened, returns W if it was instead stacked into an available slot. Returns null if it wasn't stacked.

Var Details

var
can_hold
– /list

Types that can be held

var
can_hold_exact
– /list

Exact types that can be held, in addition to can_hold, if it has types

var
check_wclass
–

If set, if can_hold is used, an item not in can_hold or can_hold_exact can fit in the storage if its weight is low enough

var
hud
– /datum/hud/storage

Storage hud attached to the storage

var
linked_item
– /atom

The storage item linked to this datum

var
max_wclass
–

Maximum w_class that can be held

var
move_triggered
–

Does moving the linked storage item cause anything to happen to stored items

var
opens_if_worn
–

Prevent accessing storage when clicked when worn, ex. in pocket

var
prevent_holding
– /list

Types that have a w_class holdable but that the storage will not hold

var
slots
–

Number of storage slots, even numbers overlap the close button for the on-ground hud layout

var
sneaky
–

Don't print a visible message on use

var
stack_stackables
–

Whether or not this storage allows stacking stackables into its contents

var
stealthy_storage
–

Don't show the contents of the storage on its description

var
stored_items
– /list

All items stored

Proc Details

proc
add_contents
(/obj/item/I, /mob/user, visible)

when adding an item in

proc
add_contents_extra
(/obj/item/I, /mob/user, visible)

Available if add_contents needs to be overridden

proc
add_contents_safe
(/obj/item/I, /mob/user, visible)

use this versus add_contents() if you also want extra safety checks

proc
check_can_hold
(/obj/item/W)

check if the storage can hold an item or not

proc
get_all_contents
()

return recursive search of all contents

proc
get_capacity_string
()

return outputtable capacity

proc
get_contents
()

return stored contents

proc
get_fullness
(/obj/item/W)

storage is full or not, or can hold some of the given item in it

proc
get_hud_contents
()

return contents that can be seen in the hud

proc
get_visible_slots
()

return number of visible slots in the hud

proc
hide_hud
(/mob/user)

hide storage

proc
hud_can_add
(/obj/item/I)

if an item can be added by clicking it on the visible hud

proc
hud_shown
(/mob/user)

if user sees the storage hud

proc
is_full
(/obj/item/W)

storage is full or not

proc
make_my_stuff
(/list/spawn_contents)

creates initial contents in the storage

proc
mousetrap_check
(/mob/user)

when reaching inside the storage item, check for traps

proc
show_hud
(/mob/user)

show storage contents

proc
storage_emp_act
()

emping storage emps everything inside

proc
storage_item_after_attack
(/atom/target, /mob/user, reach)

after attacking an object with the storage item

proc
storage_item_attack_by
(/obj/item/W, /mob/user, visible)

when clicking the storage item with an object visible is for when the click is fake and we're actually calling it from a safe store chain

proc
storage_item_attack_hand
(/mob/user)

when clicking the storage item with an empty hand

proc
storage_item_attack_self
(/mob/user)

using storage item in hand

proc
storage_item_mouse_drop
(/mob/user, /atom/over_object, src_location, over_location)

storage item is mouse dropped onto something

proc
storage_item_move_triggered
(/mob/M, kindof)

storage item moving triggers a movement of items inside

proc
storage_item_on_drop
(/atom/source, /mob/user)

storage item is dropped

proc
transfer_stored_item
(/obj/item/I, /atom/location, add_to_storage, /mob/user)

when transfering something in the storage out

proc
transfer_stored_item_extra
(/obj/item/I, /atom/location, add_to_storage, /mob/user)

for use if transfer_stored_item is overridden

proc
try_stack_contents
(/obj/item/W)

For adding an item by trying to stack it with other items. Returns the item the input was stacked into if that happened, returns W if it was instead stacked into an available slot. Returns null if it wasn't stacked.

/datum/storage

Vars

Procs

Var Details

var can_hold – /list

var can_hold_exact – /list

var check_wclass –

var hud – /datum/hud/storage

var linked_item – /atom

var max_wclass –

var move_triggered –

var opens_if_worn –

var prevent_holding – /list

var slots –

var sneaky –

var stack_stackables –

var stealthy_storage –

var stored_items – /list

Proc Details

proc add_contents(/obj/item/I, /mob/user, visible)

proc add_contents_extra(/obj/item/I, /mob/user, visible)

proc add_contents_safe(/obj/item/I, /mob/user, visible)

proc check_can_hold(/obj/item/W)

proc get_all_contents()

proc get_capacity_string()

proc get_contents()

proc get_fullness(/obj/item/W)

proc get_hud_contents()

proc get_visible_slots()

proc hide_hud(/mob/user)

proc hud_can_add(/obj/item/I)

proc hud_shown(/mob/user)

proc is_full(/obj/item/W)

proc make_my_stuff(/list/spawn_contents)

proc mousetrap_check(/mob/user)

proc show_hud(/mob/user)

proc storage_emp_act()

proc storage_item_after_attack(/atom/target, /mob/user, reach)

proc storage_item_attack_by(/obj/item/W, /mob/user, visible)

proc storage_item_attack_hand(/mob/user)

proc storage_item_attack_self(/mob/user)

proc storage_item_mouse_drop(/mob/user, /atom/over_object, src_location, over_location)

proc storage_item_move_triggered(/mob/M, kindof)

proc storage_item_on_drop(/atom/source, /mob/user)

proc transfer_stored_item(/obj/item/I, /atom/location, add_to_storage, /mob/user)

proc transfer_stored_item_extra(/obj/item/I, /atom/location, add_to_storage, /mob/user)

proc try_stack_contents(/obj/item/W)