Difference between revisions of "Form Script"
m
→Member Functions: Added the missing return type (bool) for "PlayerKnows".
imported>ShadeMe (Add missing F4SE member functions) |
imported>Homecom m (→Member Functions: Added the missing return type (bool) for "PlayerKnows".) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
'''Extends:''' [[ScriptObject Script|ScriptObject]] | '''Extends:''' [[ScriptObject Script|ScriptObject]] | ||
| Line 26: | 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 34: | Line 31: | ||
== F4SE Member Functions == | == F4SE Member Functions == | ||
*string Function [[GetDescription - Form|GetDescription]]() | *string Function [[GetDescription - Form|GetDescription]]() | ||
**Returns this form's description as a string. | **Returns this form's description as a string. | ||
| Line 57: | Line 51: | ||
*string Function [[GetMessageIconPath - Form|GetMessageIconPath]]() | *string Function [[GetMessageIconPath - Form|GetMessageIconPath]]() | ||
**Returns this form's message icon path as a string. | **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]]() | *string Function [[GetWorldModelPath - Form|GetWorldModelPath]]() | ||
| Line 66: | Line 63: | ||
*bool Function [[HasWorldModel - Form|HasWorldModel]]() | *bool Function [[HasWorldModel - Form|HasWorldModel]]() | ||
**Returns if this form has a world model. | **Returns if this form has a world model. | ||
*Function [[SetEnchantment - Form|SetEnchantment]](Enchantment akNewEnchant) | *Function [[SetEnchantment - Form|SetEnchantment]](Enchantment akNewEnchant) | ||
| Line 78: | Line 72: | ||
*Function [[SetEquipType - Form|SetEquipType]](EquipSlot akType) | *Function [[SetEquipType - Form|SetEquipType]](EquipSlot akType) | ||
**Set this form's Equip Slot. | **Set this form's Equip Slot. | ||
*Function [[SetGoldValue - Form|SetGoldValue]](int aiValue) | |||
**Set this form's gold value. | |||
*Function [[SetIconPath - Form|SetIconPath]](string asPath) | *Function [[SetIconPath - Form|SetIconPath]](string asPath) | ||
| Line 84: | Line 81: | ||
*Function [[SetMessageIconPath - Form|SetMessageIconPath]](string asPath) | *Function [[SetMessageIconPath - Form|SetMessageIconPath]](string asPath) | ||
**Set this form's message icon path. | **Set this form's message icon path. | ||
*Function [[SetName - Form|SetName]](string asName) | |||
**Set this form's name. | |||
*Function [[SetWorldModelPath - Form|SetWorldModelPath]](string asPath) | *Function [[SetWorldModelPath - Form|SetWorldModelPath]](string asPath) | ||
| Line 90: | Line 90: | ||
*Function [[SetWeight - Form|SetWeight]](float afWeight) | *Function [[SetWeight - Form|SetWeight]](float afWeight) | ||
**Set this form's weight. | **Set this form's weight. | ||
== Events == | == Events == | ||
None | None | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Script Objects]] | |||