LuaCustomInputPrototype

Prototype of a custom input.

class LuaCustomInputPrototype - sort
name :: string [R] Name of this prototype.
order :: string [R] Order string of this prototype.
localised_name :: LocalisedString [R]
localised_description :: LocalisedString [R]
key_sequence :: string [R] The default key sequence for this custom input.
alternative_key_sequence :: string [R] The default alternative key sequence for this custom input.
linked_game_control :: string [R] The linked game control name or nil.
consuming :: string [R] The consuming type: "none" or "game-only".
action :: string [R] The action that happens when this custom input is triggered.
enabled :: boolean [R] If this custom input is enabled.
enabled_while_spectating :: boolean [R] If this custom input is enabled while using the spectator controller.
enabled_while_in_cutscene :: boolean [R] If this custom input is enabled while using the cutscene controller.
include_selected_prototype :: boolean [R] If this custom input will include the selected prototype (if any) when triggered.
item_to_spawn :: LuaItemPrototype [R] The item that gets spawned when this custom input is fired or nil.
valid :: boolean [R] Is this object valid?
object_name :: string [R] The class name of this object.
help() → string All methods and properties that this object supports.
name :: string [Read-only]

Name of this prototype.

order :: string [Read-only]

Order string of this prototype.

localised_name :: LocalisedString [Read-only]

localised_description :: LocalisedString [Read-only]

key_sequence :: string [Read-only]

The default key sequence for this custom input.

alternative_key_sequence :: string [Read-only]

The default alternative key sequence for this custom input. nil when not defined.

linked_game_control :: string [Read-only]

The linked game control name or nil.

consuming :: string [Read-only]

The consuming type: "none" or "game-only".

action :: string [Read-only]

The action that happens when this custom input is triggered.

enabled :: boolean [Read-only]

If this custom input is enabled. Disabled custom inputs exist but are not used by the game.

enabled_while_spectating :: boolean [Read-only]

If this custom input is enabled while using the spectator controller.

enabled_while_in_cutscene :: boolean [Read-only]

If this custom input is enabled while using the cutscene controller.

include_selected_prototype :: boolean [Read-only]

If this custom input will include the selected prototype (if any) when triggered.

item_to_spawn :: LuaItemPrototype [Read-only]

The item that gets spawned when this custom input is fired or nil.