UnequipItems
A function added by the ShowOff NVSE Plugin.
Description
Unequips certain items from the calling Actor reference. When called without specifying any arguments, will unequip all equipped Playable Items. Otherwise, filters and effects can be used to determine what items will be unequipped, and how.
Parameters
flagsMask: A bitmask containing filters for what kinds of items to get. If flags is omitted / set to 0, the function will check for every playable equipped item. Otherwise, it can be used to specify which equip slots to check for, and further filters.
- If an equipped item occupies multiple equip slots, the function will not count duplicates.
noEquip: If set to 1, the actor (including the player) will be unable to equip the item. Once the item is equipped with the EquipItem function, the item can be equipped and unequipped as normal.
- Disabled by default (if not provided a value).
hideMessage: If set to 1, the item unequipped message will be hidden from the player.
- Disabled by default (if not provided a value).
triggerOnUnequip: If set to 1, will trigger the OnUnequip script block.
- Enabled by default (if not provided a value).
Syntax
actorRefr.UnequipItems flagsMask:int noEquip:int{0,1} hideMessage:int{0,1} triggerOnUnequip:int{0,1}
Example
player.UnequipItems
Will unequip all playable items from the player.
Notes
- The flags used to determine the equip slots to check are:
| Equip Slot Flag | Flag Value | Bit |
|---|---|---|
| Head | 1 | 0 |
| Hair | 2 | 1 |
| Upper Body | 4 | 2 |
| Left Hand | 8 | 3 |
| Right Hand | 16 | 4 |
| Weapon | 32 | 5 |
| PipBoy | 64 | 6 |
| Backpack | 128 | 7 |
| Necklace | 256 | 8 |
| Headband | 512 | 9 |
| Hat | 1024 | 10 |
| Eyeglasses | 2048 | 11 |
| Nosering | 4096 | 12 |
| Earrings | 8192 | 13 |
| Mask | 16384 | 14 |
| Choker | 32768 | 15 |
| MouthObject | 65536 | 16 |
| BodyAddon1 | 131072 | 17 |
| BodyAddon2 | 262144 | 18 |
| BodyAddon3 | 524288 | 19 |
- The misc. flags that come after that are:
| Misc. Flags | Value | Bit |
|---|---|---|
| NoUnplayableItems | 1048576 | 20 |
| NoQuestItems | 2097152 | 21 |
| NoSlotlessItems | 4194304 | 22 |
