GetEncumbranceRate
From GECK
A function added by the JIP NVSE Plugin.
Contents
Description
Returns the ratio between the calling actor's inventory weight and their max carry weight as a percentage float (i.e. xx.xx). If the actor's CarryWeight Actor Value is somehow below 1, this function considers their max carry weight as 1 instead.
This function can be used either in a script, or as a Condition.
Syntax
(float) reference.GetEncumbranceRate
Example
RaulRef.GetEncumbranceRate
Notes
- The player becomes overencumbered when their encumbrance rate is > 100.66%.
- This function accounts for the "Modify Light Items" Perk Entry Point.
- This function does NOT account for the "Get Max Carry Weight" Perk Entry Point.
- This is fixed in version 56.28
See Also
- GetInventoryWeight
- GetActorValue
- IsPlayerOverencumbered
- GetPerkModifier (since some perk entries modify carry weight)
