IsOverEncumbered - Actor

From Creation Kit
Jump to: navigation, search

Member of: Actor Script

Is this actor over-encumbered? An actor is considered over-encumbered if their total inventory weight exceeds their maximum carry weight.

Syntax

bool Function IsOverEncumbered() native

Parameters

None.

Return Value

Whether or not the actor is over-encumbered.

Examples

; Is the player over-encumbered?
bool playerOverEncumbered = Game.GetPlayer().IsOverEncumbered()

Notes

NPCs are never considered over-encumbered, only the player is.

See Also