1
0
mirror of https://gitlab.com/OpenMW/openmw.git synced 2025-01-29 18:32:36 +00:00

Add notes about active effects

This commit is contained in:
Zackhasacat 2023-10-23 23:44:54 -05:00
parent e1973f342e
commit 5dd1f0332f

View File

@ -674,11 +674,13 @@
--- ---
-- @type ActiveEffect -- @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 affectedSkill Optional skill ID
-- @field #string affectedAttribute Optional attribute ID -- @field #string affectedAttribute Optional attribute ID
-- @field #string id Effect id string -- @field #string id Effect id string
-- @field #string name Localized name of the effect -- @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 magnitudeBase
-- @field #number magnitudeModifier -- @field #number magnitudeModifier