playGroup⚓︎
This event is triggered when an animation is about to be played.
--- @param e playGroupEventData
local function playGroupCallback(e)
end
event.register(tes3.event.playGroup, playGroupCallback)
Tip
This event can be filtered based on the reference
event data.
Tip
This event supports blocking by setting e.block
to true
or returning false
. Blocking the event prevents vanilla behavior from happening. For example, blocking an equip
event prevents the item from being equipped.
Tip
An event can be claimed by setting e.claim
to true
, or by returning false
from the callback. Claiming the event prevents any lower priority callbacks from being called.
Event Data⚓︎
animationData
(tes3animationData): Read-only. The related animation data.currentGroup
(tes3.animationGroup): The animation group that is currently playing. Maps to values intes3.animationGroup
namespace.flags
(tes3.animationStartFlag): Maps to values intes3.animationStartFlag
namespace.group
(tes3.animationGroup): The animation group about to be played. Maps to values intes3.animationGroup
namespace.index
(tes3.animationBodySection): Read-only. The index of the body section the animation will be played on. Maps to values intes3.animationBodySection
namespace.loopCount
(number): The number of times the animation is going to be played. Infinite looping is marked by-1
, while0
means the animation will be played only once (no looping).reference
(tes3reference): Read-only. The actor that is about to play the animation.