AZ::EntityActiveSystemRequests Class Reference

#include <EntityActiveSystemBus.h>

Inherits AZ::EBusTraits.

Public Member Functions
virtual size_t	GetActiveTypeIndexByName (AZStd::string typeName)=0
virtual size_t	GetActiveTypeIndexById (AZ::Crc32 typeNameId)=0

Static Public Attributes
static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Single
static const AZ::EBusAddressPolicy	AddressPolicy = AZ::EBusAddressPolicy::Single
Static Public Attributes inherited from AZ::EBusTraits
static constexpr EBusHandlerPolicy	HandlerPolicy = EBusHandlerPolicy::Multiple
static constexpr EBusAddressPolicy	AddressPolicy = EBusAddressPolicy::Single
static constexpr bool	EnableEventQueue = false
static constexpr bool	EventQueueingActiveByDefault = true
static constexpr bool	EnableQueuedReferences = false
static constexpr bool	LocklessDispatch = false

Additional Inherited Members
Public Types inherited from AZ::EBusTraits
using	AllocatorType = AZ::Internal::EBusEnvironmentAllocator
using	BusIdType = NullBusId
using	BusIdOrderCompare = NullBusIdCompare
using	BusHandlerOrderCompare = BusHandlerCompareDefault
using	MutexType = NullMutex
using	EventQueueMutexType = NullMutex
template<class Bus >
using	ConnectionPolicy = EBusConnectionPolicy< Bus >
template<class Context >
using	StoragePolicy = EBusEnvironmentStoragePolicy< Context >
template<class Bus >
using	RouterPolicy = EBusRouterPolicy< Bus >
using	EventProcessingPolicy = EBusEventProcessingPolicy
template<typename DispatchMutex , bool IsLocklessDispatch>
using	DispatchLockGuard = AZStd::conditional_t< IsLocklessDispatch, AZ::Internal::NullLockGuard< DispatchMutex >, AZStd::scoped_lock< DispatchMutex > >
template<typename ContextMutex >
using	ConnectLockGuard = AZStd::conditional_t< AZStd::is_same_v< ContextMutex, AZ::NullMutex >, AZ::Internal::NullLockGuard< ContextMutex >, AZStd::unique_lock< ContextMutex > >
template<typename ContextMutex >
using	BindLockGuard = AZStd::scoped_lock< ContextMutex >
template<typename ContextMutex >
using	CallstackTrackerLockGuard = AZStd::conditional_t< AZStd::is_same_v< ContextMutex, AZ::NullMutex >, AZ::Internal::NullLockGuard< ContextMutex >, AZStd::unique_lock< ContextMutex > >
Protected Member Functions inherited from AZ::EBusTraits
	~EBusTraits ()=default

Detailed Description

Entities have a bitmask that represents their activation state, where the entity is only activated if all bits are set (true by default). You can use this bus to reserve a bit in the bitmask for your system to cause entities to become inactive for your own purposes (LOD, visibilty, etc.)

Member Function Documentation

GetActiveTypeIndexById()

virtual size_t AZ::EntityActiveSystemRequests::GetActiveTypeIndexById ( AZ::Crc32  typeNameId )

pure virtual

Reserves a bit in the bitset for a given name as a Crc32 and returns the index of it. If the name has already been reserved, returns the existing index without registering a new one.

GetActiveTypeIndexByName()

virtual size_t AZ::EntityActiveSystemRequests::GetActiveTypeIndexByName ( AZStd::string  typeName )

pure virtual

Reserves a bit in the bitset for the given name and returns the index of it. If the name has already been reserved, returns the existing index without registering a new one

---

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

• Code/Framework/AzCore/AzCore/Component/EntityActiveSystemBus.h