Struct LuaGui 

pub struct 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.

Implementations

impl LuaGui

pub fn center(&self) -> LuaGuiElement

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

pub fn children(&self) -> HashMap<String, Box<LuaGuiElement>>

The children GUI elements mapped by name <> element.

pub fn goal(&self) -> LuaGuiElement

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.

pub fn left(&self) -> LuaGuiElement

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

pub fn object_name(&self) -> &str

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.

pub fn player(&self) -> LuaPlayer

The player who owns this gui.

pub fn relative(&self) -> LuaGuiElement

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

pub fn screen(&self) -> LuaGuiElement

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

pub fn top(&self) -> LuaGuiElement

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

pub fn valid(&self) -> bool

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.

Trait Implementations

impl Clone for LuaGui

fn clone(&self) -> LuaGui

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for LuaGui

impl Debug for LuaGui

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LuaGui

fn default() -> LuaGui

Returns the “default value” for a type.

impl Eq for LuaGui

impl From<LuaGui> for LuaAny

fn from(_: LuaGui) -> Self

Converts to this type from the input type.

impl LuaObject for LuaGui

impl PartialEq for LuaGui

fn eq(&self, other: &LuaGui) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for LuaGui