Difference between revisions of "GetForm - Game"
Jump to navigation
Jump to search
imported>DavidJCobb (→Notes) |
imported>Pickysaurus m (→Notes: Added note about GetFormEx) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 26: | Line 26: | ||
* Scripts should always be blind to the contents of data files, and rely on [[Variables and Properties|properties]] as the interface through which they access data from data files. As such, this function should only ever be used for debugging purposes. | * Scripts should always be blind to the contents of data files, and rely on [[Variables and Properties|properties]] as the interface through which they access data from data files. As such, this function should only ever be used for debugging purposes. | ||
* As the FormID is intended to be a 32-bit unsigned integer and Papyrus uses signed integers, this function is not reliable for forms from higher-ordered mods. Specifically, any FormID with the MSB set (load order 0x80 and above) will fail to return a valid object. | * As the FormID is intended to be a 32-bit unsigned integer and Papyrus uses signed integers, this function is not reliable for forms from higher-ordered mods. Specifically, any FormID with the MSB set (load order 0x80 and above) will fail to return a valid object. | ||
* This function cannot retrieve | * This function cannot retrieve a temporary ObjectReference (one created at run-time, whose form ID starts with 0xFF) by form ID if that reference is not loaded. | ||
* In cases where this function would fail, you can use [[GetFormEx_-_Game | GetFormEx()]] provided by SKSE. | |||
== See Also == | == See Also == | ||
Latest revision as of 03:47, 27 May 2020
Member of: Game Script
Obtains the form specified by its form ID number.
Syntax[edit | edit source]
Form Function GetForm(int aiFormID) native globalParameters[edit | edit source]
- aiFormID: The form ID number of the form we want. (FormID proceeded by 0x) For example Form ID "0001DA07" is given as: 0x0001DA07
Return Value[edit | edit source]
The requested Form, or None if the form ID is not valid.
Examples[edit | edit source]
; Obtain whatever form 0001DA07 is
Form someForm = Game.GetForm(0x0001DA07)Notes[edit | edit source]
- Scripts should always be blind to the contents of data files, and rely on properties as the interface through which they access data from data files. As such, this function should only ever be used for debugging purposes.
- As the FormID is intended to be a 32-bit unsigned integer and Papyrus uses signed integers, this function is not reliable for forms from higher-ordered mods. Specifically, any FormID with the MSB set (load order 0x80 and above) will fail to return a valid object.
- This function cannot retrieve a temporary ObjectReference (one created at run-time, whose form ID starts with 0xFF) by form ID if that reference is not loaded.
- In cases where this function would fail, you can use GetFormEx() provided by SKSE.