AzFramework::EntityOwnershipService Class Reference

Inherits AZ::Data::AssetBus::MultiHandler.

Inherited by AzFramework::PrefabEntityOwnershipService, and AzFramework::SliceEntityOwnershipService.

Public Types
using	EntityIdToEntityIdMap = AZStd::unordered_map< AZ::EntityId, AZ::EntityId >

Public Member Functions
virtual void	Initialize ()=0
	Initializes all assets/entities/components required for managing entities.
virtual bool	IsInitialized ()=0
	Returns true if the entity ownership service is initialized.
virtual void	Destroy ()=0
	Destroys all the assets/entities/components created for managing entities.
virtual void	Reset ()=0
	Resets the assets/entities/components without fully destroying them for managing entities.
virtual void	AddEntity (AZ::Entity *entity)=0
virtual void	AddEntities (const EntityList &entities)=0
virtual bool	DestroyEntity (AZ::Entity *entity)=0
virtual bool	DestroyEntityById (AZ::EntityId entityId)=0
virtual void	GetNonPrefabEntities (EntityList &entityList)=0
virtual bool	GetAllEntities (EntityList &entityList)=0
virtual void	InstantiateAllPrefabs ()=0
virtual void	HandleEntitiesAdded (const EntityList &entities)=0
virtual bool	LoadFromStream (AZ::IO::GenericStream &stream, bool remapIds, EntityIdToEntityIdMap *idRemapTable=nullptr, const AZ::ObjectStream::FilterDescriptor &filterDesc=AZ::ObjectStream::FilterDescriptor())=0
virtual void	SetEntitiesAddedCallback (OnEntitiesAddedCallback onEntitiesAddedCallback)=0
virtual void	SetEntitiesRemovedCallback (OnEntitiesRemovedCallback onEntitiesRemovedCallback)=0
virtual void	SetValidateEntitiesCallback (ValidateEntitiesCallback validateEntitiesCallback)=0
virtual void	HandleEntityBeingDestroyed (const AZ::EntityId &entityId)=0

Protected Attributes
OnEntitiesAddedCallback	m_entitiesAddedCallback
OnEntitiesRemovedCallback	m_entitiesRemovedCallback
ValidateEntitiesCallback	m_validateEntitiesCallback

Member Function Documentation

AddEntities()

virtual void AzFramework::EntityOwnershipService::AddEntities ( const EntityList &  entities )

pure virtual

Implemented in AzFramework::SliceEntityOwnershipService.

AddEntity()

virtual void AzFramework::EntityOwnershipService::AddEntity ( AZ::Entity *  entity )

pure virtual

Implemented in AzFramework::SliceEntityOwnershipService.

Destroy()

virtual void AzFramework::EntityOwnershipService::Destroy ( )

pure virtual

Destroys all the assets/entities/components created for managing entities.

Implemented in AzFramework::SliceEntityOwnershipService.

DestroyEntity()

virtual bool AzFramework::EntityOwnershipService::DestroyEntity ( AZ::Entity *  entity )

pure virtual

Implemented in AzFramework::SliceEntityOwnershipService.

DestroyEntityById()

virtual bool AzFramework::EntityOwnershipService::DestroyEntityById ( AZ::EntityId  entityId )

pure virtual

Implemented in AzFramework::SliceEntityOwnershipService.

GetAllEntities()

virtual bool AzFramework::EntityOwnershipService::GetAllEntities ( EntityList &  entityList )

pure virtual

Gets all entities, including those that are owned by prefabs in the entity ownership service.

Parameters

entityList

The entity list to add the entities to.

Returns

bool whether fetching entities was successful.

Implemented in AzFramework::SliceEntityOwnershipService.

GetNonPrefabEntities()

virtual void AzFramework::EntityOwnershipService::GetNonPrefabEntities ( EntityList &  entityList )

pure virtual

Gets the entities in entity ownership service that do not belong to a prefab.

Parameters

entityList

The entity list to add the entities to.

Implemented in AzFramework::SliceEntityOwnershipService.

HandleEntitiesAdded()

virtual void AzFramework::EntityOwnershipService::HandleEntitiesAdded ( const EntityList &  entities )

pure virtual

Implemented in AzFramework::SliceEntityOwnershipService.

HandleEntityBeingDestroyed()

virtual void AzFramework::EntityOwnershipService::HandleEntityBeingDestroyed ( const AZ::EntityId &  entityId )

pure virtual

Called when an entity is in the process of being destroyed

Parameters

entityId

The entity Id of the entity being destroyed.

Implemented in AzFramework::SliceEntityOwnershipService.

Initialize()

virtual void AzFramework::EntityOwnershipService::Initialize ( )

pure virtual

Initializes all assets/entities/components required for managing entities.

Implemented in AzFramework::SliceEntityOwnershipService.

InstantiateAllPrefabs()

virtual void AzFramework::EntityOwnershipService::InstantiateAllPrefabs ( )

pure virtual

Instantiates all the prefabs that are in the entity ownership service.

Implemented in AzFramework::SliceEntityOwnershipService.

IsInitialized()

virtual bool AzFramework::EntityOwnershipService::IsInitialized ( )

pure virtual

Returns true if the entity ownership service is initialized.

Implemented in AzFramework::SliceEntityOwnershipService.

LoadFromStream()

virtual bool AzFramework::EntityOwnershipService::LoadFromStream ( AZ::IO::GenericStream &  stream, bool  remapIds, EntityIdToEntityIdMap *  idRemapTable = nullptr, const AZ::ObjectStream::FilterDescriptor &  filterDesc = AZ::ObjectStream::FilterDescriptor()  )

pure virtual

Implemented in AzFramework::SliceEntityOwnershipService.

Reset()

virtual void AzFramework::EntityOwnershipService::Reset ( )

pure virtual

Resets the assets/entities/components without fully destroying them for managing entities.

Implemented in AzFramework::SliceEntityOwnershipService, and AzFramework::SliceGameEntityOwnershipService.

---

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

• Code/Framework/AzFramework/AzFramework/Entity/EntityOwnershipService.h