Prototype/Shortcut: Difference between revisions
(Add default info to optional icon properties; wording can probably be improved) |
(disabled_small_icon's default behaviour changed in 1.1.37 to inherit from disabled_icon instead of icon. Added internal links (`icon` -> `#icon`)) |
||
| 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 | {{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. | ||
Revision as of 21:12, 9 August 2021
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
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", "spawn-item" and "lua".
Template:Prototype property
Scales to fit a 16x16-pixel square.
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
Template:Prototype property 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 "spawnable" flag set.
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
The icon used in the panel for visible shortcuts, when the shortcut is usable.
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.
Template:Prototype property
The icon used when the shortcut is shown in the quickbar, and is not usable.
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.
Template:Prototype property
The icon used in the panel for visible shortcuts, when the shortcut is not usable.
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.
Template:Prototype property One of "default", "blue", "red" and "green".
Example
{
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"}
}
}