Difference between revisions of "GetWeight - Form"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
m (fixed papyrus example comment)
imported>Qazaaq
(changed f4se notation)
Line 1: Line 1:
'''Member of:''' [[Form Script]]
'''F4SE Member of:''' [[Form Script]]
 
'''Requires F4SE:''' <code>0.03.1</code>


Gets the weight of this form.
Gets the weight of this form.

Revision as of 01:24, 22 October 2017

F4SE Member of: Form Script

Gets the weight of this form.

Syntax

float Function GetWeight() Native

Parameters

None

Return Value

The weight of this form.

Examples

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

Notes

None

See Also

Form Script