Blockbench Reference Docs
    Preparing search index...

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _static: { properties: any; temp_data: Record<string, any> }
    allow_mirror_modeling?: boolean
    buttons: OutlinerToggle[]
    children: ArmatureBone[]
    color: number
    connected: boolean
    export: boolean
    icon: string
    isOpen: boolean
    length: number
    locked: boolean
    menu: Menu
    name: string
    name_regex: () => false | "a-zA-Z0-9_"
    origin: ArrayVector3
    rotation: ArrayVector3
    scope: number
    selected: boolean
    title: string
    type: string
    uuid: string
    vertex_weights: Record<string, number>
    visibility: boolean
    width: number
    animator?: BoneAnimator
    behavior: {
        child_types: string[];
        hide_in_screenshot: boolean;
        marker_color: boolean;
        movable: boolean;
        parent: boolean;
        parent_types: string[];
        resizable: boolean;
        rotatable: boolean;
        select_children: string;
        unique_name: boolean;
    }
    behavior_overrides: any[]
    isParent: false
    preview_controller: NodePreviewController
    properties: Record<string, Property<any>>
    selected: ArmatureBone[]
    types: Record<string, ElementTypeConstructor>
    uuids: { [uuid: string]: OutlinerNode }

    Accessors

    • get mesh(): Object3D

      Returns Object3D

    • get scene_object(): Object3D

      Returns Object3D

    • get temp_data(): Record<string, any>

      Returns Record<string, any>

    Methods

    • Parameters

      Returns this

    • Parameters

      • event: any
      • Optionaloutliner_click: boolean

      Returns void

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

      Parameters

      Returns string | false

    • Parameters

      • axis: number
      • center: number

      Returns this

    • Parameters

      • cb: (element: ArmatureBone) => void
      • Optionaltype: any
      • OptionalforSelf: boolean

      Returns void

    • Returns Armature

    • Parameters

      • Optionalkeep_uuid: boolean

      Returns ArmatureBone

    • Returns number

    • Returns {
          children: string[];
          isOpen: boolean;
          name: string;
          type: string;
          uuid: string;
      }

    • Parameters

      • axis: any

      Returns number

    • Parameters

      • flag: string

      Returns any

    • Parameters

      • mesh: Mesh
      • vkey: string

      Returns number

    • Returns Vector3

    • 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

    • Parameters

      • toggle: any

      Returns true

    • Mark the element as selected

      Parameters

      • descendants: boolean

      Returns this

    • Parameters

      • search_term_lowercase: string

      Returns boolean

    • Returns boolean

    • Returns this

    • Removes the node.

      Returns this

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

      Returns this

    • Parameters

      • move_value: number | ((input: number) => number)
      • Optionalaxis_number: axisNumber
      • Optionalinvert: boolean

      Returns void

    • Returns string

    • 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

      • index: any

      Returns this

    • Parameters

      • mesh: Mesh
      • vkey: string
      • Optionalweight: number

      Returns void

    • Displays the context menu of the element

      Parameters

      • event: HTMLElement | Event

        Mouse event, determines where the context menu spawns.

      Returns this

    • Parameters

      • event: MouseEvent

      Returns this

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

      Returns void

    • Returns ArrayVector3

    • Parameters

      Returns number

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      • Optionalunselect_parent: boolean

      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: ConditionResolvable;
            priority?: number;
        }

      Returns Deletable

    • Check if any elements of the type are in the project

      Returns boolean

    • Check if any elements of the type are currently selected

      Returns boolean

    • Parameters

      • type: string

      Returns boolean