strippable_item
A representation of an item that can be stripped down
Vars | |
| key | The STRIPPABLE_ITEM_* key |
|---|---|
| show_visible_message | Should we give feedback messages? |
Procs | |
| finish_equip | The proc that places the item on the source. This should not yield. |
| finish_unequip | The proc that unequips the item from the source. This should not yield. |
| get_alternate_actions | Returns a list of alternate actions that can be performed on this strippable_item. All string keys in the list must be inside tgui\packages\tgui\interfaces\StripMenu.tsx You can also return null if there are no alternate actions. |
| get_item | Gets the item from the given source. |
| get_obscuring | Returns a STRIPPABLE_OBSCURING_* define to report on whether or not this is obscured. |
| perform_alternate_action | Performs an alternate action on this strippable_item. |
| should_show | Returns whether or not this item should show. |
| start_equip | Start the equipping process. This is the proc you should yield in. Returns TRUE/FALSE depending on if it is allowed. |
| start_unequip | Start the unequipping process. This is the proc you should yield in. Returns TRUE/FALSE depending on if it is allowed. |
| try_equip | Tries to equip the item onto the given source. Returns TRUE/FALSE depending on if it is allowed. This should be used for checking if an item CAN be equipped. It should not perform the equipping itself. |
| try_unequip | Tries to unequip the item from the given source. Returns TRUE/FALSE depending on if it is allowed. This should be used for checking if it CAN be unequipped. It should not perform the unequipping itself. |
Var Details
key
The STRIPPABLE_ITEM_* key
show_visible_message
Should we give feedback messages?
Proc Details
finish_equip
The proc that places the item on the source. This should not yield.
finish_unequip
The proc that unequips the item from the source. This should not yield.
get_alternate_actions
Returns a list of alternate actions that can be performed on this strippable_item. All string keys in the list must be inside tgui\packages\tgui\interfaces\StripMenu.tsx You can also return null if there are no alternate actions.
get_item
Gets the item from the given source.
get_obscuring
Returns a STRIPPABLE_OBSCURING_* define to report on whether or not this is obscured.
perform_alternate_action
Performs an alternate action on this strippable_item.
- source: The source of the action.
- user: The user performing the action.
- action_key: The key of the alternate action to perform. Returns FALSE if unable to perform the action; whether it be due to the signal or some other factor.
should_show
Returns whether or not this item should show.
start_equip
Start the equipping process. This is the proc you should yield in. Returns TRUE/FALSE depending on if it is allowed.
start_unequip
Start the unequipping process. This is the proc you should yield in. Returns TRUE/FALSE depending on if it is allowed.
try_equip
Tries to equip the item onto the given source. Returns TRUE/FALSE depending on if it is allowed. This should be used for checking if an item CAN be equipped. It should not perform the equipping itself.
try_unequip
Tries to unequip the item from the given source. Returns TRUE/FALSE depending on if it is allowed. This should be used for checking if it CAN be unequipped. It should not perform the unequipping itself.