tes3spellList

tes3spelllist, spelllist

A list of spells. Used by actors, birthsigns, and races.

Properties

iterator

iterator

Read-only. Deprecated. Use for index, spell in pairs(spellList) to iterate over spells.

Direct access to the spells in this list.

Returns:

• result (tes3spell[])

---

Methods

contains

contains

Checks if the specified spell is contained in the spell list.

local result = myObject:contains(spell)

Parameters:

• spell (string, tes3spell): The spell.

Returns:

• result (boolean)

---

containsType

containstype

Finds the first spell with the type provided.

local result = myObject:containsType(spellType)

Parameters:

• spellType (tes3.spellType): A value from tes3.spellType enumeration.

Returns:

• result (tes3spell)

---

getCheapest

getcheapest, cheapest

Finds the castable spell in the list with the lowest casting cost.

local result = myObject:getCheapest()

Returns:

• result (tes3spell)

---

remove

remove

Removes a spell from the list. This is deprecated, please use tes3.removeSpell instead. This function does not update any modified flags or UI systems, so it is likely to cause issues.

local result = myObject:remove(spell)

Parameters:

• spell (string, tes3spell): The spell.

Returns:

• result (boolean)