Blockbench Reference Docs
    Preparing search index...

    Class OutlinerElementAbstract

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    allow_mirror_modeling?: boolean
    children?: OutlinerNode[]
    export: boolean
    locked: boolean
    menu?: Menu
    name: string
    name_regex: (element?: OutlinerNode) => string | boolean
    old_name?: string
    parent: OutlinerNode & OutlinerNodeParentTraits | "root"
    selected: boolean
    type: string
    uuid: string
    animator?: BoneAnimator
    behavior: Record<string, any>
    behavior_overrides: any[]
    isParent: false
    preview_controller: NodePreviewController
    properties: Record<string, Property<any>>
    selected: OutlinerElement[]
    types: Record<string, ElementTypeConstructor>
    uuids: { [uuid: string]: OutlinerNode }

    Accessors

    Methods

    • Parameters

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

      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

      • Optionalothers: OutlinerNode[]

      Returns string | false

    • 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

      • Optionalselect_children: boolean

      Returns this

    • Parameters

      • search_term_lowercase: any

      Returns any

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

      Returns this

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

      Parameters

      • Optionalsave: boolean

      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: MouseEvent

      Returns this

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

      Returns void

    • Parameters

      • Optionalelement: OutlinerNode
      • Optionalindex_modifier: number

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

      Returns Deletable

    • Parameters

      • constructor: ElementTypeConstructor
      • id: string

      Returns void