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.
| is_valid_sprite_path(sprite_path) → boolean | Returns true if sprite_path is valid and contains loaded sprite, otherwise false. |
| player :: LuaPlayer [R] | The player who owns this gui. |
| children :: dictionary[string → LuaGuiElement] [R] | The children GUI elements mapped by name <> element. |
| top :: LuaGuiElement [R] | The top part of the GUI. |
| left :: LuaGuiElement [R] | The left part of the GUI. |
| center :: LuaGuiElement [R] | The center part of the GUI. |
| goal :: LuaGuiElement [R] | The flow used in the objectives window. |
| screen :: LuaGuiElement [R] | For showing a GUI somewhere on the entire screen. |
| relative :: LuaGuiElement [R] | For showing a GUI somewhere relative to one of the game GUIs. |
| 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. |
Returns true if sprite_path is valid and contains loaded sprite, otherwise false. Sprite path of type file doesn't validate if file exists.
The player who owns this gui.
The children GUI elements mapped by name <> element.
The top part of the GUI. It is a flow element inside a scroll pane element.
The left part of the GUI. It is a flow element inside a scroll pane element.
The center part of the GUI. It is a flow element.
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.
For showing a GUI somewhere on the entire screen. It is an empty-widget element.
For showing a GUI somewhere relative to one of the game GUIs. It is an empty-widget element.