API
Babylon Lite API|
AnimationGroup

Interface AnimationGroup

User-facing animation group — one per animation clip. Pure state.

interface AnimationGroup {
    currentTime: number;
    duration: number;
    frameRate?: number;
    isPlaying: boolean;
    loopAnimation: boolean;
    mask?: AnimationGroupMask;
    metadata?: LiteMetadata;
    name: string;
    speedRatio: number;
    targetedAnimations: readonly TargetedAnimation[];
    weight: number;
}
Index
currentTime duration frameRate? isPlaying loopAnimation mask? metadata? name speedRatio targetedAnimations weight
currentTime: number

Current playback time in seconds.

duration: number

Duration in seconds.

frameRate?: number

Frame rate used by goToFrame().

isPlaying: boolean

True if currently playing.

loopAnimation: boolean

Whether animation loops (default true).

mask?: AnimationGroupMask

Optional include/exclude target-name mask. When set, only targets the mask retains animate; masked-out targets stay at their bind/rest pose. Matched by glTF node / bone name. See createAnimationGroupMask. To update an active mask, change its mode/disabled, replace its names array, or reassign group.mask; in-place same-length edits of names are not picked up.

metadata?: LiteMetadata

User metadata bag.

name: string

Name of this animation.

speedRatio: number

Playback speed multiplier (default 1).

targetedAnimations: readonly TargetedAnimation[]

Lightweight list of targets affected by this group.

weight: number

Weighted contribution used by AnimationManager mixing (default 1).