Form Script

Extends: ScriptObject

Native base script for every form in the game.

Definition

ScriptName Form extends ScriptObject Native Hidden

Properties

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 GetDescription()
  • Returns this form's description as a string.

• Enchantment Function GetEnchantment()
  • Returns this form's enchantment.

• int Function GetEnchantmentValue()
  • Returns this form's enchantment's value.

• EquipSlot Function GetEquipType()
  • Returns this form's Equip Slot.

• string Function GetIconPath()
  • Returns this form's icon path as a string.

• Keyword[] Function GetKeywords()
  • Returns this form's keywords.

• string Function GetMessageIconPath()
  • Returns this form's message icon path as a string.

• string Function GetName()
  • Returns this form's name as a string.

• string Function GetWorldModelPath()
  • Returns this form's world model path as a string.

• float Function GetWeight()
  • Returns this form's weight as a float.

• bool Function HasWorldModel()
  • Returns if this form has a world model.

• Function SetEnchantment(Enchantment akNewEnchant)
  • Set this form's enchantment.

• Function SetEnchantmentValue(int aiValue)
  • Set this form's enchantment's value.

• Function SetEquipType(EquipSlot akType)
  • Set this form's Equip Slot.

• Function SetGoldValue(int aiValue)
  • Set this form's gold value.

• Function SetIconPath(string asPath)
  • Set this form's icon path.

• Function SetMessageIconPath(string asPath)
  • Set this form's message icon path.

• Function SetName(string asName)
  • Set this form's name.

• Function SetWorldModelPath(string asPath)
  • Set this form's world model path.

• Function SetWeight(float afWeight)
  • Set this form's weight.

Events

None