Difference between revisions of "GetWeight - Form"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
(added f4se member)
 
imported>Qazaaq
(added required f4se version)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''Member of:''' [[Form Script]]
'''F4SE Member of:''' [[Form Script]]
 
{{Template:Papyrus:RequiredF4SE|version=0.3.1}}
'''Requires F4SE:''' <code>0.03.1</code>


Gets the weight of this form.
Gets the weight of this form.
Line 18: Line 17:
== Examples ==
== Examples ==
<source lang="papyrus">
<source lang="papyrus">
; Get the weight of an actor.
; Get the weight of a book item.
float weight = myBook.GetWeight()
float weight = myBook.GetWeight()
Debug.Trace("This book weighs " + weight + " units.")
Debug.Trace("This book weighs " + weight + " units.")

Latest revision as of 14:32, 21 January 2018

F4SE Member of: Form Script
Requires F4SE version 0.3.1 or higher.

Gets the weight of this form.

Syntax[edit | edit source]

float Function GetWeight() Native

Parameters[edit | edit source]

None

Return Value[edit | edit source]

The weight of this form.

Examples[edit | edit source]

; Get the weight of a book item.
float weight = myBook.GetWeight()
Debug.Trace("This book weighs " + weight + " units.")

Notes[edit | edit source]

None

See Also[edit | edit source]

Form Script