storage 
Vars | |
allow_quick_empty | Set this variable to allow the object to have the 'empty' verb, which dumps all the contents on the floor. |
---|---|
allow_quick_gather | Set this variable to allow the object to have the 'toggle mode' verb, which quickly collects all items from a tile. |
boxes | The number of storage slots in this container. |
can_hold | List of objects which this item can store (if set, it can't store anything else) |
cant_hold | List of objects which this item can't store (in effect only if can_hold isn't set) |
display_contents_with_number | Set this to make the storage item group contents of the same type and display them as a number. |
foldable | What kind of /obj/item/stack can this be folded into. (e.g. Boxes and cardboard) |
foldable_amt | How much of the stack item do you get. |
max_combined_w_class | The sum of the w_classes of all the items in this storage item. |
max_w_class | Max size of objects that this object can store (in effect only if can_hold isn't set) |
min_w_class | Min size of objects that this object can store (in effect only if can_hold isn't set) |
mobs_viewing | Lazy list of mobs which are currently viewing the storage inventory. |
pickup_all_on_tile | FALSE = pick one at a time, TRUE = pick all on tile |
silent | No message on putting items in |
use_sound | Sound played when used. null for no sound. |
use_to_pickup | Set this to make it possible to use this item in an inverse way, so you can have the item in your hand and click items on the floor to pick them up. |
w_class_override | List of objects that can be stored, regardless of w_class |
Procs | |
can_be_inserted | This proc returns TRUE if the item can be picked up and FALSE if it can't. Set the stop_messages to stop it from printing messages |
handle_item_insertion | This proc handles items being inserted. It does not perform any checks of whether an item can or can't be inserted. That's done by can_be_inserted() The stop_warning parameter will stop the insertion message from being displayed. It is intended for cases where you are inserting multiple items at once, such as when picking up all the items on a tile with one click. |
populate_contents | Populates the container with items |
remove_from_storage | Call this proc to handle the removal of an item from the storage item. The item will be moved to the atom sent as new_target |
Var Details
allow_quick_empty 
Set this variable to allow the object to have the 'empty' verb, which dumps all the contents on the floor.
allow_quick_gather 
Set this variable to allow the object to have the 'toggle mode' verb, which quickly collects all items from a tile.
boxes 
The number of storage slots in this container.
can_hold 
List of objects which this item can store (if set, it can't store anything else)
cant_hold 
List of objects which this item can't store (in effect only if can_hold isn't set)
display_contents_with_number 
Set this to make the storage item group contents of the same type and display them as a number.
foldable 
What kind of /obj/item/stack can this be folded into. (e.g. Boxes and cardboard)
foldable_amt 
How much of the stack item do you get.
max_combined_w_class 
The sum of the w_classes of all the items in this storage item.
max_w_class 
Max size of objects that this object can store (in effect only if can_hold isn't set)
min_w_class 
Min size of objects that this object can store (in effect only if can_hold isn't set)
mobs_viewing 
Lazy list of mobs which are currently viewing the storage inventory.
pickup_all_on_tile 
FALSE = pick one at a time, TRUE = pick all on tile
silent 
No message on putting items in
use_sound 
Sound played when used. null
for no sound.
use_to_pickup 
Set this to make it possible to use this item in an inverse way, so you can have the item in your hand and click items on the floor to pick them up.
w_class_override 
List of objects that can be stored, regardless of w_class
Proc Details
can_be_inserted
This proc returns TRUE if the item can be picked up and FALSE if it can't. Set the stop_messages to stop it from printing messages
handle_item_insertion
This proc handles items being inserted. It does not perform any checks of whether an item can or can't be inserted. That's done by can_be_inserted() The stop_warning parameter will stop the insertion message from being displayed. It is intended for cases where you are inserting multiple items at once, such as when picking up all the items on a tile with one click.
populate_contents
Populates the container with items
Override with whatever you want to put in the container
remove_from_storage
Call this proc to handle the removal of an item from the storage item. The item will be moved to the atom sent as new_target