Prototype/MouseCursor: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Updated styling of prototype doc migration note)
(Removed old prototype docs)
 
Line 2: Line 2:


</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>
</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]].
{{Prototype TOC|mouse-cursor}}
== Mandatory properties ==
{{Prototype property|type|[[Types/string|string]]}}
Must be "mouse-cursor".
{{Prototype property|name|[[Types/string|string]]}}
Name of the prototype.
== 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.
{{Prototype property|filename|[[Types/FileName|FileName]]|optional=true}}
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.
{{Prototype property|hot_pixel_y|[[Types/int16|int16]]|optional=true}}
Has to be present if <code>system_cursor</code> is not present.
== Examples ==
<syntaxhighlight lang="lua">{
    type = "mouse-cursor",
    name = "selection-tool-cursor",
    filename = "__core__/graphics/cross-select-x32.png",
    hot_pixel_x = 16,
    hot_pixel_y = 16
  }</syntaxhighlight>
<syntaxhighlight lang="lua">{
    type = "mouse-cursor",
    name = "system-crosshair",
    system_cursor = "crosshair"
  }</syntaxhighlight>

Latest revision as of 14:32, 25 October 2024

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.

Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/MouseCursor&oldid=202947"