tes3effect⚓︎
A structure that defines information for an effect and its associated variables, typically found on spells, alchemy, and enchantments.
Properties⚓︎
attribute⚓︎
The attribute associated with this effect, or nil if no attribute is used. Maps to values from tes3.attribute table.
Returns:
result(tes3.attribute, nil)
cost⚓︎
The final magicka cost of this effect after all the calculations of magnitude, duration, radius and range have taken place.
Returns:
result(number)
duration⚓︎
How long the effect should last.
Returns:
result(integer)
id⚓︎
The base tes3magicEffect ID that the effect uses. Maps to values from tes3.effect table.
Returns:
result(tes3.effect, integer)
max⚓︎
The maximum magnitude of the effect.
Returns:
result(integer)
min⚓︎
The minimum magnitude of the effect.
Returns:
result(integer)
object⚓︎
Read-only. Fetches the tes3magicEffect for the given id used.
Returns:
result(tes3magicEffect)
radius⚓︎
The radius of the effect in feet. The game units reference page covers how to convert between feet and game units.
Returns:
result(integer)
rangeType⚓︎
Determines if the effect is self, touch, or target ranged. Maps to tes3.effectRange constants.
Returns:
result(tes3.effectRange)
skill⚓︎
The skill associated with this effect, or nil if no skill is used. Maps to values from tes3.skill table.
Returns:
result(tes3.skill, nil)