#include <UiEntityContextBus.h>

Inherits AZ::EBusTraits.

Public Types
typedef AzFramework::EntityContextId	BusIdType

Public Member Functions
virtual AZ::Entity *	CreateUiEntity (const char *name)=0

virtual void	AddUiEntity (AZ::Entity *entity)=0
	Registers an existing entity with a UI context.

virtual void	AddUiEntities (const AzFramework::EntityList &entities)=0
	Registers an existing set of entities with a UI context.

virtual bool	DestroyUiEntity (AZ::EntityId entityId)=0

virtual bool	CloneUiEntities (const AZStd::vector< AZ::EntityId > &sourceEntities, AzFramework::EntityList &resultEntities)=0

Static Public Attributes
static const AZ::EBusAddressPolicy	AddressPolicy = AZ::EBusAddressPolicy::ById

static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Single

Detailed Description

Bus for making requests to the UI entity context. There is one UiEntityContext per UI canvas.

Member Function Documentation

virtual bool UiEntityContextRequests::CloneUiEntities	(	const AZStd::vector< AZ::EntityId > &	sourceEntities,
		AzFramework::EntityList &	resultEntities
	)

pure virtual

Clones a set of entities.

Parameters

sourceEntities	- the source set of entities to clone
resultEntities	- the set of entities cloned from the source

virtual AZ::Entity* UiEntityContextRequests::CreateUiEntity ( const char * name )

pure virtual

Creates an entity in a UI context.

virtual bool UiEntityContextRequests::DestroyUiEntity ( AZ::EntityId entityId )

pure virtual

Destroys an entity in a UI context.

Returns: whether or not the entity was destroyed. A false return value signifies the entity did not belong to the UI context.

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