LuaDisplayPanelControlBehavior

Control behavior for display panels.

Parent

• LuaControlBehavior

Attributes

messages

• Read: Array<DisplayPanelMessageDefinition>
• Write: Array<DisplayPanelMessageDefinition>
• Optional: false

The full list of configured messages.

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.

Methods

get_message

LuaDisplayPanelControlBehavior.get_message(index: uint32) -> DisplayPanelMessageDefinition

Call As

displayPanelControlBehavior.get_message(index)

Call Convention

• takes_table: false
• table_optional: false

Get a specific message definition

Parameters

• index: uint32 — Message index.

Returns

• DisplayPanelMessageDefinition — The message definition at the specified index.

set_message

LuaDisplayPanelControlBehavior.set_message(index: int32, message: DisplayPanelMessageDefinition | nil)

Call As

displayPanelControlBehavior.set_message(index, message)

Call Convention

• takes_table: false
• table_optional: false

Set the message at the specified index

Parameters

• index: int32 — Message index. Use -1 to append new element.
• message: DisplayPanelMessageDefinition | nil — The message definition for the specified index. Specify nil to remove the message.