UiCanvasAssetRefInterface Class Reference

#include <UiCanvasRefBus.h>

Inherits AZ::ComponentBus.

Public Member Functions
virtual AZStd::string	GetCanvasPathname ()=0
virtual void	SetCanvasPathname (const AZStd::string &pathname)=0
	Set the canvas pathname.
virtual bool	GetIsAutoLoad ()=0
	Get the flag indicating whether this component will automatically load the canvas.
virtual void	SetIsAutoLoad (bool isAutoLoad)=0
	Set the flag indicating whether this component will automatically load the canvas.
virtual bool	GetShouldLoadDisabled ()=0
	Get the flag indicating whether the canvas should be loaded in a disabled state.
virtual void	SetShouldLoadDisabled (bool shouldLoadDisabled)=0
	Set the flag indicating whether the canvas should be loaded in a disabled state.
virtual AZ::EntityId	LoadCanvas ()=0
	Load the UI canvas using the stored asset ref.
virtual void	UnloadCanvas ()=0
	Unload the UI canvas using the stored asset ref (if it is owned by this component)

Detailed Description

UiCanvasAssetRefBus Allows loading and unloading of a UI canvas asset using a pathname stored in a component on an entity in the level.

Member Function Documentation

GetCanvasPathname()

virtual AZStd::string UiCanvasAssetRefInterface::GetCanvasPathname ( )

pure virtual

Get the canvas pathname. This is the pathname of the canvas that this component will load (either on activate or when told to load by the LoadCanvas method) The Canvas pathname can be empty and the associated canvas can be set via SetCanvas

---

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

• Gems/LyShine/Code/Include/LyShine/Bus/World/UiCanvasRefBus.h