Blockbench Reference Docs
    Preparing search index...

    Class _Animation

    ⚠️ THIS IS TYPE ONLY ⚠️

    It does not exist in Blockbench at Run-time. Use Blockbench.Animation instead.

    Blockbench overwrites libdom's Animation type with its own Animation Class, but TypeScript doesn't include a way to overwrite UMD global types. To get around this, we changed the name of this class type declaration to _Animation and use that in the type definitions.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    anim_time_update animators blend_weight effects? file_menu length loop loop_delay markers menu name override path playing saved saved_name? selected snapping start_delay time type uuid all selected

    Methods

    add calculateSnappingFromKeyframes compileBedrockAnimation createUniqueName extend getBoneAnimator getMaxLength getUndoCopy propertiesDialog remove rename save select setLength setLoop showContextMenu togglePlayingState

    Constructors

    Properties

    anim_time_update: string
    animators: { [id: string]: GeneralAnimator }
    blend_weight: string
    effects?: EffectAnimator
    file_menu: Menu
    length: number
    loop: "once" | "hold" | "loop"
    loop_delay: string
    markers: TimelineMarker[]
    menu: Menu
    name: string
    override: boolean
    path: string
    playing: boolean
    saved: boolean
    saved_name?: string
    selected: boolean
    snapping: number
    start_delay: string
    time: number
    type: string
    uuid: string
    all: _Animation[]
    selected: _Animation

    Methods

    • Adds the animation to the current project and to the interface

      Parameters

      • Optionalundo: boolean

        If true, the addition of the animation will be registered as an edit

      Returns this

    • Calculate the snapping value that the animation should use, based on the time codes of the keyframes that it holds. Directly updates the value, but also returns it as a number (snaps per second)

      Returns number

    • Compiles the JSON tree of the animation for the Minecraft Bedrock Edition animation format.

      Returns any

    • Parameters

      • undo: boolean
      • Optionalremove_from_file: boolean

      Returns this

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods