LuaCustomInputPrototype

Prototype of a custom input.

Parent

• LuaPrototypeBase

Attributes

event_id

• Read: defines.events
• Write: unknown
• Optional: false

Event identifier associated with this custom input.

key_sequence

• Read: string
• Write: unknown
• Optional: false

The default key sequence for this custom input.

alternative_key_sequence

• Read: string
• Write: unknown
• Optional: true

The default alternative key sequence for this custom input, if any

controller_key_sequence

• Read: string
• Write: unknown
• Optional: true

The default controller key sequence for this custom input, if any

controller_alternative_key_sequence

• Read: string
• Write: unknown
• Optional: true

The default controller alternative key sequence for this custom input, if any

linked_game_control

• Read: LinkedGameControl
• Write: unknown
• Optional: true

The linked game control name, if any.

consuming

• Read: "none" | "game-only"
• Write: unknown
• Optional: false

The consuming type.

action

• Read: string
• Write: unknown
• Optional: false

The action that happens when this custom input is triggered.

enabled

• Read: boolean
• Write: unknown
• Optional: false

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

enabled_while_spectating

• Read: boolean
• Write: unknown
• Optional: false

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

enabled_while_in_cutscene

• Read: boolean
• Write: unknown
• Optional: false

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

include_selected_prototype

• Read: boolean
• Write: unknown
• Optional: false

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

item_to_spawn

• Read: LuaItemPrototype
• Write: unknown
• Optional: true

The item that gets spawned when this custom input is fired, if any.

valid

• Read: boolean
• Write: unknown
• Optional: false

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
• Write: unknown
• Optional: false

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.