Open 3D Engine AzFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzFramework::Spawnable::EntityAliasVisitor Class Referencefinal

Inherits AzFramework::Spawnable::EntityAliasConstVisitor.

Public Types

using ListSpawnablesRequiringLoadCallback = AZStd::function< void(AZ::Data::Asset< Spawnable > &spawnablePendingLoad)>
 
using UpdateCallback = AZStd::function< void(Spawnable::EntityAliasType &aliasType, bool &queueLoad, const AZ::Data::Asset< Spawnable > &aliasedSpawnable, const AZ::Crc32 tag, const uint32_t sourceIndex, const uint32_t targetIndex)>
 

Public Member Functions

 EntityAliasVisitor (Spawnable &owner, EntityAliasList *m_entityAliasList)
 
 EntityAliasVisitor (EntityAliasVisitor &&rhs)
 
EntityAliasVisitoroperator= (EntityAliasVisitor &&rhs)
 
 EntityAliasVisitor (const EntityAliasVisitor &rhs)=delete
 
EntityAliasVisitoroperator= (const EntityAliasVisitor &rhs)=delete
 
void AddAlias (AZ::Data::Asset< Spawnable > targetSpawnable, AZ::Crc32 tag, uint32_t sourceIndex, uint32_t targetIndex, Spawnable::EntityAliasType aliasType, bool queueLoad)
 
void ListSpawnablesRequiringLoad (const ListSpawnablesRequiringLoadCallback &callback)
 
void UpdateAliases (const UpdateCallback &callback)
 
void UpdateAliases (AZ::Crc32 tag, const UpdateCallback &callback)
 
void UpdateAliasType (uint32_t index, Spawnable::EntityAliasType newType)
 
void Optimize ()
 
- Public Member Functions inherited from AzFramework::Spawnable::EntityAliasConstVisitor
 EntityAliasConstVisitor (const Spawnable &owner, const EntityAliasList *entityAliasList)
 
 EntityAliasConstVisitor (EntityAliasConstVisitor &&rhs)
 
EntityAliasConstVisitoroperator= (EntityAliasConstVisitor &&rhs)
 
 EntityAliasConstVisitor (const EntityAliasConstVisitor &rhs)=delete
 
EntityAliasConstVisitoroperator= (const EntityAliasConstVisitor &rhs)=delete
 
bool IsValid () const
 Checks if the visitor was able to retrieve data. This needs to be checked before calling any other functions.
 
bool HasAliases () const
 
bool AreAllSpawnablesReady () const
 
EntityAliasList::const_iterator begin () const
 
EntityAliasList::const_iterator end () const
 
EntityAliasList::const_iterator cbegin () const
 
EntityAliasList::const_iterator cend () const
 
void ListTargetSpawnables (const ListTargetSpawanblesCallback &callback) const
 
void ListTargetSpawnables (AZ::Crc32 tag, const ListTargetSpawanblesCallback &callback) const
 

Additional Inherited Members

- Protected Types inherited from AzFramework::Spawnable::EntityAliasConstVisitor
using ListTargetSpawanblesCallback = AZStd::function< void(const AZ::Data::Asset< Spawnable > &targetSpawnable)>
 
- Protected Attributes inherited from AzFramework::Spawnable::EntityAliasConstVisitor
const Spawnablem_owner
 
const EntityAliasList * m_entityAliasList {}
 

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