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.
UiCanvasUpdateNotification Class Referenceabstract

#include <UiCanvasUpdateNotificationBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual void Update (float deltaTime)=0
 
virtual void UpdateInEditor (float)
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Multiple
 Multiple components on a entity can implement the events.
 

Detailed Description

Elements that require update notifications should connect to this bus using the entity id of their containing canvas.

Member Function Documentation

◆ Update()

virtual void UiCanvasUpdateNotification::Update ( float  deltaTime)
pure virtual

Update the component. This is called when the game is running. It is different from the TickBus in that it is called only when the canvas is updated. So it is not called if the canvas is disabled.

◆ UpdateInEditor()

virtual void UiCanvasUpdateNotification::UpdateInEditor ( float  )
inlinevirtual

Update the component while in the editor. This is called every frame when in the editor and the game is NOT running.


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