Difference between revisions of "GetForm - Game"
Jump to navigation
Jump to search
imported>Jlundin |
imported>Cipscis (Added note that this function should only ever be used for debugging purposes) |
||
Line 21: | Line 21: | ||
Form someForm = Game.GetForm(0x0001DA07) | Form someForm = Game.GetForm(0x0001DA07) | ||
</source> | </source> | ||
== Notes == | |||
* 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. | |||
== See Also == | == See Also == | ||
*[[Game Script]] | *[[Game Script]] | ||
*[[GetFormID - Form]] | *[[GetFormID - Form]] |
Revision as of 16:38, 29 February 2012
Member of: Game Script
Obtains the form specified by its form ID number.
Syntax
Form Function GetForm(int aiFormID) native global
Parameters
- 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
The requested Form, or None if the form ID is not valid.
Examples
; Obtain whatever form 0001DA07 is
Form someForm = Game.GetForm(0x0001DA07)
Notes
- 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.