Blockbench Reference Docs
    Preparing search index...

    Class ReferenceImage

    Index

    Constructors

    constructor

    Properties

    _edit_events_initialized _modify_nodes attached_side auto_aspect_ratio cache_version clear_mode condition dark_background defaults flip_x flip_y image_is_loaded img is_blueprint is_video layer menu modes name node opacity opacity_slider position removed rotation scope size source sync_to_timeline toolbar uuid video visibility image_extensions supported_extensions video_extensions

    Accessors

    aspect_ratio selected source_height source_width

    Methods

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

    Constructors

    • Parameters

      • Optionaldata: {}

      Returns ReferenceImage

    Properties

    _edit_events_initialized

    _edit_events_initialized: boolean

    _modify_nodes

    _modify_nodes: any[]
    attached_side: number
    auto_aspect_ratio: boolean
    cache_version: number
    clear_mode: boolean
    condition: any
    dark_background: boolean
    defaults: {}
    flip_x: boolean
    flip_y: boolean
    image_is_loaded: boolean
    img: HTMLImageElement
    is_blueprint: boolean
    is_video: boolean
    layer: string
    menu: Menu
    modes: any[]
    name: string
    node: HTMLElement
    opacity: number
    opacity_slider: void
    position: number[]
    removed: boolean
    rotation: number
    scope: string
    size: number[]
    source: string
    sync_to_timeline: boolean
    toolbar: HTMLElement
    uuid: string
    video: HTMLElement
    visibility: boolean
    image_extensions: string[]
    supported_extensions: string[]
    video_extensions: string[]

    Accessors

    • get aspect_ratio(): number

      Returns number

    • get selected(): boolean

      Returns boolean

    • get source_height(): any

      Returns any

    • get source_width(): any

      Returns any

    Methods

    • Parameters

      • save: any

      Returns this

    • Parameters

      • save: any

      Returns this

    • Parameters

      • save: any

      Returns this

    • Parameters

      • layer: any

      Returns this

    • Parameters

      • new_scope: any

      Returns this

    • Parameters

      • force: any

      Returns Promise<void>

    • Returns void

    • Returns void

    • Parameters

      • data: any

      Returns void

    • Returns { modes: any[]; source: any }

    • Returns number

    • Parameters

      • event: any

      Returns this

    • Parameters

      • x: any
      • y: any

      Returns false | number[]

    • Returns this

    • Returns this

    • Returns boolean

    • Returns this

    • Parameters

      • force: any

      Returns this

    • Returns this

    • Returns this

    • Returns this

    • Returns void

    • Returns this

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods