ActiveEffects / ActiveSpells documentation

files/lua_api/openmw/core.lua

@@ -388,149 +388,149 @@
 
 --- `core.magic.EFFECT_TYPE`
 -- @type MagicEffectId
--- @field #number WaterBreathing waterbreathing
+-- @field #number WaterBreathing "waterbreathing"
--- @field #number SwiftSwim swiftswim
+-- @field #number SwiftSwim "swiftswim"
--- @field #number WaterWalking waterwalking
+-- @field #number WaterWalking "waterwalking"
--- @field #number Shield shield
+-- @field #number Shield "shield"
--- @field #number FireShield fireshield
+-- @field #number FireShield "fireshield"
--- @field #number LightningShield lightningshield
+-- @field #number LightningShield "lightningshield"
--- @field #number FrostShield frostshield
+-- @field #number FrostShield "frostshield"
--- @field #number Burden burden
+-- @field #number Burden "burden"
--- @field #number Feather feather
+-- @field #number Feather "feather"
--- @field #number Jump jump
+-- @field #number Jump "jump"
--- @field #number Levitate levitate
+-- @field #number Levitate "levitate"
--- @field #number SlowFall slowfall
+-- @field #number SlowFall "slowfall"
--- @field #number Lock lock
+-- @field #number Lock "lock"
--- @field #number Open open
+-- @field #number Open "open"
--- @field #number FireDamage firedamage
+-- @field #number FireDamage "firedamage"
--- @field #number ShockDamage shockdamage
+-- @field #number ShockDamage "shockdamage"
--- @field #number FrostDamage frostdamage
+-- @field #number FrostDamage "frostdamage"
--- @field #number DrainAttribute drainattribute
+-- @field #number DrainAttribute "drainattribute"
--- @field #number DrainHealth drainhealth
+-- @field #number DrainHealth "drainhealth"
--- @field #number DrainMagicka drainmagicka
+-- @field #number DrainMagicka "drainmagicka"
--- @field #number DrainFatigue drainfatigue
+-- @field #number DrainFatigue "drainfatigue"
--- @field #number DrainSkill drainskill
+-- @field #number DrainSkill "drainskill"
--- @field #number DamageAttribute damageattribute
+-- @field #number DamageAttribute "damageattribute"
--- @field #number DamageHealth damagehealth
+-- @field #number DamageHealth "damagehealth"
--- @field #number DamageMagicka damagemagicka
+-- @field #number DamageMagicka "damagemagicka"
--- @field #number DamageFatigue damagefatigue
+-- @field #number DamageFatigue "damagefatigue"
--- @field #number DamageSkill damageskill
+-- @field #number DamageSkill "damageskill"
--- @field #number Poison poison
+-- @field #number Poison "poison"
--- @field #number WeaknessToFire weaknesstofire
+-- @field #number WeaknessToFire "weaknesstofire"
--- @field #number WeaknessToFrost weaknesstofrost
+-- @field #number WeaknessToFrost "weaknesstofrost"
--- @field #number WeaknessToShock weaknesstoshock
+-- @field #number WeaknessToShock "weaknesstoshock"
--- @field #number WeaknessToMagicka weaknesstomagicka
+-- @field #number WeaknessToMagicka "weaknesstomagicka"
--- @field #number WeaknessToCommonDisease weaknesstocommondisease
+-- @field #number WeaknessToCommonDisease "weaknesstocommondisease"
--- @field #number WeaknessToBlightDisease weaknesstoblightdisease
+-- @field #number WeaknessToBlightDisease "weaknesstoblightdisease"
--- @field #number WeaknessToCorprusDisease weaknesstocorprusdisease
+-- @field #number WeaknessToCorprusDisease "weaknesstocorprusdisease"
--- @field #number WeaknessToPoison weaknesstopoison
+-- @field #number WeaknessToPoison "weaknesstopoison"
--- @field #number WeaknessToNormalWeapons weaknesstonormalweapons
+-- @field #number WeaknessToNormalWeapons "weaknesstonormalweapons"
--- @field #number DisintegrateWeapon disintegrateweapon
+-- @field #number DisintegrateWeapon "disintegrateweapon"
--- @field #number DisintegrateArmor disintegratearmor
+-- @field #number DisintegrateArmor "disintegratearmor"
--- @field #number Invisibility invisibility
+-- @field #number Invisibility "invisibility"
--- @field #number Chameleon chameleon
+-- @field #number Chameleon "chameleon"
--- @field #number Light light
+-- @field #number Light "light"
--- @field #number Sanctuary sanctuary
+-- @field #number Sanctuary "sanctuary"
--- @field #number NightEye nighteye
+-- @field #number NightEye "nighteye"
--- @field #number Charm charm
+-- @field #number Charm "charm"
--- @field #number Paralyze paralyze
+-- @field #number Paralyze "paralyze"
--- @field #number Silence silence
+-- @field #number Silence "silence"
--- @field #number Blind blind
+-- @field #number Blind "blind"
--- @field #number Sound sound
+-- @field #number Sound "sound"
--- @field #number CalmHumanoid calmhumanoid
+-- @field #number CalmHumanoid "calmhumanoid"
--- @field #number CalmCreature calmcreature
+-- @field #number CalmCreature "calmcreature"
--- @field #number FrenzyHumanoid frenzyhumanoid
+-- @field #number FrenzyHumanoid "frenzyhumanoid"
--- @field #number FrenzyCreature frenzycreature
+-- @field #number FrenzyCreature "frenzycreature"
--- @field #number DemoralizeHumanoid demoralizehumanoid
+-- @field #number DemoralizeHumanoid "demoralizehumanoid"
--- @field #number DemoralizeCreature demoralizecreature
+-- @field #number DemoralizeCreature "demoralizecreature"
--- @field #number RallyHumanoid rallyhumanoid
+-- @field #number RallyHumanoid "rallyhumanoid"
--- @field #number RallyCreature rallycreature
+-- @field #number RallyCreature "rallycreature"
--- @field #number Dispel dispel
+-- @field #number Dispel "dispel"
--- @field #number Soultrap soultrap
+-- @field #number Soultrap "soultrap"
--- @field #number Telekinesis telekinesis
+-- @field #number Telekinesis "telekinesis"
--- @field #number Mark mark
+-- @field #number Mark "mark"
--- @field #number Recall recall
+-- @field #number Recall "recall"
--- @field #number DivineIntervention divineintervention
+-- @field #number DivineIntervention "divineintervention"
--- @field #number AlmsiviIntervention almsiviintervention
+-- @field #number AlmsiviIntervention "almsiviintervention"
--- @field #number DetectAnimal detectanimal
+-- @field #number DetectAnimal "detectanimal"
--- @field #number DetectEnchantment detectenchantment
+-- @field #number DetectEnchantment "detectenchantment"
--- @field #number DetectKey detectkey
+-- @field #number DetectKey "detectkey"
--- @field #number SpellAbsorption spellabsorption
+-- @field #number SpellAbsorption "spellabsorption"
--- @field #number Reflect reflect
+-- @field #number Reflect "reflect"
--- @field #number CureCommonDisease curecommondisease
+-- @field #number CureCommonDisease "curecommondisease"
--- @field #number CureBlightDisease cureblightdisease
+-- @field #number CureBlightDisease "cureblightdisease"
--- @field #number CureCorprusDisease curecorprusdisease
+-- @field #number CureCorprusDisease "curecorprusdisease"
--- @field #number CurePoison curepoison
+-- @field #number CurePoison "curepoison"
--- @field #number CureParalyzation cureparalyzation
+-- @field #number CureParalyzation "cureparalyzation"
--- @field #number RestoreAttribute restoreattribute
+-- @field #number RestoreAttribute "restoreattribute"
--- @field #number RestoreHealth restorehealth
+-- @field #number RestoreHealth "restorehealth"
--- @field #number RestoreMagicka restoremagicka
+-- @field #number RestoreMagicka "restoremagicka"
--- @field #number RestoreFatigue restorefatigue
+-- @field #number RestoreFatigue "restorefatigue"
--- @field #number RestoreSkill restoreskill
+-- @field #number RestoreSkill "restoreskill"
--- @field #number FortifyAttribute fortifyattribute
+-- @field #number FortifyAttribute "fortifyattribute"
--- @field #number FortifyHealth fortifyhealth
+-- @field #number FortifyHealth "fortifyhealth"
--- @field #number FortifyMagicka fortifymagicka
+-- @field #number FortifyMagicka "fortifymagicka"
--- @field #number FortifyFatigue fortifyfatigue
+-- @field #number FortifyFatigue "fortifyfatigue"
--- @field #number FortifySkill fortifyskill
+-- @field #number FortifySkill "fortifyskill"
--- @field #number FortifyMaximumMagicka fortifymaximummagicka
+-- @field #number FortifyMaximumMagicka "fortifymaximummagicka"
--- @field #number AbsorbAttribute absorbattribute
+-- @field #number AbsorbAttribute "absorbattribute"
--- @field #number AbsorbHealth absorbhealth
+-- @field #number AbsorbHealth "absorbhealth"
--- @field #number AbsorbMagicka absorbmagicka
+-- @field #number AbsorbMagicka "absorbmagicka"
--- @field #number AbsorbFatigue absorbfatigue
+-- @field #number AbsorbFatigue "absorbfatigue"
--- @field #number AbsorbSkill absorbskill
+-- @field #number AbsorbSkill "absorbskill"
--- @field #number ResistFire resistfire
+-- @field #number ResistFire "resistfire"
--- @field #number ResistFrost resistfrost
+-- @field #number ResistFrost "resistfrost"
--- @field #number ResistShock resistshock
+-- @field #number ResistShock "resistshock"
--- @field #number ResistMagicka resistmagicka
+-- @field #number ResistMagicka "resistmagicka"
--- @field #number ResistCommonDisease resistcommondisease
+-- @field #number ResistCommonDisease "resistcommondisease"
--- @field #number ResistBlightDisease resistblightdisease
+-- @field #number ResistBlightDisease "resistblightdisease"
--- @field #number ResistCorprusDisease resistcorprusdisease
+-- @field #number ResistCorprusDisease "resistcorprusdisease"
--- @field #number ResistPoison resistpoison
+-- @field #number ResistPoison "resistpoison"
--- @field #number ResistNormalWeapons resistnormalweapons
+-- @field #number ResistNormalWeapons "resistnormalweapons"
--- @field #number ResistParalysis resistparalysis
+-- @field #number ResistParalysis "resistparalysis"
--- @field #number RemoveCurse removecurse
+-- @field #number RemoveCurse "removecurse"
--- @field #number TurnUndead turnundead
+-- @field #number TurnUndead "turnundead"
--- @field #number SummonScamp summonscamp
+-- @field #number SummonScamp "summonscamp"
--- @field #number SummonClannfear summonclannfear
+-- @field #number SummonClannfear "summonclannfear"
--- @field #number SummonDaedroth summondaedroth
+-- @field #number SummonDaedroth "summondaedroth"
--- @field #number SummonDremora summondremora
+-- @field #number SummonDremora "summondremora"
--- @field #number SummonAncestralGhost summonancestralghost
+-- @field #number SummonAncestralGhost "summonancestralghost"
--- @field #number SummonSkeletalMinion summonskeletalminion
+-- @field #number SummonSkeletalMinion "summonskeletalminion"
--- @field #number SummonBonewalker summonbonewalker
+-- @field #number SummonBonewalker "summonbonewalker"
--- @field #number SummonGreaterBonewalker summongreaterbonewalker
+-- @field #number SummonGreaterBonewalker "summongreaterbonewalker"
--- @field #number SummonBonelord summonbonelord
+-- @field #number SummonBonelord "summonbonelord"
--- @field #number SummonWingedTwilight summonwingedtwilight
+-- @field #number SummonWingedTwilight "summonwingedtwilight"
--- @field #number SummonHunger summonhunger
+-- @field #number SummonHunger "summonhunger"
--- @field #number SummonGoldenSaint summongoldensaint
+-- @field #number SummonGoldenSaint "summongoldensaint"
--- @field #number SummonFlameAtronach summonflameatronach
+-- @field #number SummonFlameAtronach "summonflameatronach"
--- @field #number SummonFrostAtronach summonfrostatronach
+-- @field #number SummonFrostAtronach "summonfrostatronach"
--- @field #number SummonStormAtronach summonstormatronach
+-- @field #number SummonStormAtronach "summonstormatronach"
--- @field #number FortifyAttack fortifyattack
+-- @field #number FortifyAttack "fortifyattack"
--- @field #number CommandCreature commandcreature
+-- @field #number CommandCreature "commandcreature"
--- @field #number CommandHumanoid commandhumanoid
+-- @field #number CommandHumanoid "commandhumanoid"
--- @field #number BoundDagger bounddagger
+-- @field #number BoundDagger "bounddagger"
--- @field #number BoundLongsword boundlongsword
+-- @field #number BoundLongsword "boundlongsword"
--- @field #number BoundMace boundmace
+-- @field #number BoundMace "boundmace"
--- @field #number BoundBattleAxe boundbattleaxe
+-- @field #number BoundBattleAxe "boundbattleaxe"
--- @field #number BoundSpear boundspear
+-- @field #number BoundSpear "boundspear"
--- @field #number BoundLongbow boundlongbow
+-- @field #number BoundLongbow "boundlongbow"
--- @field #number ExtraSpell extraspell
+-- @field #number ExtraSpell "extraspell"
--- @field #number BoundCuirass boundcuirass
+-- @field #number BoundCuirass "boundcuirass"
--- @field #number BoundHelm boundhelm
+-- @field #number BoundHelm "boundhelm"
--- @field #number BoundBoots boundboots
+-- @field #number BoundBoots "boundboots"
--- @field #number BoundShield boundshield
+-- @field #number BoundShield "boundshield"
--- @field #number BoundGloves boundgloves
+-- @field #number BoundGloves "boundgloves"
--- @field #number Corprus corprus
+-- @field #number Corprus "corprus"
--- @field #number Vampirism vampirism
+-- @field #number Vampirism "vampirism"
--- @field #number SummonCenturionSphere summoncenturionsphere
+-- @field #number SummonCenturionSphere "summoncenturionsphere"
--- @field #number SunDamage sundamage
+-- @field #number SunDamage "sundamage"
--- @field #number StuntedMagicka stuntedmagicka
+-- @field #number StuntedMagicka "stuntedmagicka"
--- @field #number SummonFabricant summonfabricant
+-- @field #number SummonFabricant "summonfabricant"
--- @field #number SummonWolf summonwolf
+-- @field #number SummonWolf "summonwolf"
--- @field #number SummonBear summonbear
+-- @field #number SummonBear "summonbear"
--- @field #number SummonBonewolf summonbonewolf
+-- @field #number SummonBonewolf "summonbonewolf"
--- @field #number SummonCreature04 summoncreature04
+-- @field #number SummonCreature04 "summoncreature04"
--- @field #number SummonCreature05 summoncreature05
+-- @field #number SummonCreature05 "summoncreature05"
 
 
 --- Possible @{#SpellType} values
@@ -557,7 +557,7 @@
 --     end
 -- end
 
---- Map from effect id to @{#MagicEffect}
+--- Map from @{#MagicEffectId} to @{#MagicEffect}
 -- @field [parent=#Magic] #map<#number, #MagicEffect> effects
 -- @usage -- Print all harmful effects
 -- for _, effect in pairs(core.magic.effects) do
@@ -576,8 +576,8 @@
 
 ---
 -- @type MagicEffect
--- @field #number id
+-- @field #number Effect id string
--- @field #string name
+-- @field #string name Localized name of the effect
 -- @field #number school @{#MagicSchool}
 -- @field #number baseCost
 -- @field openmw.util#Color color
@@ -593,5 +593,15 @@
 -- @field #number magnitudeMin
 -- @field #number magnitudeMax
 
+---
+-- @type ActiveEffect
+-- @field #ActiveEffect effect @{#ActiveEffect}
+-- @field #any affectedSkill @{#SKILL} or nil
+-- @field #any affectedAttribute @{#ATTRIBUTE} or nil
+-- @field #number id Effect id string
+-- @field #number name Localized name of the effect
+-- @field #number magnitude
+-- @field #number magnitudeBase
+-- @field #number magnitudeModifier
 
 return nil

files/lua_api/openmw/types.lua

@@ -162,7 +162,67 @@
 -- @param openmw.core#Spell spell Spell (can be nil)
 
 ---
--- Return the spells (@{ActorSpells}) of the given actor.
+-- Return the active magic effects (@{#ActorActiveEffects}) currently affecting the given actor.
+-- @function [parent=#Actor] activeEffects
+-- @param openmw.core#GameObject actor
+-- @return #ActorActiveEffects
+
+--- Read-only list of effects currently affecting the actor.
+-- @type ActorActiveEffects
+-- @usage -- print active effects
+-- for _, effect in pairs(Actor.activeEffects(self)) do
+--     print('Active Effect: '..effect.id..', attribute='..tostring(effect.affectedAttribute)..', skill='..tostring(effect.affectedSkill)..', magnitude='..tostring(effect.magnitude))
+-- end
+-- @usage -- Check for a specific effect
+-- local effect = Actor.activeEffects(self):getEffect(core.magic.EFFECT_TYPE.Telekinesis)
+-- if effect then
+--     print(effect.id..', attribute='..tostring(effect.affectedAttribute)..', skill='..tostring(effect.affectedSkill)..', magnitude='..tostring(effect.magnitude))
+-- else
+--     print('No Telekinesis effect')
+-- end
+-- @usage -- Check for a specific effect targeting a specific attribute.
+-- local effect = Actor.activeEffects(self):getEffect(core.magic.EFFECT_TYPE.FortifyAttribute, core.ATTRIBUTE.Luck)
+-- if effect then
+--     print(effect.id..', attribute='..tostring(effect.affectedAttribute)..', skill='..tostring(effect.affectedSkill)..', magnitude='..tostring(effect.magnitude))
+-- else
+--     print('No Fortify Luck effect')
+-- end
+
+---
+-- Get a specific active effect on the actor.
+-- @function [parent=#ActorActiveEffects] getEffect
+-- @param self
+-- @param string effect ID
+-- @return #ActiveEffect if such an effect is active, nil otherwise
+
+---
+-- Return the active spells (@{#ActorActiveSpells}) currently affecting the given actor.
+-- @function [parent=#Actor] activeSpells
+-- @param openmw.core#GameObject actor
+-- @return #ActorActiveSpells
+
+--- Read-only list of spells currently affecting the actor.
+-- @type ActorActiveSpells
+-- @usage -- print active spells
+-- for _, spell in pairs(Actor.activeSpells(self)) do
+--     print('Active Spell: '..tostring(spell))
+-- end
+-- @usage -- Check for a specific spell
+-- if Actor.activeSpells(self):isSpellActive('bound longbow') then
+--     print('Player has bound longbow')
+-- else
+--     print('Player does not have bound longbow')
+-- end
+
+---
+-- Get whether a specific spell is active on the actor.
+-- @function [parent=#ActorActiveSpells] isSpellActive
+-- @param self
+-- @param #any spellOrId @{openmw.core#Spell} or string spell id
+-- @return true if spell is active, false otherwise
+
+---
+-- Return the spells (@{#ActorSpells}) of the given actor.
 -- @function [parent=#Actor] spells
 -- @param openmw.core#GameObject actor
 -- @return #ActorSpells