Blockbench Reference Docs
    Preparing search index...

    Indexable

    • [key: string]: any
    Index

    Constructors

    Properties

    autouv: 0 | 1 | 2
    bedrock_binding?: string
    cem_animations?: any[]
    cem_attach?: boolean
    cem_model?: string
    cem_scale?: number
    children: OutlinerNode[]
    color: number
    export: boolean
    ik_chain_length: number
    ik_enabled: boolean
    isOpen: boolean
    locked: boolean
    menu?: Menu
    mesh: Mesh
    mirror_uv: boolean
    name: string
    origin: ArrayVector3
    parent?: OutlinerNode & OutlinerNodeParentTraits | "root"
    preview_controller: NodePreviewController
    reset: boolean
    rotation: ArrayVector3
    scene_object: Object3D
    selected: boolean
    shade: boolean
    skin_original_origin?: ArrayVector3
    texture?: string
    type: string
    uuid: string
    visibility: boolean
    all: Group[]

    All groups in the current project

    animator: BoneAnimator
    behavior_overrides: any[] = []
    first_selected: Group

    The first group in Group.multi_selected

    hasAny: () => boolean

    Check if any groups are in the project

    multi_selected: Group[]

    A list of directly selected groups.

    This only includes directly selected groups, not groups that are selected because the parent is selected

    preview_controller: NodePreviewController
    properties: Record<string, Property<any>>
    selected: Group[]

    Returns the selected groups

    This only includes directly selected groups, not groups that are selected because the parent is selected

    uuids: { [uuid: string]: OutlinerNode }

    Methods

    • Parameters

      • Optionaltarget: OutlinerNode | "root"

      Returns this

    • Create a unique name for the group or element by adding a number at the end or increasing it.

      Parameters

      • Optionalothers: OutlinerNode[]

      Returns this

    • Parameters

      • callback: (any: OutlinerNode) => void
      • Optionaltype: any
      • Optionalfor_self: boolean

      Returns void

    • Parameters

      • flag: string

      Returns any

    • Initializes the node. This should always be called when creating nodes that will be used in the outliner.

      Returns this

    • Checks of the group or element is a child of group.

      Parameters

      • node: OutlinerNode
      • max_levels: number

        The maximum number of generations that can be between the element and the group

      Returns boolean

    • Mark the element as selected

      Parameters

      • Optionaldescendants: boolean

      Returns void

    • Removes the group

      Parameters

      • Optionalundo: boolean

        If true, an undo point will be created.

      Returns this

    • Marks the name of the group or element in the outliner for renaming.

      Returns this

    • Remove the group and leave all of its children in the parent array.

      Returns OutlinerNode[]

    • Saves the changed name of the element by creating an undo point and making the name unique if necessary.

      Parameters

      • Optionalsave: boolean

      Returns this

    • Parameters

      • Optionalevent: any
      • OptionalisOutlinerClick: boolean

      Returns this

    • Displays the context menu of the element

      Parameters

      • event: Event | HTMLElement

        Mouse event, determines where the context menu spawns.

      Returns this

    • Unfolds the outliner and scrolls up or down if necessary to show the group or element.

      Returns this

    • Sort the content of the group alphabetically. This will automatically create an undo point.

      Returns this

    • Parameters

      • Optionaltarget: OutlinerNode
      • Optionalindex_modifier: number

      Returns this

    • Updates the Vue node of the element. This is only necessary in some rare situations

      Returns this

    • Parameters

      • override_options: { behavior: Record<string, any>; condition: any }

      Returns Deletable