strippable_item
A representation of an item that can be stripped down
Vars | |
| key | The STRIPPABLE_ITEM_* key |
|---|---|
| warn_dangerous_clothing | Should we warn about dangerous clothing? |
Procs | |
| alternate_action | Performs an alternative action on this strippable_item.
has_alternate_action needs to be TRUE.
Returns FALSE if blocked by signal, TRUE otherwise. |
| 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_action | Returns the ID of this item's strippable action.
Return null if there is no alternate action.
Any return value of this must be in StripMenu. |
| 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. |
| 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
warn_dangerous_clothing
Should we warn about dangerous clothing?
Proc Details
alternate_action
Performs an alternative action on this strippable_item.
has_alternate_action needs to be TRUE.
Returns FALSE if blocked by signal, TRUE otherwise.
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_action
Returns the ID of this item's strippable action.
Return null if there is no alternate action.
Any return value of this must be in StripMenu.
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.
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.