Prototype/CustomInput - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:47Z

Removed old prototype docs

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:42:56Z

Updated styling of prototype doc migration note

← Older revision		Revision as of 10:42, 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/CustomInputPrototype.html https://lua-api.factorio.com/latest/prototypes/CustomInputPrototype.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/CustomInputPrototype.html https://lua-api.factorio.com/latest/prototypes/CustomInputPrototype.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/CustomInput": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:52:16Z

Protected "Prototype/CustomInput": 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:16Z

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/CustomInputPrototype.html https://lua-api.factorio.com/latest/prototypes/CustomInputPrototype.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\|PrototypeBase}}		{{Prototype parent\|PrototypeBase}}
	Used for custom keyboard shortcuts/keybindings in mods. The key associated with the custom input can be changed in the options. This means that <code>key_sequence</code> is simply the default keybinding.		Used for custom keyboard shortcuts/keybindings in mods. The key associated with the custom input can be changed in the options. This means that <code>key_sequence</code> is simply the default keybinding.

Bilka: 1.1.83: controller_key_sequence, controller_alternative_key_sequence added

2023-06-23T14:25:04Z

1.1.83: controller_key_sequence, controller_alternative_key_sequence added

← Older revision		Revision as of 14:25, 23 June 2023
Line 274:		Line 274:
	{{Prototype property\|alternative_key_sequence\|[[Types/string\|string]]\|optional=true}}		{{Prototype property\|alternative_key_sequence\|[[Types/string\|string]]\|optional=true}}
	The alternative keybinding for this control. See [[#key_sequence]].		The alternative keybinding for this control. See [[#key_sequence]].

			{{Prototype property\|controller_key_sequence\|[[Types/string\|string]]\|optional=true}}
			The controller (game pad) keybinding for this control. See [[#key_sequence]].

			{{Prototype property\|controller_alternative_key_sequence\|[[Types/string\|string]]\|optional=true}}
			The alternative controller (game pad) keybinding for this control. See [[#key_sequence]].

	{{Prototype property\|linked_game_control\|[[Types/string\|string]]\|""\|optional=true}}		{{Prototype property\|linked_game_control\|[[Types/string\|string]]\|""\|optional=true}}

Xorimuth: Fix CustomInputEvent links to runtime docs

2023-01-31T11:32:22Z

Fix CustomInputEvent links to runtime docs

← Older revision		Revision as of 11:32, 31 January 2023
Line 443:		Line 443:

	{{Prototype property\|include_selected_prototype\|[[Types/bool\|bool]]\|false\|optional=true}}		{{Prototype property\|include_selected_prototype\|[[Types/bool\|bool]]\|false\|optional=true}}
	If true, the type and name of the currently selected prototype will be provided as "selected_prototype" in the raised [https://lua-api.factorio.com/latest/events.html#~~Custom%20Input%20Events~~ lua event]. This also works in GUI's, not just the game world.[https://forums.factorio.com/96125]		If true, the type and name of the currently selected prototype will be provided as "selected_prototype" in the raised [https://lua-api.factorio.com/latest/events.html#CustomInputEvent lua event]. This also works in GUI's, not just the game world.[https://forums.factorio.com/96125]

	This will also return an item in the cursor such as copper-wire or rail-planner, if nothing is beneath the cursor.		This will also return an item in the cursor such as copper-wire or rail-planner, if nothing is beneath the cursor.
Line 453:		Line 453:
	One of "lua", "spawn-item", "toggle-personal-roboport", "toggle-personal-logistic-requests" and "toggle-equipment-movement-bonus".		One of "lua", "spawn-item", "toggle-personal-roboport", "toggle-personal-logistic-requests" and "toggle-equipment-movement-bonus".

	A [https://lua-api.factorio.com/latest/events.html#~~Custom%20Input%20Events~~ lua event] is only raised if the action is "lua".		A [https://lua-api.factorio.com/latest/events.html#CustomInputEvent lua event] is only raised if the action is "lua".

Bilka: there are no item ghosts

2022-06-09T15:28:47Z

there are no item ghosts

← Older revision		Revision as of 15:28, 9 June 2022
Line 445:		Line 445:
	If true, the type and name of the currently selected prototype will be provided as "selected_prototype" in the raised [https://lua-api.factorio.com/latest/events.html#Custom%20Input%20Events lua event]. This also works in GUI's, not just the game world.[https://forums.factorio.com/96125]		If true, the type and name of the currently selected prototype will be provided as "selected_prototype" in the raised [https://lua-api.factorio.com/latest/events.html#Custom%20Input%20Events lua event]. This also works in GUI's, not just the game world.[https://forums.factorio.com/96125]

	~~'''Note:'''~~ This will also return an item in the cursor ~~(or item of a ghost in cursor)~~ such as copper-wire or rail-planner, if nothing is beneath the cursor.		This will also return an item in the cursor such as copper-wire or rail-planner, if nothing is beneath the cursor.

	{{Prototype property\|item_to_spawn\|[[Types/string\|string]]\|optional=true}}		{{Prototype property\|item_to_spawn\|[[Types/string\|string]]\|optional=true}}

Bilka: moved note about event order to consuming property

2022-06-09T15:27:36Z

moved note about event order to consuming property

← Older revision		Revision as of 15:27, 9 June 2022
Line 431:		Line 431:
	<syntaxhighlight lang="lua">key_sequence = ""		<syntaxhighlight lang="lua">key_sequence = ""
	linked_game_control = "clear-cursor"</syntaxhighlight>		linked_game_control = "clear-cursor"</syntaxhighlight>

	~~'''Note''': The CustomInputEvent occurs before the game control.~~

	{{Prototype property\|consuming\|[[Types/ConsumingType\|ConsumingType]]\|"none"\|optional=true}}		{{Prototype property\|consuming\|[[Types/ConsumingType\|ConsumingType]]\|"none"\|optional=true}}
			Sets whether internal game events associated with the same key sequence should be fired or blocked. If they are fired ("none"), then the custom input event will happen before the internal game event.

	{{Prototype property\|enabled\|[[Types/bool\|bool]]\|true\|optional=true}}		{{Prototype property\|enabled\|[[Types/bool\|bool]]\|true\|optional=true}}

Curiosity: Checking in game, some game controls are invalid. There's also one new, based on locale strings.

2022-05-27T16:32:22Z

Checking in game, some game controls are invalid. There's also one new, based on locale strings.

← Older revision		Revision as of 16:32, 27 May 2022
Line 306:		Line 306:
	confirm-message		confirm-message
	connect-train		connect-train
	~~controller-gui-character-tab~~
	controller-gui-crafting-tab		controller-gui-crafting-tab
	controller-gui-logistics-tab		controller-gui-logistics-tab
Line 347:		Line 346:
	flip-blueprint-vertical		flip-blueprint-vertical
	focus-search		focus-search
	~~give-blueprint~~
	~~give-blueprint-book~~
	~~give-deconstruction-planner~~
	~~give-upgrade-planner~~
	increase-ui-scale		increase-ui-scale
	inventory-split		inventory-split
	inventory-transfer		inventory-transfer
	~~kill-statistics~~
	larger-terrain-building-area		larger-terrain-building-area
	logistic-networks		logistic-networks
Line 371:		Line 365:
	open-prototypes-gui		open-prototypes-gui
	open-technology-gui		open-technology-gui
			open-trains-gui
	order-to-follow		order-to-follow
	paste		paste
Line 421:		Line 416:
	toggle-console		toggle-console
	toggle-driving		toggle-driving
	~~toggle-equipment-movement-bonus~~
	toggle-filter		toggle-filter
	toggle-gui-debug		toggle-gui-debug
Line 429:		Line 423:
	toggle-map		toggle-map
	toggle-menu		toggle-menu
	~~toggle-personal-logistic-requests~~
	~~toggle-personal-roboport~~
	undo		undo
	zoom-in		zoom-in

Honktown: /* Optional properties */ clarification of "when" for linked_game_control

2022-05-26T18:31:15Z

Optional properties: clarification of "when" for linked_game_control

← Older revision		Revision as of 18:31, 26 May 2022
Line 439:		Line 439:
	<syntaxhighlight lang="lua">key_sequence = ""		<syntaxhighlight lang="lua">key_sequence = ""
	linked_game_control = "clear-cursor"</syntaxhighlight>		linked_game_control = "clear-cursor"</syntaxhighlight>

			'''Note''': The CustomInputEvent occurs before the game control.

	{{Prototype property\|consuming\|[[Types/ConsumingType\|ConsumingType]]\|"none"\|optional=true}}		{{Prototype property\|consuming\|[[Types/ConsumingType\|ConsumingType]]\|"none"\|optional=true}}