IsOverEncumbered - Actor

From the CreationKit Wiki
Revision as of 10:38, 3 August 2018 by imported>Antares (syntax)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Member of: Actor Script (Requires SSE 1.5.3)

Returns if the actor is currently over-encumbered.

Syntax[edit | edit source]

bool Function IsOverEncumbered() native

Parameters[edit | edit source]

None

Return Value[edit | edit source]

True if the actor is over-encumbered

Examples[edit | edit source]

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

Using IsOverEncumbered in Skyrim Classic[edit | edit source]

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[edit | edit source]