Difference between revisions of "GetForm - Game"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Cipscis
(Added note that this function should only ever be used for debugging purposes)
imported>JLundin
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Papyrus]]
[[Category:Non-delayed Native Function]]
'''Member of:''' [[Game Script]]
'''Member of:''' [[Game Script]]



Revision as of 09:10, 12 September 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.

See Also