Version:

UI World Components

Controls the loading and unloading of UI canvases.

UiCanvasAssetRefBus

Services messages for the UiCanvasAssetRefComponent.

Loads the UI canvas using the stored asset reference. Returns the entity ID of the loaded canvas.

Syntax

AZ::EntityId LoadCanvas()

Unloads the UI canvas using the stored asset reference.

Syntax

void UnloadCanvas()

Handles events sent by the UiCanvasAssetRefComponent.

Called when the canvas asset reference loads a UI canvas.

Syntax

void OnCanvasLoadedIntoEntity(AZ::EntityId uiCanvasEntity)

Services messages for the UiCanvasProxyRefComponent.

Sets the entity that manages the UI canvas for this proxy.

Syntax

void SetCanvasRefEntity(AZ::EntityId canvasAssetRefEntity)

Services messages for the UiCanvasAssetRefComponent and UiCanvasProxyRefComponent.

Returns the UI canvas associated with this entity

Syntax

AZ::EntityId GetCanvas()

Provides notifications of when the UI canvas reference changes.

Called when the canvas referenced by a UiCanvasAssetRefComponent has changed. This can happen when LoadCanvas, UnloadCanvas, or SetCanvasRefEntity is called.

Syntax

void OnCanvasRefChanged(AZ::EntityId uiCanvasRefEntity, AZ::EntityId uiCanvasEntity