Prototype/Shortcut: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(updated to 0.17.18)
(Removed old prototype docs)
 
(23 intermediate revisions by 5 users not shown)
Line 1: Line 1:
==Basics==
<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]
Prototype type: '''shortcut'''


Definition for a shortcut in the shortcut bar of tools.
</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>
 
== Mandatory properties ==
Inherits all properties from [[Prototype]].
 
=== action ===
'''Type''': [[Types/string]]
 
One of "toggle-alt-mode", "undo", "copy", "cut", "paste", "import-string", "toggle-personal-roboport", "toggle-equipment-movement-bonus", "create-blueprint-item" and "lua".
 
=== icon ===
'''Type''': [[Types/Sprite]]
 
== Optional properties ==
 
=== item_to_create ===
'''Type''': [[Types/string]]
 
Name of a [[Prototype/Item]]. The item to create when clicking on a shortcut with the action set to "create-blueprint-item".
 
=== technology_to_unlock ===
'''Type''': [[Types/string]]
 
Name of a [[Prototype/Technology]]. The technology that must be researched before this shortcut can be used.
 
=== toggleable ===
'''Type''': [[Types/bool]]
 
'''Default''': false
 
=== associated_control_input ===
'''Type''': [[Types/string]]
 
'''Default''': ""
 
=== small_icon ===
'''Type''': [[Types/Sprite]]
 
=== disabled_icon ===
'''Type''': [[Types/Sprite]]
 
=== disabled_small_icon ===
'''Type''': [[Types/Sprite]]
 
=== style ===
'''Type''': [[Types/string]]
 
'''Default''': "default"
 
One of "default", "blue", "red" and "green".
 
== Example ==
 
<syntaxhighlight lang="lua">{
    type = "shortcut",
    name = "give-deconstruction-planner",
    order = "b[blueprints]-g[deconstruction-planner]",
    action = "create-blueprint-item",
    localised_name = {"shortcut.make-deconstruction-planner"},
    technology_to_unlock = "construction-robotics",
    item_to_create = "deconstruction-planner",
    style = "red",
    icon =
    {
      filename = "__base__/graphics/icons/shortcut-toolbar/new-deconstruction-planner-x32-white.png",
      priority = "extra-high-no-scale",
      size = 32,
      scale = 1,
      flags = {"icon"}
    },
    small_icon =
    {
      filename = "__base__/graphics/icons/shortcut-toolbar/new-deconstruction-planner-x24.png",
      priority = "extra-high-no-scale",
      size = 24,
      scale = 1,
      flags = {"icon"}
    },
    disabled_small_icon =
    {
      filename = "__base__/graphics/icons/shortcut-toolbar/new-deconstruction-planner-x24-white.png",
      priority = "extra-high-no-scale",
      size = 24,
      scale = 1,
      flags = {"icon"}
    },
  }</syntaxhighlight>

Latest revision as of 14:33, 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/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 on the forums.

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