item_holder
Base class for stock parts that allow an item to be inserted while the maintenance panel is closed.
Vars | |
place_verb | The verb used when a player inserts an item. e.g. You [insert/place/attach] the cup in the cupholder. |
---|---|
Procs | |
eject_item | Eject the contained item. |
get_description_insertable | Returns a string to describe the kind of item that can be inserted. For instance, "disk" in the case of a data disk. |
get_inserted | Returns the inserted object if there is one, or null. |
insert_item | Insert the given object into the component, trigger callbacks, and transfer the item from the user if there is one. |
is_accepted_type | Returns whether the object can be handled by the component. |
is_item_inserted | Returns whether there is an item contained in the component. |
set_inserted | Handle putting the object in the component's contents. Doesn't trigger any callbacks, or messages. |
Var Details
place_verb
The verb used when a player inserts an item. e.g. You [insert/place/attach] the cup in the cupholder.
Proc Details
eject_item
Eject the contained item.
get_description_insertable
Returns a string to describe the kind of item that can be inserted. For instance, "disk" in the case of a data disk.
get_inserted
Returns the inserted object if there is one, or null.
insert_item
Insert the given object into the component, trigger callbacks, and transfer the item from the user if there is one.
is_accepted_type
Returns whether the object can be handled by the component.
is_item_inserted
Returns whether there is an item contained in the component.
set_inserted
Handle putting the object in the component's contents. Doesn't trigger any callbacks, or messages.