Prototype/MouseCursor: Difference between revisions
(Set prototype parent) |
(Updated styling of prototype doc migration note) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<div class="stub"><p>'''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 https://lua-api.factorio.com/latest/prototypes/MouseCursor.html] | |||
</p><p>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 [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div> | |||
{{Prototype parent}} | |||
Used by [[Prototype/SelectionTool#mouse_cursor]]. | Used by [[Prototype/SelectionTool#mouse_cursor]]. | ||
{{Prototype TOC|mouse-cursor}} | |||
== Mandatory properties == | == Mandatory properties == | ||
{{Prototype property|type|[[Types/string|string]]}} | |||
Must be "mouse-cursor". | Must be "mouse-cursor". | ||
{{Prototype property|name|[[Types/string|string]]}} | |||
Name of the prototype. | Name of the prototype. | ||
== Optional properties == | == Optional properties == | ||
{{Prototype property|system_cursor|[[Types/string|string]]|optional=true}} | |||
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. | ||
{{Prototype property|filename|[[Types/FileName|FileName]]|optional=true}} | |||
Has to be present if <code>system_cursor</code> is not present. | Has to be present if <code>system_cursor</code> is not present. | ||
{{Prototype property|hot_pixel_x|[[Types/int16|int16]]|optional=true}} | |||
Has to be present if <code>system_cursor</code> is not present. | Has to be present if <code>system_cursor</code> is not present. | ||
{{Prototype property|hot_pixel_y|[[Types/int16|int16]]|optional=true}} | |||
Has to be present if <code>system_cursor</code> is not present. | Has to be present if <code>system_cursor</code> is not present. | ||
Latest revision as of 10:43, 21 September 2023
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"
}