Open 3D Engine LyShine Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
UiCanvasLuaInterface Class Referenceabstract

Mirrors the UiCanvasBus for use in Lua. More...

#include <UiCanvasLuaBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual AZ::EntityId FindElementById (LyShine::ElementId id)=0
 
virtual AZ::EntityId FindElementByName (const LyShine::NameType &name)=0
 
virtual bool GetEnabled ()=0
 
virtual void SetEnabled (bool enabled)=0
 

Detailed Description

Mirrors the UiCanvasBus for use in Lua.

Member Function Documentation

◆ FindElementById()

virtual AZ::EntityId UiCanvasLuaInterface::FindElementById ( LyShine::ElementId  id)
pure virtual

This flavor of FindElementById differs slightly from the UiCanvasBus version in that it returns an EntityId, which is a bit friendly for passing around in Lua. Use of the Element Id is discouraged as it will be deprecated soon.

◆ FindElementByName()

virtual AZ::EntityId UiCanvasLuaInterface::FindElementByName ( const LyShine::NameType &  name)
pure virtual

This flavor of FindElementByName differs slightly from the UiCanvasBus version in that it returns an EntityId, which is a bit friendly for passing around in Lua.

The documentation for this class was generated from the following file: