PcoWSkbVqDnWTu_dm2ix
Collapse Sidebar
  1. API Reference
  2. KeyframeMarker

KeyframeMarker

Show deprecated
Hide content
Content
  1. apireference
  2. keyframemarker

KeyframeMarker

Show deprecated

A KeyframeMarker is an instance meant to represent an event that will eventually be fired when a Keyframe is hit.

Using a KeyframeMarker

KeyframeMarkers should always be parented to a Keyframe via setting the parent directly or using the Keyframe/AddMarker function of Keyframe. KeyframeMarkers can also be removed directly or using the Keyframe/RemoveMarker function, and polled to check which markers are attached to a specific Keyframe using Keyframe/GetMarkers.

Whenever a Keyframe is detected as an animation is running, there will be an event fired for each KeyframeMarker that is parented to the Keyframe. These events are identifiable by the name of the KeyframeMarker. You can retrieve and listen to these events using the AnimationTrack/GetKeyframeMarkerReached function. Optionally, you may set the KeyframeMarker/Value property of the KeyframeMarker in order to pass along a value with the event being fired.

It inherits the Instance/Name|Keyframe.Name property from Instance and behaves identically. Names are used for identification and no not need to be unique. When multiple KeyFrameMarkers with the same name are attached to a KeyFrame, events such as the one returned by AnimationTrack/GetMarkerReachedSignal will fire for every marker.

See also

  • Keyframe, holds the Pose|Poses applied to joints in a Model at a given point of time in an animation
  • AnimationTrack, controls the playback of an animation on a Humanoid or AnimationController
  • Animation, holds a reference to animation data required to play custom animations on characters or other models using the Roblox animation system

Properties

string

Value

A value that is specified for a KeyframeMarker

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.
string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to
int

DataCost

[ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.
string

Name

A non-unique identifier of the Instance
Instance

Parent

[NotReplicated]

Determines the hierarchical parent of the Instance
bool

RobloxLocked

A deprecated property that used to protect CoreGui objects
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance's children.
Instance

Clone ( )

Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable
void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections and calls Destroy on all children.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.
Instance

GetActor ( )

Variant

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name
RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes
Dictionary

GetAttributes ( )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes
Objects

GetChildren ( )

Returns an array containing all of the Instance's children.
string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.
Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance
string

GetFullName ( )

Returns a string describing the Instance's ancestry.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance's class matches or inherits from a given class
bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.
void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.
void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.
Objects

children ( )

[Deprecated]

Returns an array of the object’s children.
Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.
RBXScriptSignal

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this Instance.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this Instance.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the Instance
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.
RBXScriptSignal

childAdded ( Instance child )

[Deprecated]

Code Samples

Listening to Keyframe Markers

This LocalScript code waits for the local player’s Humanoid object to load, then it creates a new Animation instance with the proper Animation/AnimationId|AnimationId. The animation is then loaded onto the humanoid, creating an AnimationTrack, and the track is played with AnimationTrack/Play|AnimationTrack:Play(). Following that, the AnimationTrack/GetMarkerReachedSignal|GetMarkerReachedSignal() function detects when the “KickEnd” marker is hit.

Copy Code Light Theme

Get Keyframe Markers Attached to a Keyframe

This example demonstrates the Keyframe/AddMarker and Keyframe/GetMarkers functions. After adding two markers, marker1 and marker2 to the keyframe, this example gets and prints the names of the added markers.

Copy Code Light Theme
Keyframe KeyframeSequence