Prototype/MouseCursor - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:56Z

Removed old prototype docs

← Older revision		Revision as of 14:32, 25 October 2024
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>~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:43:17Z

Updated styling of prototype doc migration note

← Older revision		Revision as of 10:43, 21 September 2023
Line 1:		Line 1:
	'''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]		<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]

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

BilkaBot: Protected "Prototype/MouseCursor": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:52:51Z

Protected "Prototype/MouseCursor": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision		Revision as of 17:52, 16 August 2023
(No difference)

BilkaBot: Migrated prototype doc to separate website

2023-08-16T17:52:51Z

Migrated prototype doc to separate website

← Older revision		Revision as of 17:52, 16 August 2023
Line 1:		Line 1:
			'''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]

			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].



	{{Prototype parent}}		{{Prototype parent}}
	Used by [[Prototype/SelectionTool#mouse_cursor]].		Used by [[Prototype/SelectionTool#mouse_cursor]].

Bilka: Converted to SMW format

2019-07-27T22:12:25Z

Converted to SMW format

← Older revision		Revision as of 22:12, 27 July 2019
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.

Bilka: Set prototype parent

2019-07-24T14:53:50Z

Set prototype parent

← Older revision		Revision as of 14:53, 24 July 2019
Line 1:		Line 1:
			{{Prototype parent}}

	== Basics ==		== Basics ==
	Prototype type: '''mouse-cursor'''		Prototype type: '''mouse-cursor'''

Bilka: 0.17

2019-03-04T11:30:43Z

0.17

New page

== Basics ==
Prototype type: '''mouse-cursor'''

Used by [[Prototype/SelectionTool#mouse_cursor]].

== Mandatory properties ==

=== type ===
'''Type''': [[Types/string]]

Must be "mouse-cursor".

=== name ===
'''Type''': [[Types/string]]

Name of the prototype.

== Optional properties ==

=== system_cursor ===
'''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.

=== filename ===
'''Type''': [[Types/FileName]]

Has to be present if <code>system_cursor</code> is not present.

=== hot_pixel_x ===
'''Type''': [[Types/int16]]

Has to be present if <code>system_cursor</code> is not present.

=== hot_pixel_y ===
'''Type''': [[Types/int16]]

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>