Prototype/Shortcut

From Official Factorio Wiki
Revision as of 15:02, 28 October 2020 by Bilka (talk | contribs) (formatting)
Jump to navigation Jump to search

Template:Prototype parent Definition for a shortcut button in the shortcut bar.
This is not a custom keybinding (keyboard shortcut), for that see Prototype/CustomInput

Template:Prototype TOC

Mandatory properties

Inherits all properties from PrototypeBase.

Template:Prototype property One of "toggle-alt-mode", "undo", "copy", "cut", "paste", "import-string", "toggle-personal-roboport", "toggle-equipment-movement-bonus", "create-blueprint-item" and "lua".

Template:Prototype property

Optional properties

Template:Prototype property Name of a Prototype/Item. The item to create when clicking on a shortcut with the action set to "create-blueprint-item".

Template:Prototype property Name of a Prototype/Technology. The technology that must be researched before this shortcut can be used.

Template:Prototype property Must be enabled for the Factorio API to be able to set the toggled state on the shortcut button, see LuaPlayer.set_shortcut_toggled.

Template:Prototype property Name of a custom input or vanilla control. Used to show the keybind in the tooltip of the shortcut.

Template:Prototype property

Template:Prototype property

Template:Prototype property

Template:Prototype property One of "default", "blue", "red" and "green".

Example

{
    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"}
    },
  }