Blockbench Reference Docs
    Preparing search index...

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    animated_textures: boolean

    Enable flipbook animated textures

    animation_controllers: boolean

    Enables animation controllers

    animation_files: boolean

    If true, animations will be saved into files

    animation_loop_wrapping: boolean

    If true, interpolation between keyframes in looping animations will wrap around

    animation_mode: boolean

    Emaböes animation mode

    armature_rig: boolean

    Enable armatures to rig meshes

    billboards: boolean

    Enable billboard elements

    block_size: number

    Specify how large in pixels a block is. Defaults to 16.

    bone_binding_expression: boolean

    Enables an option to set an expression for bone bindings

    bone_rig: boolean

    Enable groups to work as bones and rig the model

    box_uv: boolean

    Enables Box UV on cubes by default

    box_uv_float_size: boolean

    If true, cube sizes will not be floored to calculate UV sizes with box UV. This can result in UVs not aligning with pixel edges

    can_convert_to: boolean
    category: string
    centered_grid: boolean

    Align the grid center with the model origin, instead of the grid corner

    codec?: Codec
    condition: any
    confidential: boolean
    cube_size_limiter?: CubeSizeLimiter

    Options to limit the size of cubes

    cullfaces: boolean

    Enables cullfaces, the ability on faces in Minecraft block models to set a direction, that, if covered by another block, will cause the face to unrender

    description: string
    display_mode: boolean

    Enables display mode

    edit_mode: boolean

    Enables edit mode. Default is true

    euler_order: "XYZ" | "ZYX"

    Rotation euler order for outliner nodes

    format_page?: FormatPage
    icon: string
    id: string
    image_editor: boolean

    Enables the 2D image editor

    integer_size: boolean

    If true, cube sizes are limited to integer values

    java_cube_shading_properties: boolean

    Enables properties for Minecraft Java block/item models related to block shading (shading option and light emission value)

    java_face_properties: boolean

    Enables Minecraft Java block/item model specific cube face features (tint and export)

    legacy_editable_file_name: boolean

    If true, the file name of a project will be editable in the project settings

    locators: boolean

    Enable locators

    meshes: boolean

    Enable mesh elements

    model_identifier: boolean

    Enable a model identifier field in the project settings. Default is true

    name: string
    node_name_regex: string

    A set of characters that is allowed in node names (names of elements and groups that can be referenced externally, this does not apply to cubes or meshes)

    optional_box_uv: boolean

    If true, box UV is optional and can be toggled on the project or per cube

    paint_mode: boolean

    Enables paint mode. Default is true

    parent_model_id: boolean

    If true, enables a field in the project settings to set a parent model ID

    pbr: boolean

    Enable PBR texture materials yay

    per_animator_rotation_interpolation: boolean

    Toggle quaternion interpolation per node / animator

    per_group_texture: boolean

    If true, textures can be assigned per group instead of per face

    per_texture_uv_size: boolean

    If true, UV size (the size of the texture in UV space) will be defined per texture and not per project

    plugin: string
    pose_mode: boolean

    Enables pose mode

    quaternion_interpolation: boolean

    If true, use quaternion lerping to interpolate between rotation keyframes

    render_sides: "front" | "double" | "back" | (() => "front" | "double" | "back")

    Set the default render sides for textures

    rotate_cubes: boolean

    Add the ability to rotate cubes

    rotation_limit: boolean

    Enforces a rotation limit for cubes of up to 45 degrees in either direction and one axis at a time

    rotation_snap: boolean

    Forces cube rotations to snap to 22.5 degree increments

    select_texture_for_particles: boolean

    Allows assigning one texture to be used as a texture for particles related to the model

    show_in_new_list: boolean
    show_on_start_screen: boolean
    single_texture: boolean

    If true, only one texture can be assigned to the model at a time, instead of textures being assigned per face

    single_texture_default: boolean

    If true, a single texture is used as default, but textures can still be assigned to faces

    splines: boolean

    Enable spline elements

    stretch_cubes: boolean

    Add the ability to stretch cubes. Stretch scales cubes from the center without affecting UV

    target: string | string[]
    texture_folder: boolean

    Enables a folder path per texture that can be set in the texture properties window

    texture_mcmeta: boolean

    Enable mcmeta files for animated texture files

    texture_meshes: boolean

    Enable texture meshes

    type: string
    uv_rotation: boolean

    Allows cube UVs to be rotated

    vertex_color_ambient_occlusion: boolean

    Adds a toggle in the project settings to enable project wide vertex color ambient occlusion

    properties: Record<string, Property<any>>

    Methods

    • Returns void

    • Returns void

    • Returns boolean

    • Returns void

    • Returns void

    • Returns void

    • Parameters

      Returns void

    • Returns void

    • Returns this