GetIsPlayerOverencumbered

A function added by the ShowOff NVSE Plugin version 1.55.

Description

Returns if the player character is overencumbered or not (1 or 0, true or false).

If ignoreGodMode is set to true (non-0), will ignore the player's GodMode status to determine if they are overencumbered. By default, if they are in GodMode, they cannot be considered overencumbered.

This function can be used either in a script, or as a Condition.

Syntax

[help]

(isOverencumbered:bool) GetIsPlayerOverencumbered ignoreGodMode:bool{0} 

Or:

(isOverencumbered:bool) IsPCOverencumbered ignoreGodMode:bool{0}

Example

int bIsOverencumbered = IsPCOverencumbered

Will return 1\0 depending on whether PC is overencumbered or not. If the player is in GodMode, will return 1 no matter what.

Notes

• This function accounts for both the "Modify Light Items" and "Get Max Carry Weight" Perk Entry Points.

See Also

• GetEncumbranceRate
• GetInventoryWeight
• GetActorValue (since max CarryWeight is an AV)
• GetPerkModifier (since max carry weight is also affected by "Get Max Carry Weight" perk entries (#22))
• IsPlayerOverencumbered - equivalent function, but for SUP NVSE.