You can define animation event markers across the timeline span and use GetMarkerReachedSignal() to detect those markers as the animation runs.
Showing Events
By default, the event track isn't visible. To show the event track:
Navigate to the right of the timeline, then click the Gear icon. A pop-up menu displays.
Select Show Animation Events. This opens the Animation Events bar directly below the media and playback controls.
You can now create, detect, and duplicate events.
Creating Events
Event markers are visual indicators of where an animation event begins. After you create an event marker, you can move it to any frame position on the timeline.
To create a new event marker:
Navigate to the timeline, then click-and-drag the scrubber to the frame position where the event should occur.
Navigate to the event track, then click the Edit Animation Events button. The Edit Animation Events dialog displays.
In the Edit Animation Events dialog, click + Add Event, then enter an event name.
(Optional) In the Parameter field, enter a parameter string for the event.
Click the Save button. In the events bar within the timeline, a new marker symbol displays at the frame position.
Detecting Events
To detect animation events in a LocalScript, connect a function to the GetMarkerReachedSignal() function of AnimationTrack. For example:
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local character = player.Character or player.CharacterAdded:Wait()
local humanoid = character:WaitForChild("Humanoid")
local animator = humanoid:WaitForChild("Animator")
-- Create new "Animation" instance
local walkAnim = Instance.new("Animation")
-- Set its "AnimationId" to the corresponding animation asset ID
walkAnim.AnimationId = "rbxassetid://5432167890"
-- Load animation onto the animator
local walkAnimTrack = animator:LoadAnimation(walkAnim)
-- Connect "GetMarkerReachedSignal" event to a specific named keyframe
walkAnimTrack:GetMarkerReachedSignal("FootStep"):Connect(function(paramString)
print(paramString)
end)
You can specify a Parameter value for any event marker within the Animation Editor. This lets you pass a custom string (single value, comma-separated string, etc.) to the GetMarkerReachedSignal() function, as illustrated by the paramString argument in the code example above. This string can then be parsed or converted, if necessary, and used for whatever action you wish to perform in the event.
Duplicating Events
As you create events, they become available for usage throughout the whole animation, not only at the frame position where you originally created them. For instance, you can create a "FootStep" event marker at the point where a character's left foot touches down, then use the same event when the character's right foot touches down.
To duplicate an event:
Navigate to the timeline, then click an event marker in the event bar.
Press CtrlC (⌘C on Mac).
Click-and-drag the scrubber to the frame position where you want to duplicate the event.
Press CtrlV (⌘V on Mac).
If the original event uses a parameter but the duplicated event should use a modified parameter, perform the following steps:
- Right-click the duplicated event marker. A pop-up menu displays.
- Select Edit Animation Event. The Edit Animation Events dialog displays.
- Make your changes, then click the Save button.
You can also duplicate events by clicking the Edit Animation Events button (just as if you were creating a new event), clicking Add Event in the pop-up menu, selecting the desired event from the dropdown, and clicking Save.