tes3magicEffectInstance⚓︎
Represents an individual instance of a magic effect being applied to a reference.
Properties⚓︎
createdData⚓︎
Read-only. The bound or summoned data associated with the instance, for summoned creatures or items. The stack's object will be a reference in the case of summoned creatures.
Returns:
result(tes3equipmentStack)
cumulativeMagnitude⚓︎
No description yet available.
Returns:
result(number)
effectiveMagnitude⚓︎
The effective magnitude of the effect, after all resistances are applied.
Returns:
result(number)
isBoundItem⚓︎
Read-only. If this effect has summoned a bound item.
Returns:
result(boolean)
isSummon⚓︎
Read-only. If this effect has summoned a creature.
Returns:
result(boolean)
lastUsedArmor⚓︎
Read-only. For bound armor effects, this property stores the last used armor in the slot that this effect replaced.
Returns:
result(tes3equipmentStack)
lastUsedEnchItem⚓︎
Read-only. No description yet available.
Returns:
result(tes3equipmentStack)
lastUsedLight⚓︎
Read-only. No description yet available.
Returns:
result(tes3equipmentStack)
lastUsedShield⚓︎
Read-only. For the bound shield effect, this property stores the last used shield that this effect replaced.
Returns:
result(tes3equipmentStack)
lastUsedWeapon⚓︎
Read-only. For bound weapon effects, this property stores the last used weapon that this effect replaced. For bound armor effects that summon two pieces of armor (gauntlets, bracers, pauldrons), this property stores the last equipped armor on the right hand that this effect replaced.
Returns:
result(tes3equipmentStack)
magnitude⚓︎
The magnitude of the effect, before any resistances are applied.
Returns:
result(number)
resistedPercent⚓︎
The percentage of the magic effect that has been resisted. A value of 100 indicates that the magic effect has been completely resisted, whereas a value of 0 indicates it has not been resisted and is applied with its full magnitude. Values over 100 cause the magic effect to heal the actor instead of harming it, if it is a damaging magic effect.
Returns:
result(number)
state⚓︎
The state of this magic effect instance. Maps to tes3.spellState constants.
Returns:
result(tes3.spellState)
target⚓︎
No description yet available.
Returns:
result(tes3reference)
timeActive⚓︎
The time since the effect started affecting its target in seconds.
Returns:
result(number)
visual⚓︎
The associated visual effect.
Returns:
result(tes3vfx)