IsOverEncumbered - Actor

From Creation Kit
Jump to: navigation, search

Member of: Actor Script (Requires SSE 1.5.3)

Returns if the actor is currently over-encumbered.

Syntax

bool Function IsOverEncumbered() native

Parameters

None

Return Value

True if the actor is over-encumbered

Examples

if (Game.GetPlayer().IsOverEncumbered())
  Debug.Trace("Player should drop some items, they're currently weighed down")
endIf

Using IsOverEncumbered in Skyrim Classic

Bool Function IsOverEncumbered(Actor akActor)
  if akActor.GetActorValue("InventoryWeight") > akActor.GetActorValue("CarryWeight")
    Return True
  else
    Return False
  endif
EndFunction

The above function will return True if the Actor Form you pass in is over encumbered, or return False if they are not. Example:

if IsOverEncumbered((Game.GetPlayer()))
  Debug.Trace("Player should drop some items, they're currently weighed down")
endif

See Also