Difference between revisions of "SetWeight - Form"

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


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


== Syntax ==
== Syntax ==
Line 24: Line 24:
== Notes ==
== Notes ==
*Does not work on forms that do not have weight (eg Quests)
*Does not work on forms that do not have weight (eg Quests)
*This function is performed on a base Form, meaning changes will not save.


== See Also ==
== See Also ==
*[[Form Script]]
*[[Form Script]]
*[[GetWeight_-_Form|GetWeight - Form]]
*[[GetWeight_-_Form|GetWeight - Form]]

Revision as of 02:46, 10 May 2012

SKSE Member of: Form Script

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

Syntax

Function SetWeight(float weight) native

Parameters

  • weight: the new weight of the form

Return Value

None

Examples

Gold001.SetWeight(1.0)
Debug.Trace("These coins really are worth their weight in gold!")

Notes

  • Does not work on forms that do not have weight (eg Quests)
  • This function is performed on a base Form, meaning changes will not save.

See Also