Difference between revisions of "Form Script"
Jump to navigation
Jump to search
imported>Tania (Added F4SE member function header, and added GetName under it.) |
imported>Tania m (→F4SE Member Functions: added SetName) |
||
| Line 36: | Line 36: | ||
*string Function [[GetName - Form|GetName]]() | *string Function [[GetName - Form|GetName]]() | ||
**Returns this form's name as a string. | **Returns this form's name as a string. | ||
*Function [[SetName - Form| Form|SetName]]() | |||
**Sets this form's name to the passed in string. | |||
== Events == | == Events == | ||
None | None | ||
Revision as of 00:19, 15 May 2017
Extends: ScriptObject
Native base script for every form in the game.
Definition
ScriptName Form extends ScriptObject Native HiddenProperties
None
Global Functions
None
Member Functions
- int Function GetFormID()
- Returns this form's form ID.
- int Function GetGoldValue()
- Returns this form's value in gold.
- bool Function HasKeyword(Keyword akKeyword)
- Returns if this form has the specified Keyword attached.
- bool Function HasKeywordInFormList(FormList akKeywordList)
- Returns if this form has any of the keywords in the FormList attached.
- Function PlayerKnows()
- Is the "Known" flag set on the form?
- Function StartObjectProfiling()
- Starts profiling all scripts attached to this form.
- Function StopObjectProfiling()
- Stops profiling all scripts attached to this form.
F4SE Member Functions
- string Function GetName()
- Returns this form's name as a string.
- Function Form|SetName()
- Sets this form's name to the passed in string.
Events
None