IsPlayerOverencumbered

A function added by the SUP NVSE Plugin.

Description

Returns if the player character is overencumbered or not.

Syntax

[help]

(isOverencumbered:int) IsPlayerOverencumbered

Example

set isOverencumbered to IsPlayerOverencumbered

Will return 1\0 depending on whether PC is overencumbered or not.

Notes

• This function calls internal game function which is used to calculate whether player is overencumbered.