UiEntityContext Class Reference

#include <UiEntityContext.h>

Inherits AzFramework::EntityContext, and UiEntityContextRequestBus::Handler.

Inherited by UiEditorEntityContext, and UiGameEntityContext.

Public Member Functions
virtual void	InitUiContext ()=0
	Initialize the entity context and instantiate the root slice.
virtual void	DestroyUiContext ()=0
	Destroy the Entity Context.
virtual bool	SaveToStreamForGame (AZ::IO::GenericStream &stream, AZ::DataStream::StreamType streamType)=0
virtual bool	SaveCanvasEntityToStreamForGame (AZ::Entity *canvasEntity, AZ::IO::GenericStream &stream, AZ::DataStream::StreamType streamType)=0

Detailed Description

The UI Entity Context stores the prefab asset for the root slice of a UI canvas So all of the UI element entities in a canvas are owned indirectly by the context and managed by the entity context.

Member Function Documentation

DestroyUiContext()

virtual void UiEntityContext::DestroyUiContext ( )

pure virtual

Destroy the Entity Context.

Implemented in UiEditorEntityContext, and UiGameEntityContext.

InitUiContext()

virtual void UiEntityContext::InitUiContext ( )

pure virtual

Initialize the entity context and instantiate the root slice.

Implemented in UiEditorEntityContext, and UiGameEntityContext.

SaveCanvasEntityToStreamForGame()

virtual bool UiEntityContext::SaveCanvasEntityToStreamForGame ( AZ::Entity *  canvasEntity, AZ::IO::GenericStream &  stream, AZ::DataStream::StreamType  streamType  )

pure virtual

Saves the given canvas entity to the specified buffer. If necessary the entity undergoes conversion for game: editor -> game components.

Returns

true if successfully saved. Failure is only possible if serialization data is corrupt. This is needed because the canvas entity is not part of the root slice. It is here in the entity context because that allows us to get to the ToolsFramework functionality.

Implemented in UiEditorEntityContext, and UiGameEntityContext.

SaveToStreamForGame()

virtual bool UiEntityContext::SaveToStreamForGame ( AZ::IO::GenericStream &  stream, AZ::DataStream::StreamType  streamType  )

pure virtual

Saves the context's slice root to the specified buffer. If necessary entities undergo conversion for game: editor -> game components.

Returns

true if successfully saved. Failure is only possible if serialization data is corrupt.

Implemented in UiEditorEntityContext, and UiGameEntityContext.

---

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

• Gems/LyShine/Code/Include/LyShine/UiEntityContext.h