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 | Static Public Member Functions | List of all members
UiCanvasNotificationLuaProxy Class Reference

Listens for UiCanvasNotificationBus actions and forwards the calls to the Lua-specific version. More...

#include <UiCanvasNotificationLuaBus.h>

Inherits UiCanvasNotificationBus::Handler.

Public Member Functions

void OnAction (AZ::EntityId entityId, const LyShine::ActionName &actionName) override
 
void BusConnect (AZ::EntityId entityId)
 Connects to the given entity's canvas notifications to forward to Lua.
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Detailed Description

Listens for UiCanvasNotificationBus actions and forwards the calls to the Lua-specific version.

For this to work, the Lua script must create a UiCanvasNotificationLuaProxy object and call BusConnect, passing the entity ID of the entity they want to listen for action notifications from. For example: self.uiCanvasNotificationLuaProxy = UiCanvasNotificationLuaProxy(); self.uiCanvasNotificationLuaProxy:BusConnect(canvasEntityId);

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