GetBaseEquippedWeight
From GECK
A function added by the ShowOff NVSE Plugin.
Contents
Description
Returns the total amount of base weight for the items that the calling Actor reference has equipped. This ignores weight modification effects, such as the "Modify Light Items" Perk Entry Point.
minWeight is the minimum weight an equipped item must have in order to be included in the total. If omitted, it defaults to 0.
flagsMask is 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.
This function can be used either in a script, or as a Condition.
Syntax
(totalWeight:float) actorRefr.GetBaseEquippedWeight minWeight:float flagsMask:int
Example
player.GetBaseEquippedWeight 0 12
Returns the combined base weight of the items the player has equipped on the Upper Body and the Left Hand equip slots.
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 |
