Prototype/MouseCursor: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Set prototype parent)
(Converted to SMW format)
Line 1: Line 1:
{{Prototype parent}}
{{Prototype parent}}
Used by [[Prototype/SelectionTool#mouse_cursor]].


== Basics ==
{{Prototype TOC|mouse-cursor}}
Prototype type: '''mouse-cursor'''
 
Used by [[Prototype/SelectionTool#mouse_cursor]].


== Mandatory properties ==
== Mandatory properties ==


=== type ===
{{Prototype property|type|[[Types/string|string]]}}
'''Type''': [[Types/string]]
 
Must be "mouse-cursor".
Must be "mouse-cursor".


=== name ===
{{Prototype property|name|[[Types/string|string]]}}
'''Type''': [[Types/string]]
 
Name of the prototype.
Name of the prototype.


== Optional properties ==
== Optional properties ==


=== system_cursor ===
{{Prototype property|system_cursor|[[Types/string|string]]|optional=true}}
'''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.
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 ===
{{Prototype property|filename|[[Types/FileName|FileName]]|optional=true}}
'''Type''': [[Types/FileName]]
 
Has to be present if <code>system_cursor</code> is not present.
Has to be present if <code>system_cursor</code> is not present.


=== hot_pixel_x ===
{{Prototype property|hot_pixel_x|[[Types/int16|int16]]|optional=true}}
'''Type''': [[Types/int16]]
 
Has to be present if <code>system_cursor</code> is not present.
Has to be present if <code>system_cursor</code> is not present.


=== hot_pixel_y ===
{{Prototype property|hot_pixel_y|[[Types/int16|int16]]|optional=true}}
'''Type''': [[Types/int16]]
 
Has to be present if <code>system_cursor</code> is not present.
Has to be present if <code>system_cursor</code> is not present.



Revision as of 22:12, 27 July 2019

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