Difference between revisions of "GetWeight - Form"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>PurpleLunchbox
imported>Fg109
m
 
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Papyrus]]
[[Category:SKSE]]
'''SKSE Member of:''' [[Form Script]]
'''SKSE Member of:''' [[Form Script]]



Latest revision as of 03:28, 10 May 2012

SKSE Member of: Form Script

Returns the weight of this form. (This function requires SKSE)

Syntax[edit | edit source]

float Function GetWeight() native

Parameters[edit | edit source]

None

Return Value[edit | edit source]

The weight of this form, or 0.0 if it doesn't have a value.

Examples[edit | edit source]

if Game.GetPlayer().GetEquippedWeapon().GetWeight() > 25.0
  Debug.Trace("Your weapon is heavy!")
endIf

Notes[edit | edit source]

  • Returns 0.0 when used on actors, even though actors have weight.

See Also[edit | edit source]