Form Script

From Creation Kit
Jump to: navigation, search

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

F4SE Member Functions

  • string Function GetDescription()
    • Returns this form's description as a string.
  • Enchantment Function GetEnchantment()
    • Returns this form's enchantment.
  • 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 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 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 SetName(string asName)
    • Set this form's name.
  • Function SetWeight(float afWeight)
    • Set this form's weight.

Events

None