Prototype/Shortcut - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:33:02Z

Removed old prototype docs

← Older revision		Revision as of 14:33, 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\|PrototypeBase}}~~
	~~Definition for a shortcut button in the [[shortcut bar]].<br>~~
	~~This is ''not'' a custom keybinding (keyboard shortcut), for that see [[Prototype/CustomInput]].~~

	~~{{Prototype TOC\|shortcut}}~~

	~~== Mandatory properties ==~~
	~~Inherits all properties from [[PrototypeBase]].~~

	~~{{Prototype property\|action\|[[Types/string\|string]]}}~~
	~~One of "toggle-alt-mode", "undo", "copy", "cut", "paste", "import-string", "toggle-personal-roboport", "toggle-equipment-movement-bonus", "spawn-item" and "lua".~~

	~~If this is "lua", [https://lua-api.factorio.com/latest/events.html#on_lua_shortcut defines.events.on_lua_shortcut] is raised when the shortcut is clicked.~~

	~~{{Prototype property\|icon\|[[Types/Sprite\|Sprite]]}}~~
	~~Scales to fit a 16x16-pixel square.<br />~~
	~~Note: The scale that can be defined in the sprite may not behave as expected because the game always scales the sprite to fill the GUI slot.~~

	~~== Optional properties ==~~

	~~{{Prototype property\|item_to_spawn\|[[Types/string\|string]]\|optional=true}}~~
	Name of a [[Prototype/Item]]. The item to create when clicking on a shortcut with the action set to "spawn-item". The item must have the [[Types/ItemPrototypeFlags#.22spawnable.22\|"spawnable"]] flag set.

	~~{{Prototype property\|technology_to_unlock\|[[Types/string\|string]]\|optional=true}}~~
	~~Name of a [[Prototype/Technology]]. The technology that must be researched before this shortcut can be used. Once a shortcut is unlocked in one save file, it is unlocked for all future save files.~~

	~~{{Prototype property\|toggleable\|[[Types/bool\|bool]]\|false\|optional=true}}~~
	Must be enabled for the Factorio API to be able to set the toggled state on the shortcut button, see [https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.set_shortcut_toggled LuaPlayer.set_shortcut_toggled].

	~~{{Prototype property\|associated_control_input\|[[Types/string\|string]]\|""\|optional=true}}~~
	~~Name of a custom input or vanilla control. This is ''only'' used to show the keybind in the tooltip of the shortcut.~~

	~~{{Prototype property\|small_icon\|[[Types/Sprite\|Sprite]]\|Uses [[#icon]] definition\|optional=true}}~~
	~~The icon used in the panel for visible shortcuts, when the shortcut is usable.<br />~~
	~~Note: The scale that can be defined in the sprite may not behave as expected because the game always scales the sprite to fill the GUI slot.~~

	~~{{Prototype property\|disabled_icon\|[[Types/Sprite\|Sprite]]\|Uses [[#icon]] definition\|optional=true}}~~
	~~The icon used when the shortcut is shown in the quickbar, and is not usable.<br />~~
	~~Note: The scale that can be defined in the sprite may not behave as expected because the game always scales the sprite to fill the GUI slot.~~

	~~{{Prototype property\|disabled_small_icon\|[[Types/Sprite\|Sprite]]\| Uses [[#disabled_icon]] definition\|optional=true}}~~
	~~The icon used in the panel for visible shortcuts, when the shortcut is not usable.<br />~~
	~~Note: The scale that can be defined in the sprite may not behave as expected because the game always scales the sprite to fill the GUI slot.~~

	~~{{Prototype property\|style\|[[Types/string\|string]]\|"default"\|optional=true}}~~
	~~One of "default", "blue", "red" and "green".~~

	~~== Example ==~~

	~~<syntaxhighlight lang="lua"> {~~
	~~type = "shortcut",~~
	~~name = "give-deconstruction-planner",~~
	~~order = "b[blueprints]-g[deconstruction-planner]",~~
	~~action = "spawn-item",~~
	~~localised_name = {"shortcut.make-deconstruction-planner"},~~
	~~associated_control_input = "give-deconstruction-planner",~~
	~~technology_to_unlock = "construction-robotics",~~
	~~item_to_spawn = "deconstruction-planner",~~
	~~style = "red",~~
	~~icon =~~
	{
	~~filename = "__base__/graphics/icons/shortcut-toolbar/mip/new-deconstruction-planner-x32-white.png",~~
	~~priority = "extra-high-no-scale",~~
	~~size = 32,~~
	~~mipmap_count = 2,~~
	~~flags = {"gui-icon"}~~
	},
	~~small_icon =~~
	{
	~~filename = "__base__/graphics/icons/shortcut-toolbar/mip/new-deconstruction-planner-x24-white.png",~~
	~~priority = "extra-high-no-scale",~~
	~~size = 24,~~
	~~mipmap_count = 2,~~
	~~flags = {"gui-icon"}~~
	},
	~~disabled_small_icon =~~
	{
	~~filename = "__base__/graphics/icons/shortcut-toolbar/mip/new-deconstruction-planner-x24-white.png",~~
	~~priority = "extra-high-no-scale",~~
	~~size = 24,~~
	~~mipmap_count = 2,~~
	~~flags = {"gui-icon"}~~
	}
	~~}</syntaxhighlight>~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:43:28Z

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/ShortcutPrototype.html https://lua-api.factorio.com/latest/prototypes/ShortcutPrototype.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/ShortcutPrototype.html https://lua-api.factorio.com/latest/prototypes/ShortcutPrototype.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/Shortcut": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:53:10Z

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

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

BilkaBot: Migrated prototype doc to separate website

2023-08-16T17:53:10Z

Migrated prototype doc to separate website

← Older revision		Revision as of 17:53, 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/ShortcutPrototype.html https://lua-api.factorio.com/latest/prototypes/ShortcutPrototype.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}}
	Definition for a shortcut button in the [[shortcut bar]].<br>		Definition for a shortcut button in the [[shortcut bar]].<br>

Bilka: wording

2022-12-01T17:23:26Z

wording

← Older revision		Revision as of 17:23, 1 December 2022
Line 11:		Line 11:
	One of "toggle-alt-mode", "undo", "copy", "cut", "paste", "import-string", "toggle-personal-roboport", "toggle-equipment-movement-bonus", "spawn-item" and "lua".		One of "toggle-alt-mode", "undo", "copy", "cut", "paste", "import-string", "toggle-personal-roboport", "toggle-equipment-movement-bonus", "spawn-item" and "lua".

	~~When~~ this is "lua", [https://lua-api.factorio.com/latest/events.html#on_lua_shortcut defines.events.on_lua_shortcut] is raised when the shortcut is clicked.		If this is "lua", [https://lua-api.factorio.com/latest/events.html#on_lua_shortcut defines.events.on_lua_shortcut] is raised when the shortcut is clicked.

	{{Prototype property\|icon\|[[Types/Sprite\|Sprite]]}}		{{Prototype property\|icon\|[[Types/Sprite\|Sprite]]}}

Bilka: link event for lua action

2022-12-01T17:22:49Z

link event for lua action

← Older revision		Revision as of 17:22, 1 December 2022
Line 10:		Line 10:
	{{Prototype property\|action\|[[Types/string\|string]]}}		{{Prototype property\|action\|[[Types/string\|string]]}}
	One of "toggle-alt-mode", "undo", "copy", "cut", "paste", "import-string", "toggle-personal-roboport", "toggle-equipment-movement-bonus", "spawn-item" and "lua".		One of "toggle-alt-mode", "undo", "copy", "cut", "paste", "import-string", "toggle-personal-roboport", "toggle-equipment-movement-bonus", "spawn-item" and "lua".

			When this is "lua", [https://lua-api.factorio.com/latest/events.html#on_lua_shortcut defines.events.on_lua_shortcut] is raised when the shortcut is clicked.

	{{Prototype property\|icon\|[[Types/Sprite\|Sprite]]}}		{{Prototype property\|icon\|[[Types/Sprite\|Sprite]]}}
Line 27:		Line 29:

	{{Prototype property\|associated_control_input\|[[Types/string\|string]]\|""\|optional=true}}		{{Prototype property\|associated_control_input\|[[Types/string\|string]]\|""\|optional=true}}
	Name of a custom input or vanilla control. This is only used to show the keybind in the tooltip of the shortcut.		Name of a custom input or vanilla control. This is ''only'' used to show the keybind in the tooltip of the shortcut.

	{{Prototype property\|small_icon\|[[Types/Sprite\|Sprite]]\|Uses [[#icon]] definition\|optional=true}}		{{Prototype property\|small_icon\|[[Types/Sprite\|Sprite]]\|Uses [[#icon]] definition\|optional=true}}

Bilka: only

2022-12-01T17:19:48Z

only

← Older revision		Revision as of 17:19, 1 December 2022
Line 27:		Line 27:

	{{Prototype property\|associated_control_input\|[[Types/string\|string]]\|""\|optional=true}}		{{Prototype property\|associated_control_input\|[[Types/string\|string]]\|""\|optional=true}}
	Name of a custom input or vanilla control. ~~Used~~ to show the keybind in the tooltip of the shortcut.		Name of a custom input or vanilla control. This is only used to show the keybind in the tooltip of the shortcut.

	{{Prototype property\|small_icon\|[[Types/Sprite\|Sprite]]\|Uses [[#icon]] definition\|optional=true}}		{{Prototype property\|small_icon\|[[Types/Sprite\|Sprite]]\|Uses [[#icon]] definition\|optional=true}}

Bilka: tech to unlock behaviour

2022-11-15T12:12:39Z

tech to unlock behaviour

← Older revision		Revision as of 12:12, 15 November 2022
Line 1:		Line 1:
	{{Prototype parent\|PrototypeBase}}		{{Prototype parent\|PrototypeBase}}
	Definition for a shortcut button in the [[shortcut bar]].<br>		Definition for a shortcut button in the [[shortcut bar]].<br>
	This is ''not'' a custom keybinding (keyboard shortcut), for that see [[Prototype/CustomInput]]		This is ''not'' a custom keybinding (keyboard shortcut), for that see [[Prototype/CustomInput]].

	{{Prototype TOC\|shortcut}}		{{Prototype TOC\|shortcut}}
Line 21:		Line 21:

	{{Prototype property\|technology_to_unlock\|[[Types/string\|string]]\|optional=true}}		{{Prototype property\|technology_to_unlock\|[[Types/string\|string]]\|optional=true}}
	Name of a [[Prototype/Technology]]. The technology that must be researched before this shortcut can be used.		Name of a [[Prototype/Technology]]. The technology that must be researched before this shortcut can be used. Once a shortcut is unlocked in one save file, it is unlocked for all future save files.

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

Xorimuth: disabled_small_icon's default behaviour changed in 1.1.37 to inherit from disabled_icon instead of icon. Added internal links (`icon` -> `#icon`)

2021-08-09T21:12:59Z

disabled_small_icon's default behaviour changed in 1.1.37 to inherit from disabled_icon instead of icon. Added internal links (`icon` -> `#icon`)

← Older revision		Revision as of 21:12, 9 August 2021
Line 29:		Line 29:
	Name of a custom input or vanilla control. Used to show the keybind in the tooltip of the shortcut.		Name of a custom input or vanilla control. Used to show the keybind in the tooltip of the shortcut.

	{{Prototype property\|small_icon\|[[Types/Sprite\|Sprite]]\|Uses icon definition\|optional=true}}		{{Prototype property\|small_icon\|[[Types/Sprite\|Sprite]]\|Uses [[#icon]] definition\|optional=true}}
	The icon used in the panel for visible shortcuts, when the shortcut is usable.<br />		The icon used in the panel for visible shortcuts, when the shortcut is usable.<br />
	Note: The scale that can be defined in the sprite may not behave as expected because the game always scales the sprite to fill the GUI slot.		Note: The scale that can be defined in the sprite may not behave as expected because the game always scales the sprite to fill the GUI slot.

	{{Prototype property\|disabled_icon\|[[Types/Sprite\|Sprite]]\|Uses icon definition\|optional=true}}		{{Prototype property\|disabled_icon\|[[Types/Sprite\|Sprite]]\|Uses [[#icon]] definition\|optional=true}}
	The icon used when the shortcut is shown in the quickbar, and is not usable.<br />		The icon used when the shortcut is shown in the quickbar, and is not usable.<br />
	Note: The scale that can be defined in the sprite may not behave as expected because the game always scales the sprite to fill the GUI slot.		Note: The scale that can be defined in the sprite may not behave as expected because the game always scales the sprite to fill the GUI slot.

	{{Prototype property\|disabled_small_icon\|[[Types/Sprite\|Sprite]]\|Uses ~~icon~~ definition\|optional=true}}		{{Prototype property\|disabled_small_icon\|[[Types/Sprite\|Sprite]]\| Uses [[#disabled_icon]] definition\|optional=true}}
	The icon used in the panel for visible shortcuts, when the shortcut is not usable.<br />		The icon used in the panel for visible shortcuts, when the shortcut is not usable.<br />
	Note: The scale that can be defined in the sprite may not behave as expected because the game always scales the sprite to fill the GUI slot.		Note: The scale that can be defined in the sprite may not behave as expected because the game always scales the sprite to fill the GUI slot.

Xorimuth: Add default info to optional icon properties; wording can probably be improved

2021-07-18T21:33:48Z

Add default info to optional icon properties; wording can probably be improved

← Older revision		Revision as of 21:33, 18 July 2021
Line 29:		Line 29:
	Name of a custom input or vanilla control. Used to show the keybind in the tooltip of the shortcut.		Name of a custom input or vanilla control. Used to show the keybind in the tooltip of the shortcut.

	{{Prototype property\|small_icon\|[[Types/Sprite\|Sprite]]\|optional=true}}		{{Prototype property\|small_icon\|[[Types/Sprite\|Sprite]]\|Uses icon definition\|optional=true}}
	The icon used in the panel for visible shortcuts, when the shortcut is usable.<br />		The icon used in the panel for visible shortcuts, when the shortcut is usable.<br />
	Note: The scale that can be defined in the sprite may not behave as expected because the game always scales the sprite to fill the GUI slot.		Note: The scale that can be defined in the sprite may not behave as expected because the game always scales the sprite to fill the GUI slot.

	{{Prototype property\|disabled_icon\|[[Types/Sprite\|Sprite]]\|optional=true}}		{{Prototype property\|disabled_icon\|[[Types/Sprite\|Sprite]]\|Uses icon definition\|optional=true}}
	The icon used when the shortcut is shown in the quickbar, and is not usable.<br />		The icon used when the shortcut is shown in the quickbar, and is not usable.<br />
	Note: The scale that can be defined in the sprite may not behave as expected because the game always scales the sprite to fill the GUI slot.		Note: The scale that can be defined in the sprite may not behave as expected because the game always scales the sprite to fill the GUI slot.

	{{Prototype property\|disabled_small_icon\|[[Types/Sprite\|Sprite]]\|optional=true}}		{{Prototype property\|disabled_small_icon\|[[Types/Sprite\|Sprite]]\|Uses icon definition\|optional=true}}
	The icon used in the panel for visible shortcuts, when the shortcut is not usable.<br />		The icon used in the panel for visible shortcuts, when the shortcut is not usable.<br />
	Note: The scale that can be defined in the sprite may not behave as expected because the game always scales the sprite to fill the GUI slot.		Note: The scale that can be defined in the sprite may not behave as expected because the game always scales the sprite to fill the GUI slot.