Skip to content

ClipEvent Class

Definition

Namespace: Brine2D.Animation

A named callback attached to an AnimationClip at a specific time offset. Fired by SpriteAnimator when playback crosses the event's Time.

C#
public sealed record ClipEvent : System.IEquatable<Brine2D.Animation.ClipEvent>

Inheritance System.Object → ClipEvent

Implements System.IEquatable<ClipEvent>

Constructors
ClipEvent\(string, float, Action<ClipEventArgs>, bool, Nullable<int>\) A named callback attached to an AnimationClip at a specific time offset. Fired by SpriteAnimator when playback crosses the event's Time.
Properties
Callback The action to invoke when the event fires.
FireBothDirections When true and the owning clip uses PingPong, the event also fires during the backward sweep. Ignored for non-ping-pong clips.
FrameIndex When non-null this event was registered via AddEventAtFrame\(string, int, Action<ClipEventArgs>, bool\) and its Time is automatically re-resolved whenever any frame's Duration changes.
Name Identifier for this event \(e\.g\., "footstep", "hitbox\_on"\).
Time Time in seconds from the clip start at which this event fires.