Factorio Runtime Docs

Class LuaShortcutPrototype

Prototype of a shortcut.

Members

help()  → string

All methods and properties that this object supports.

All methods and properties that this object supports.

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
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.

Methods

help()  → string

All methods and properties that this object supports.

Attributes

name :: string Read

Name of this prototype.


order :: string Read

The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.


localised_name :: LocalisedString Read


localised_description :: LocalisedString Read


action :: string Read


item_to_spawn :: LuaItemPrototype? Read

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


technology_to_unlock :: LuaTechnologyPrototype? Read

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


toggleable :: boolean Read


associated_control_input :: string? Read

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


valid :: boolean Read

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 :: string Read

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.

Classes

Events

Concepts

Defines

Builtin types

>|