Blockbench Reference Docs
    Preparing search index...

    Class Cube

    Index

    Constructors

    constructor

    Properties

    allow_mirror_modeling? autouv box_uv color export faces from inflate locked menu? mesh mirror_uv name origin parent? preview_controller rescale? rotation rotation_axis scene_object selected shade stretch to type uuid uv_offset visibility all animator? behavior_overrides hasAny hasSelected isParent preview_controller properties selected types uuids

    Methods

    addTo applyTexture createUniqueName extend flip getGlobalVertexPositions getParentArray getSaveCopy getTypeBehavior getUndoCopy getWorldCenter init isChildOf mapAutoUV markAsSelected moveVector remove rename resize roll rotationAxis sanitizeName saveName select setColor setUVMode showContexMenu showInOutliner size sortInBefore transferOrigin unselect updateElement addBehaviorOverride fromSave registerType

    Constructors

    Properties

    allow_mirror_modeling?: boolean
    autouv: 0 | 1 | 2

    Auto UV setting, saved as an integer, where 0 means disabled, 1 means enabled, and 2 means relative auto UV (cube position affects UV)

    box_uv: boolean

    If the cube is using Box UV

    color: any
    export: boolean
    faces: { [fkey: string]: CubeFace }
    from: ArrayVector3
    inflate: number

    Inflate adds an inflation value to all sides equally

    locked: boolean
    menu?: Menu
    mesh: Mesh<BufferGeometry, Material | Material[]> & {
        geometry: BufferGeometry & { faces: string[] };
        outline: Mesh;
    }
    mirror_uv: boolean

    UV mirror across the X axis when using Box UV

    name: string
    origin: ArrayVector3
    parent?: OutlinerNode & OutlinerNodeParentTraits | "root"
    preview_controller: NodePreviewController
    rescale?: boolean
    rotation: ArrayVector3
    rotation_axis: "x" | "y" | "z"
    scene_object: Object3D
    selected: boolean
    shade: boolean

    Enable or disable shading based on face normal

    stretch: ArrayVector3
    to: ArrayVector3
    type: string
    uuid: string
    uv_offset: ArrayVector2

    UV position for box UV mode

    visibility: boolean

    Visibility of the cube in the viewport

    all: Cube[]
    animator?: BoneAnimator
    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: Cube[]
    types: Record<string, typeof OutlinerElement>
    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

      • axis: number
      • center: number
      • OptionalskipUV: 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 element.

      Parameters

      • Optionalundo: boolean

      Returns void

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

      Returns this

    • Parameters

      • value: number
      • axis: number
      • negative: boolean
      • Optionalallow_negative: boolean
      • Optionalbidirectional: boolean

      Returns void

    • Rotate the cube around axis in 90 degree steps

      Parameters

      • axis: number

        Axis index

      • steps: number

        Number of steps

      • origin: ArrayVector3

        Rotation pivot

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

    • Parameters

      • Optionaltarget: OutlinerNode
      • Optionalindex_modifier: number

      Returns this

    • Transfer the origin to a new position, while updating from and to to keep the same visual position.

      Parameters

      Returns void

    • 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
    Methods