Difference between revisions of "GetFormID - Form"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Terra Nova2
(Compiler converts return value to decimal.)
imported>Pufthemajicdragon
(Cleaned up notes text, making it easier to understand.)
 
(One intermediate revision by one other user not shown)
Line 23: Line 23:


== Notes ==
== Notes ==
* Name can be misleading to anyone expecting the return value to be the value for a form found in the Creation Kit. The compiler automatically converts the return value into decimals. You will have to convert the value yourself to hex. This can be easily done with the windows calculator, by selecting "View → Programmer" and selecting "Dec", pasting the value in, and then selecting "hex".
* The value returned by GetFormID is always in decimal. This can be confusing to anyone expecting the return value to be the hex value for a form found in the Creation Kit. You will have to convert the value yourself. This can be easily done with the windows calculator, by selecting "View → Programmer" and selecting "Dec", pasting the value in, and then selecting "hex".


Example:  
Example:  
<source lang="papyrus">
<source lang="papyrus">
Int myFormID = SomeTree.GetFormID
Int myFormID = SomeTree.GetFormID()
;result...
;result...
768339 = BB953; or 000BB953 in the editor.
768339 = BB953; or 000BB953 in the editor.

Latest revision as of 15:47, 12 January 2016

Member of: Form Script

Returns this form's form ID.

Syntax[edit | edit source]

int Function GetFormID() native

Parameters[edit | edit source]

None

Return Value[edit | edit source]

The form ID of this form.

Examples[edit | edit source]

; Obtains the form id of the main quest
int formID = mainQuest.GetFormID()

Notes[edit | edit source]

  • The value returned by GetFormID is always in decimal. This can be confusing to anyone expecting the return value to be the hex value for a form found in the Creation Kit. You will have to convert the value yourself. This can be easily done with the windows calculator, by selecting "View → Programmer" and selecting "Dec", pasting the value in, and then selecting "hex".

Example:

Int myFormID = SomeTree.GetFormID()
;result...
768339 = BB953; or 000BB953 in the editor.

See Also[edit | edit source]