LuaGui

The root of the GUI. This type houses the root elements, top, left, center, goal, and screen, to which other elements can be added to be displayed on screen.

Every player can have a different GUI state.

Attributes

player

• Read: LuaPlayer
• Write: unknown
• Optional: false

The player who owns this gui.

children

• Read: Dict<string, LuaGuiElement>
• Write: unknown
• Optional: false

The children GUI elements mapped by name <> element.

top

• Read: LuaGuiElement
• Write: unknown
• Optional: false

The top part of the GUI. It is a flow element inside a scroll pane element.

left

• Read: LuaGuiElement
• Write: unknown
• Optional: false

The left part of the GUI. It is a flow element inside a scroll pane element.

center

• Read: LuaGuiElement
• Write: unknown
• Optional: false

The center part of the GUI. It is a flow element.

goal

• Read: LuaGuiElement
• Write: unknown
• Optional: false

The flow used in the objectives window. It is a flow element. The objectives window is only visible when the flow is not empty or the objective text is set.

screen

• Read: LuaGuiElement
• Write: unknown
• Optional: false

For showing a GUI somewhere on the entire screen. It is an empty-widget element.

relative

• Read: LuaGuiElement
• Write: unknown
• Optional: false

For showing a GUI somewhere relative to one of the game GUIs. It is an empty-widget element.

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.