Difference between revisions of "SetWeight - Form"
Jump to navigation
Jump to search
imported>Fg109 m (→See Also) |
imported>JustinOther m (→Notes: Added to note about maintaining edits) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Scripting]] | [[Category:Scripting]] | ||
[[Category:Papyrus]] | [[Category:Papyrus]] | ||
'''Member of:''' [[Form Script]] | [[Category:SKSE]] | ||
'''SKSE Member of:''' [[Form Script]] | |||
Sets the weight of this form. | Sets the weight of this form. (This function requires SKSE) | ||
== Syntax == | == Syntax == | ||
| Line 23: | Line 24: | ||
== Notes == | == Notes == | ||
*Does not work on forms that do not have weight (eg | * Does not work on forms that do not have weight (eg Quest aliases flagged as "Quest Object") | ||
* This function is performed on a base Form, meaning changes will not save. Edits can maintained via a [[Complete_Example_Scripts#Maintenance.2Fupdate_code_which_runs_once_per_save_load_and_shows_a_message_when_a_mod_is_updated_or_first_loaded|maintenance setup]] or something similar. | |||
== See Also == | == See Also == | ||
*[[Form Script]] | *[[Form Script]] | ||
*[[GetWeight_-_Form|GetWeight - Form]] | *[[GetWeight_-_Form|GetWeight - Form]] | ||
Latest revision as of 02:23, 1 September 2012
SKSE Member of: Form Script
Sets the weight of this form. (This function requires SKSE)
Syntax[edit | edit source]
Function SetWeight(float weight) nativeParameters[edit | edit source]
- weight: the new weight of the form
Return Value[edit | edit source]
None
Examples[edit | edit source]
Gold001.SetWeight(1.0)
Debug.Trace("These coins really are worth their weight in gold!")Notes[edit | edit source]
- Does not work on forms that do not have weight (eg Quest aliases flagged as "Quest Object")
- This function is performed on a base Form, meaning changes will not save. Edits can maintained via a maintenance setup or something similar.