tes3spellList⚓︎
A list of spells. Used by actors, birthsigns, and races.
Properties⚓︎
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⚓︎
add⚓︎
Adds a spell to the list.
local result = myObject:add(spell)
Parameters:
spell(string, tes3spell): The spell.
Returns:
result(boolean)
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⚓︎
Finds the first spell with the type provided.
local result = myObject:containsType(spellType)
Parameters:
spellType(tes3.spellType): A value fromtes3.spellTypeenumeration.
Returns:
result(tes3spell)
getCheapest⚓︎
Finds the castable spell in the list with the lowest casting cost.
local result = myObject:getCheapest()
Returns:
result(tes3spell)
remove⚓︎
Removes a spell from the list.
local result = myObject:remove(spell)
Parameters:
spell(string, tes3spell): The spell.
Returns:
result(boolean)