Blockbench Reference Docs
    Preparing search index...

    Class ReferenceImage

    Index

    Accessors

    aspect_ratio selected source_height source_width

    Constructors

    constructor

    Methods

    addAsBuiltIn addAsGlobalReference addAsReference changeLayer changeScope delete detach enableBlueprintMode extend getClampedPosition getSaveCopy getZoomLevel openContextMenu projectMouseCursor propertiesDialog reset resolveCondition save select setupEditHandles unselect update updateClearMode updateTransform updateAll

    Properties

    attached_side auto_aspect_ratio billboard_position? billboard_rotation? cache_version clear_mode condition cull_backface dark_background defaults flip_x flip_y image_is_loaded img is_blueprint is_video layer menu modes name node opacity position removed? rotation scene_object scope size source sync_to_timeline toolbar uuid video view_mode visibility active all built_in current_project global image_extensions properties selected supported_extensions video_extensions

    Accessors

    • get aspect_ratio(): number

      Returns number

    • get selected(): boolean

      Returns boolean

    • get source_height(): number

      Returns number

    • get source_width(): number

      Returns number

    Constructors

    Methods

    • Parameters

      • Optionalsave: boolean

      Returns this

    • Parameters

      • Optionalsave: boolean

      Returns this

    • Parameters

      • Optionalsave: boolean

      Returns this

    • Parameters

      • Optionalforce: boolean

      Returns Promise<void>

    • Returns void

    • Returns this

    • Returns number[]

    • Returns number

    • Parameters

      • event: MouseEvent

      Returns this

    • Parameters

      • x: number
      • y: number

      Returns boolean | ArrayVector2

    • Returns this

    • Returns this

    • Returns boolean

    • Returns this

    • Parameters

      • Optionalforce: boolean

      Returns this

    • Returns this

    • Returns this

    • Returns this

    • Returns void

    • Returns this

    • Returns void

    Properties

    attached_side: string
    auto_aspect_ratio: boolean
    billboard_position?: ArrayVector3
    billboard_rotation?: ArrayVector3
    cache_version: number
    clear_mode: boolean
    condition: ConditionResolvable
    cull_backface: boolean
    dark_background: boolean
    defaults: {}
    flip_x: boolean
    flip_y: boolean
    image_is_loaded: boolean
    img: HTMLImageElement
    is_blueprint: boolean
    is_video: boolean
    layer: ReferenceImageLayer
    menu: Menu
    modes: string[]
    name: string
    node: HTMLDivElement
    opacity: number
    position: number[]
    removed?: true
    rotation: number
    scene_object: CSS3DObject
    scope: ReferenceImageScope
    size: number[]
    source: string
    sync_to_timeline: boolean
    toolbar: HTMLElement
    uuid: string
    video: HTMLVideoElement & { _loading?: boolean; ref_source?: any }
    view_mode: ReferenceImageViewMode
    visibility: boolean
    active: ReferenceImage[]
    all: ReferenceImage[]
    built_in: ReferenceImage[]
    current_project: ReferenceImage[]
    global: ReferenceImage[]
    image_extensions: string[]
    properties: Record<string, Property>
    selected: ReferenceImage
    supported_extensions: string[]
    video_extensions: string[]

    Settings

    Member Visibility

    On This Page

    Accessors
    Constructors
    Methods
    Properties