Add notes about active effects

OpenMW · Oct 24, 2023 · 5dd1f03 · 5dd1f03
1 parent e1973f3
commit 5dd1f03
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/files/lua_api/openmw/core.lua b/files/lua_api/openmw/core.lua
@@ -674,11 +674,13 @@
 
 ---
 -- @type ActiveEffect
+-- Magic effect that is currently active on an actor.
+-- Note that when this effect expires or is removed, it will remain temporarily. Magnitude will be set to 0 for effects that expire.
 -- @field #string affectedSkill Optional skill ID
 -- @field #string affectedAttribute Optional attribute ID
 -- @field #string id Effect id string
 -- @field #string name Localized name of the effect
--- @field #number magnitude
+-- @field #number magnitude current magnitude of the effect. Will be set to 0 when effect is removed or expires.
 -- @field #number magnitudeBase
 -- @field #number magnitudeModifier