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)
This event can be filtered based on the
reference event data.
This event supports blocking by setting
true or returning
false. Blocking the event prevents vanilla behavior from happening. For example, blocking an
equip event prevents the item from being equipped.
An event can be claimed by setting
true, or by returning
false from the callback. Claiming the event prevents any lower priority callbacks from being called.
animationData(tes3animationData): Read-only. The related animation data.
currentGroup(tes3.animationGroup): The animation group that is currently playing. Maps to values in
flags(tes3.animationStartFlag): Maps to values in
group(tes3.animationGroup): The animation group about to be played. Maps to values in
index(tes3.animationBodySection): Read-only. The index of the body section the animation will be played on. Maps to values in
loopCount(number): The number of times the animation is going to be played. Infinite looping is marked by
0means the animation will be played only once (no looping).
reference(tes3reference): Read-only. The actor that is about to play the animation.