Archive/openmw
0
0
Fork 0
mirror of https://gitlab.com/OpenMW/openmw.git synced 2025-04-28 21:07:59 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 40

CLEANUP: Loop param, also, is a bool
Some checks failed
Build and test / MacOS (push) Has been cancelled
Details
Build and test / Read .env file and expose it as output (push) Has been cancelled
Details
Build and test / Ubuntu (push) Has been cancelled
Details
Build and test / Windows (2019) (push) Has been cancelled
Details
Build and test / Windows (2022) (push) Has been cancelled
Details

Browse source
This commit is contained in:
Dave Corley 2025-04-22 01:50:41 -07:00
parent 22172f3b0e
commit 5ef2cf23b3
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
files/lua_api/openmw/animation.lua
View file

@ -224,7 +224,7 @@
-- @param #string model path (normally taken from a record such as @{openmw.types#StaticRecord.model} or similar) -- @param #string model path (normally taken from a record such as @{openmw.types#StaticRecord.model} or similar)
-- @param #table options optional table of parameters. Can contain: -- @param #table options optional table of parameters. Can contain:
-- --
-- * `loop` - boolean, if true the effect will loop until removed (default: 0). -- * `loop` - boolean, if true the effect will loop until removed (default: false).
-- * `boneName` - name of the bone to attach the vfx to. (default: "") -- * `boneName` - name of the bone to attach the vfx to. (default: "")
-- * `particleTextureOverride` - name of the particle texture to use. (default: "") -- * `particleTextureOverride` - name of the particle texture to use. (default: "")
-- * `vfxId` - a string ID that can be used to remove the effect later, using #removeVfx, and to avoid duplicate effects. The default value of "" can have duplicates. To avoid interaction with the engine, use unique identifiers unrelated to magic effect IDs. The engine uses this identifier to add and remove magic effects based on what effects are active on the actor. If this is set equal to the @{openmw.core#MagicEffectId} identifier of the magic effect being added, for example core.magic.EFFECT_TYPE.FireDamage, then the engine will remove it once the fire damage effect on the actor reaches 0. (Default: ""). -- * `vfxId` - a string ID that can be used to remove the effect later, using #removeVfx, and to avoid duplicate effects. The default value of "" can have duplicates. To avoid interaction with the engine, use unique identifiers unrelated to magic effect IDs. The engine uses this identifier to add and remove magic effects based on what effects are active on the actor. If this is set equal to the @{openmw.core#MagicEffectId} identifier of the magic effect being added, for example core.magic.EFFECT_TYPE.FireDamage, then the engine will remove it once the fire damage effect on the actor reaches 0. (Default: "").