Prototype/MouseCursor

Prototype definitions » Prototype/MouseCursor

Basics

Prototype type: mouse-cursor

Used by Prototype/SelectionTool#mouse_cursor.

Mandatory properties

type

Type: Types/string

Must be "mouse-cursor".

name

Type: Types/string

Name of the prototype.

Optional properties

system_cursor

Type: Types/string

One of "arrow", "i-beam", "crosshair", "wait-arrow", "size-all", "no" and "hand". Either this or the other three properties have to be present.

filename

Type: Types/FileName

Has to be present if system_cursor is not present.

hot_pixel_x

Type: Types/int16

Has to be present if system_cursor is not present.

hot_pixel_y

Type: Types/int16

Has to be present if system_cursor is not present.

Examples

{
    type = "mouse-cursor",
    name = "selection-tool-cursor",
    filename = "__core__/graphics/cross-select-x32.png",
    hot_pixel_x = 16,
    hot_pixel_y = 16
  }

{
    type = "mouse-cursor",
    name = "system-crosshair",
    system_cursor = "crosshair"
  }