Blockbench Reference Docs
    Preparing search index...

    Class ModelProject

    A project instance. The tab bar can be used to switch between projects.

    Indexable

    • [key: string]: any
    Index

    Constructors

    constructor

    Properties

    _static added_models ambientocclusion animation_controllers animations backgrounds BedrockEntityManager? box_uv collections display_settings EditSession elements exploded_view export_options export_path format front_gui_light groups locked mesh_selection mirror_animating_enabled mirror_modeling_enabled mode model_identifier multi_file_ruleset outliner overrides? parent previews reference_images save_path selected selected_elements selected_faces selected_group selected_groups selected_texture spline_selection texture_groups textures thumbnail timeline_animators tool unhandled_root_fields uuid uv_viewport view_mode all properties

    Accessors

    geometry_name model_3d name nodes_3d optional_box_uv saved texture_height texture_width undo

    Methods

    close closeOnQuit extend getDisplayName getFileExtension getMultiFileRuleset getProjectMemory getUVHeight getUVWidth loadEditorState openSettings saveEditorState select showContextMenu unselect updateThumbnail whenNextOpen

    Constructors

    Properties

    _static

    _static: any
    added_models: number
    ambientocclusion: boolean
    animation_controllers: any
    animations: _Animation[]
    backgrounds: { [key: string]: any }
    BedrockEntityManager?: {}
    box_uv: boolean
    collections: any
    display_settings: {
        [slot: string]: {
            mirror: [boolean, boolean, boolean];
            rotation: [number, number, number];
            scale: [number, number, number];
            translation: [number, number, number];
            export?(...args: any[]): any;
        };
    }
    EditSession: EditSession
    elements: OutlinerElement[]
    exploded_view: boolean
    export_options: any
    export_path: string

    The path under which an exported file is saved, if available

    format: ModelFormat
    front_gui_light: boolean
    groups: Group[]
    locked: boolean

    When set to true, the project tab can no longer be selected or unselected

    mesh_selection: {
        [element_key: string]: {
            edges: string[];
            faces: string[];
            vertices: string[];
        };
    }
    mirror_animating_enabled: any
    mirror_modeling_enabled: any
    mode: string
    model_identifier: string
    multi_file_ruleset: string
    outliner: OutlinerNode[]
    overrides?: any
    parent: string
    previews: { [key: string]: any }
    reference_images: any
    save_path: string

    The path under which a project file is saved, if available

    selected: boolean
    selected_elements: OutlinerElement[]
    selected_faces: any[]
    selected_group: Group
    selected_groups: any
    selected_texture: Texture
    spline_selection: any
    texture_groups: any
    textures: Texture[]
    thumbnail: string
    timeline_animators: []
    tool: string
    unhandled_root_fields: any
    uuid: string
    uv_viewport: { offset: [number, number]; zoom: number; [key: string]: any }
    view_mode: string
    all: ModelProject[]
    properties: { [key: string]: Property<any> }

    Accessors

    • get geometry_name(): string

      Returns string

    • set geometry_name(val: string): void

      Parameters

      • val: string

      Returns void

    • get model_3d(): Object3D

      Returns Object3D

    • get name(): string

      Returns string

    • set name(name: string): void

      Parameters

      • name: string

      Returns void

    • get nodes_3d(): Record<UUID, THREE.Object3D>

      Returns Record<UUID, THREE.Object3D>

    • get optional_box_uv(): boolean

      Returns boolean

    • get saved(): boolean

      Returns boolean

    • set saved(saved: boolean): void

      Parameters

      • saved: boolean

      Returns void

    • get texture_height(): number

      Returns number

    • set texture_height(n: number): void

      Parameters

      • n: number

      Returns void

    • get texture_width(): number

      Returns number

    • set texture_width(n: number): void

      Parameters

      • n: number

      Returns void

    Methods

    • Parameters

      • Optionalforce: boolean

      Returns Promise<boolean>

    • Returns void

    • Parameters

      • object: any

      Returns void

    • Parameters

      • Optionalwith_extension: boolean

      Returns string

    • Returns string

    • Parameters

      Returns number

    • Parameters

      Returns number

    • Returns this

    • Returns void

    • Returns this

    • Returns boolean

    • Parameters

      Returns this

    • Run when unselecting the project

      Parameters

      • Optionalclosing: boolean

        Set to true when the project is being closed

      Returns void

    • Returns void

    • Parameters

      • callback: () => void

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods