Blockbench Reference Docs
    Preparing search index...
    Index

    Constructors

    • Parameters

      • data: any
      • uuid: any

      Returns Group

    Properties

    autouv: number
    buttons: OutlinerToggle[]
    children: any[]
    color: any
    export: boolean
    icon: string
    isOpen: boolean
    locked: boolean
    menu: Menu
    mirror_uv: boolean
    name: string
    old_name?: string
    parent: string
    reset: boolean
    selected: boolean
    shade: boolean
    title: string
    type: string
    uuid: string
    visibility: boolean
    animator?: BoneAnimator
    behavior: {
        has_pivot: boolean;
        marker_color: boolean;
        movable: boolean;
        parent: boolean;
        rotatable: boolean;
        select_children: string;
        unique_name: boolean;
        use_absolute_position: boolean;
    }
    behavior_overrides: any[]
    isParent: false
    preview_controller: NodePreviewController
    properties: Record<string, Property<any>>
    uuids: { [uuid: string]: OutlinerNode }

    Accessors

    Methods

    • Parameters

      • Optionaltarget: OutlinerNode | "root"
      • Optionalindex: number

      Returns this

    • Parameters

      • event: any
      • is_outliner_click: any

      Returns this

    • Parameters

      • undo: any

      Returns { name: string }

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

      Parameters

      • Optionalothers: OutlinerNode[]

      Returns string | false

    • Returns Group

    • Parameters

      • object: any

      Returns this

    • Parameters

      • cb: any
      • type: any
      • forSelf: any

      Returns void

    • Parameters

      • keep_uuid: any

      Returns Group

    • Returns Object3D

    • Parameters

      • nested: any

      Returns Group

    • Parameters

      • flag: string

      Returns any

    • 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

      • descendants: any

      Returns this

    • Parameters

      • search_term_lowercase: any

      Returns any

    • Returns boolean

    • Returns this

    • Returns string | false

    • Returns this

    • Removes the node.

      Parameters

      • undo: any

      Returns void

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

      Returns this

    • Parameters

      • Optionalundo: boolean

      Returns any[]

    • 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

      • event: any
      • is_outliner_click: any

      Returns this

    • Parameters

      • event: any

      Returns void

    • Parameters

      • val: any

      Returns void

    • Parameters

      • index: any

      Returns this

    • Displays the context menu of the element

      Parameters

      • event: Event | HTMLElement

        Mouse event, determines where the context menu spawns.

      Returns this

    • Parameters

      • event: any

      Returns this

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

      Returns void

    • Returns this

    • Parameters

      • Optionalelement: OutlinerNode
      • Optionalindex_modifier: number

      Returns this

    • Parameters

      • origin: any

      Returns this

    • Parameters

      • unselect_parent: any

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

      Returns Deletable