Difference between revisions of "IsOverEncumbered - Actor"
Jump to navigation
Jump to search
imported>Jlundin (Created page with "Category:Scripting Category:Papyrus '''Member of:''' Actor Script ''(Requires SSE 1.5.3)'' Returns if the actor is currently over-encumbered. == Syntax == <sourc...") |
imported>Antares (Using IsOverEncumbered in Skyrim Classic. Gave example function for use when the SSE function isn't available.) |
||
| Line 21: | Line 21: | ||
Debug.Trace("Player should drop some items, they're currently weighed down") | Debug.Trace("Player should drop some items, they're currently weighed down") | ||
endIf | endIf | ||
</source> | |||
== Using IsOverEncumbered in Skyrim Classic == | |||
<source lang="papyrus"> | |||
Bool Function IsOverEncumbered(Actor akActor) | |||
if akActor.GetActorValue("InventoryWeight") > akActor.GetActorValue("CarryWeight") | |||
Return True | |||
else | |||
Return False | |||
endif | |||
EndFunction | |||
</source> | |||
The above function will return True if the Actor Form you pass in is over encumbered, or return False if they are not. | |||
Example: | |||
<source lang="papyrus"> | |||
if IsOverEncumbered(Game.GetPlayer()) | |||
Debug.Trace("Player should drop some items, they're currently weighed down") | |||
endif | |||
</source> | </source> | ||
== See Also == | == See Also == | ||
*[[Actor Script]] | *[[Actor Script]] | ||
Revision as of 07:48, 3 August 2018
Member of: Actor Script (Requires SSE 1.5.3)
Returns if the actor is currently over-encumbered.
Syntax
bool Function IsOverEncumbered() nativeParameters
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")
endIfUsing IsOverEncumbered in Skyrim Classic
Bool Function IsOverEncumbered(Actor akActor)
if akActor.GetActorValue("InventoryWeight") > akActor.GetActorValue("CarryWeight")
Return True
else
Return False
endif
EndFunctionThe 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