Prototype/MouseCursor

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/MouseCursor.html

This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.

Prototype definitions » Prototype/MouseCursor

Used by Prototype/SelectionTool#mouse_cursor.

Prototype/MouseCursor — mouse-cursor
name	::	string
type	::	string
filename	::	FileName (optional)
hot_pixel_x	::	int16 (optional)
hot_pixel_y	::	int16 (optional)
system_cursor	::	string (optional)

Mandatory properties

type

Type: string
Must be "mouse-cursor".

name

Type: string
Name of the prototype.

Optional properties

system_cursor

Type: 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: FileName
Has to be present if system_cursor is not present.

hot_pixel_x

Type: int16
Has to be present if system_cursor is not present.

hot_pixel_y

Type: 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"
  }