Blockbench Reference Docs
    Preparing search index...

    Class ArmatureBone

    Index

    Constructors

    constructor

    Properties

    allow_mirror_modeling? buttons children color connected export icon isOpen length locked menu mesh name name_regex old_size? origin parent? preview_controller rotation scene_object selected title type uuid vertex_weights visibility width all animator? behavior behavior_overrides hasAny hasSelected isParent preview_controller properties selected types uuids

    Accessors

    position

    Methods

    addTo createUniqueName extend flip forEachChild getArmature getChildlessCopy getParentArray getSaveCopy getSize getTypeBehavior getUndoCopy getVertexWeight getWorldCenter init isChildOf markAsSelected matchesSelection openUp remove rename resize sanitizeName saveName select setColor setVertexWeight showContexMenu showInOutliner size sortInBefore transferOrigin unselect updateElement addBehaviorOverride fromSave registerType

    Constructors

    Properties

    allow_mirror_modeling?: boolean
    buttons: OutlinerToggle[]
    children: ArmatureBone[]
    color: number
    connected: boolean
    export: boolean
    icon: string
    isOpen: boolean
    length: number
    locked: boolean
    menu: Menu
    mesh: Mesh<BufferGeometry, Material | Material[]> | Object3D
    name: string
    name_regex: () => false | "a-zA-Z0-9_"
    old_size?: number | ArrayVector3
    origin: ArrayVector3
    parent?: OutlinerNode & OutlinerNodeParentTraits | "root"
    preview_controller: NodePreviewController
    rotation: ArrayVector3
    scene_object: Object3D
    selected: boolean
    title: string
    type: string
    uuid: string
    vertex_weights: Record<string, number>
    visibility: boolean
    width: number
    all: ArmatureBone[]
    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[] = []
    hasAny: () => boolean

    Check if any elements of the type are in the project

    hasSelected: () => boolean

    Check if any elements of the type are currently selected

    isParent: false
    preview_controller: NodePreviewController
    properties: Record<string, Property<any>>
    selected: ArmatureBone[]
    types: Record<string, typeof OutlinerElement>
    uuids: { [uuid: string]: OutlinerNode }

    Accessors

    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

      • 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 {
          children: string[];
          isOpen: boolean;
          name: string;
          type: string;
          uuid: string;
      }

    • Parameters

      • axis: any

      Returns number

    • Parameters

      • flag: string

      Returns any

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

    • 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

    • Mark the element as selected

      Parameters

      • descendants: boolean

      Returns this

    • Returns boolean

    • Returns this

    • Removes the element.

      Parameters

      • Optionalundo: boolean

      Returns void

    • 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

    • 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: Event
      • OptionalisOutlinerClick: 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: 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

    • Returns ArrayVector3

    • Parameters

      Returns number

    • Parameters

      • Optionaltarget: OutlinerNode
      • Optionalindex_modifier: number

      Returns this

    • Parameters

      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

    • Parameters

      • data: any
      • Optionalkeep_uuid: boolean

      Returns OutlinerElement

    • Parameters

      • constructor: any
      • id: string

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods