@minecraft
    Preparing search index...

    Interface ITimelinePlayer

    A pane that hosts a single playhead and a collection of timeline entries that share it

    interface ITimelinePlayer {
        enable: boolean;
        entryCount: number;
        id: string;
        paneId: string;
        typeName: PropertyItemType;
        visible: boolean;
        addGroup(
            id: string,
            name: LocalizedString,
            tooltip?: LocalizedString,
        ): void;
        addVector3Timeline(
            options: IVector3TimelinePlayerEntryOptions,
        ): IVector3TimelinePlayerEntry;
        getDuration(): number;
        getEntryById(id: string): ITimelinePlayerEntry;
        getEntryByIndex(index: number): ITimelinePlayerEntry;
        getGroups(): ITimelinePlayerGroup[];
        getPlaybackState(): TimelinePlayerPlaybackState;
        getPrecision(): number;
        getSelectedGroupId(): string;
        getTime(): number;
        hide(): void;
        removeEntry(id: string): boolean;
        removeGroup(id: string): void;
        renameGroup(id: string, newName: LocalizedString): void;
        setDuration(duration: number): void;
        setPlaybackState(state: TimelinePlayerPlaybackState): void;
        setPrecision(precision: number): void;
        setSelectedGroupId(id: string): void;
        setTime(time: number): void;
        show(): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    enable entryCount id paneId typeName visible

    Methods

    addGroup addVector3Timeline getDuration getEntryById getEntryByIndex getGroups getPlaybackState getPrecision getSelectedGroupId getTime hide removeEntry removeGroup renameGroup setDuration setPlaybackState setPrecision setSelectedGroupId setTime show

    Properties

    enable: boolean

    If the item is enabled in the UI.

    entryCount: number

    Number of timeline entries owned by this player.

    id: string

    Unique ID for the property item.

    paneId: string

    The parent pane id.

    typeName: PropertyItemType

    The type name of the target property.

    visible: boolean

    If the item should be visible in the UI.

    Methods

    • Parameters

      • id: string

        Identifier of the group to remove.

      Returns void

      Remove a group from the dropdown.

    • Parameters

      • duration: number

        New duration in seconds.

      Returns void

      Set the total duration in seconds.

    • Parameters

      • precision: number

        Decimal precision.

      Returns void

      Set the decimal precision used for keyframe time spacing.

    • Parameters

      • id: string

        Identifier of the group to select.

      Returns void

      Set the selected group.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods