Factorio.com|Forums|Wiki|Mod Portal|API Docs

# Factorio Runtime Docs Version 2.0.77

# LuaShortcutPrototype - Runtime Docs

## Class LuaShortcutPrototype extends LuaPrototypeBase

Prototype of a shortcut.

Inherits from LuaPrototypeBase

## Members

action | :: R string |
item_to_spawn | :: R LuaItemPrototype? | The item to create when this shortcut is used, if any.
The item to create when this shortcut is used, if any.
technology_to_unlock | :: R LuaTechnologyPrototype? | The technology that needs to be researched once (in any save) for this shortcut to be unlocked (in all saves).
The technology that needs to be researched once (in any save) for this shortcut to be unlocked (in all saves).
toggleable | :: R boolean |
associated_control_input | :: R string? | The control input that is associated with this shortcut, if any.
The control input that is associated with this shortcut, if any.
valid | :: R boolean | Is this object valid? [...]
Is this object valid? [...]
object_name | :: R string | The class name of this object. [...]
The class name of this object. [...]

Inherited from LuaPrototypeBase

type | :: R string | Type of this prototype.
Type of this prototype.
name | :: R string | Name of this prototype.
Name of this prototype.
order | :: R string | The string used to alphabetically sort these prototypes. [...]
The string used to alphabetically sort these prototypes. [...]
localised_name | :: R LocalisedString |
localised_description | :: R LocalisedString |
factoriopedia_description | :: R LocalisedString | Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
group | :: R LuaGroup | Group of this prototype.
Group of this prototype.
subgroup | :: R LuaGroup | Subgroup of this prototype.
Subgroup of this prototype.
hidden | :: R boolean |
hidden_in_factoriopedia | :: R boolean |
parameter | :: R boolean |
custom_tooltip_fields | :: R array[CustomTooltipField]? | Extra description items in the tooltip and Factoriopedia.
Extra description items in the tooltip and Factoriopedia.

## Attributes

### action :: Read string

### item_to_spawn :: Read LuaItemPrototype?

The item to create when this shortcut is used, if any.

### technology_to_unlock :: Read LuaTechnologyPrototype?

The technology that needs to be researched once (in any save) for this shortcut to be unlocked (in all saves).

### toggleable :: Read boolean

### associated_control_input :: Read string?

The control input that is associated with this shortcut, if any.

### valid :: Read boolean

Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be `false`. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.

### object_name :: Read string

The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

Class used in

- LuaPrototypes::shortcut