Difference between revisions of "Form Script"
m
→Member Functions: Added the missing return type (bool) for "PlayerKnows".
imported>Plplecuyer |
imported>Homecom m (→Member Functions: Added the missing return type (bool) for "PlayerKnows".) |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
'''Extends:''' [[ScriptObject Script|ScriptObject]] | '''Extends:''' [[ScriptObject Script|ScriptObject]] | ||
Native base script for every form in the game. | Native base script for every form in the game. | ||
| Line 25: | Line 23: | ||
*bool Function [[HasKeywordInFormList - Form|HasKeywordInFormList]](FormList akKeywordList) | *bool Function [[HasKeywordInFormList - Form|HasKeywordInFormList]](FormList akKeywordList) | ||
**Returns if this form has any of the keywords in the [[FormList Script|FormList]] attached. | **Returns if this form has any of the keywords in the [[FormList Script|FormList]] attached. | ||
*Function [[PlayerKnows - Form|PlayerKnows]]() | *bool Function [[PlayerKnows - Form|PlayerKnows]]() | ||
**Is the "Known" flag set on the form? | **Is the "Known" flag set on the form? | ||
*Function [[StartObjectProfiling - Form|StartObjectProfiling]]() | *Function [[StartObjectProfiling - Form|StartObjectProfiling]]() | ||
| Line 31: | Line 29: | ||
*Function [[StopObjectProfiling - Form|StopObjectProfiling]]() | *Function [[StopObjectProfiling - Form|StopObjectProfiling]]() | ||
**Stops profiling all scripts attached to this form. | **Stops profiling all scripts attached to this form. | ||
== F4SE Member Functions == | |||
*string Function [[GetDescription - Form|GetDescription]]() | |||
**Returns this form's description as a string. | |||
*Enchantment Function [[GetEnchantment - Form|GetEnchantment]]() | |||
**Returns this form's enchantment. | |||
*int Function [[GetEnchantmentValue - Form|GetEnchantmentValue]]() | |||
**Returns this form's enchantment's value. | |||
*EquipSlot Function [[GetEquipType - Form|GetEquipType]]() | |||
**Returns this form's Equip Slot. | |||
*string Function [[GetIconPath - Form|GetIconPath]]() | |||
**Returns this form's icon path as a string. | |||
*Keyword[] Function [[GetKeywords - Form|GetKeywords]]() | |||
**Returns this form's keywords. | |||
*string Function [[GetMessageIconPath - Form|GetMessageIconPath]]() | |||
**Returns this form's message icon path as a string. | |||
*string Function [[GetName - Form|GetName]]() | |||
**Returns this form's name as a string. | |||
*string Function [[GetWorldModelPath - Form|GetWorldModelPath]]() | |||
**Returns this form's world model path as a string. | |||
*float Function [[GetWeight - Form|GetWeight]]() | |||
**Returns this form's weight as a float. | |||
*bool Function [[HasWorldModel - Form|HasWorldModel]]() | |||
**Returns if this form has a world model. | |||
*Function [[SetEnchantment - Form|SetEnchantment]](Enchantment akNewEnchant) | |||
**Set this form's enchantment. | |||
*Function [[SetEnchantmentValue - Form|SetEnchantmentValue]](int aiValue) | |||
**Set this form's enchantment's value. | |||
*Function [[SetEquipType - Form|SetEquipType]](EquipSlot akType) | |||
**Set this form's Equip Slot. | |||
*Function [[SetGoldValue - Form|SetGoldValue]](int aiValue) | |||
**Set this form's gold value. | |||
*Function [[SetIconPath - Form|SetIconPath]](string asPath) | |||
**Set this form's icon path. | |||
*Function [[SetMessageIconPath - Form|SetMessageIconPath]](string asPath) | |||
**Set this form's message icon path. | |||
*Function [[SetName - Form|SetName]](string asName) | |||
**Set this form's name. | |||
*Function [[SetWorldModelPath - Form|SetWorldModelPath]](string asPath) | |||
**Set this form's world model path. | |||
*Function [[SetWeight - Form|SetWeight]](float afWeight) | |||
**Set this form's weight. | |||
== Events == | == Events == | ||
None | None | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Script Objects]] | |||