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.

Template:Prototype parent Used by Prototype/SelectionTool#mouse_cursor.

Mandatory properties

Template:Prototype property Must be "mouse-cursor".

Template:Prototype property Name of the prototype.

Optional properties

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

Template:Prototype property Has to be present if system_cursor is not present.

Template:Prototype property Has to be present if system_cursor is not present.

Template:Prototype property 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"
  }