Open 3D Engine AzCore API Reference 26.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
AZ::EntityActiveSystemComponent Class Reference

The System Component that handles and defines Entity Activation Layers. More...

#include <EntityActiveSystemComponent.h>

Inherits AZ::Component, and EntityActiveSystemRequestBus::Handler.

Public Member Functions

 AZ_COMPONENT (EntityActiveSystemComponent, "{AAC78518-BC7B-42DD-8257-7F15C22AD0E3}", AZ::Component)
 
size_t GetActiveTypeIndexByName (AZStd::string typeName) override
 
size_t GetActiveTypeIndexById (AZ::Crc32 typeNameId) override
 
size_t ScanListForIndex (AZ::Crc32 typeNameId)
 
void Activate () override
 
void Deactivate () override
 
- Public Member Functions inherited from AZ::Component
 AZ_TYPE_INFO_WITH_NAME_DECL_API (AZCORE_API, Component)
 
 AZ_RTTI_NO_TYPE_INFO_DECL ()
 
AZ_CLASS_ALLOCATOR_DECL Component ()
 
virtual ~Component ()
 
Entity * GetEntity () const
 
EntityId GetEntityId () const
 
NamedEntityId GetNamedEntityId () const
 
ComponentId GetId () const
 
virtual TypeId GetUnderlyingComponentType () const
 
void SetId (const ComponentId &id)
 
virtual void SetSerializedIdentifier (AZStd::string serializedIdentifer)
 
virtual AZStd::string GetSerializedIdentifier () const
 
virtual ComponentValidationResult ValidateComponentRequirements (const ImmutableEntityVector &, const AZStd::unordered_set< AZ::Crc32 > &) const
 
bool SetConfiguration (const AZ::ComponentConfig &config)
 
bool GetConfiguration (AZ::ComponentConfig &outConfig) const
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 

Static Public Attributes

static constexpr size_t kInvalidIndex = std::numeric_limits<size_t>::max()
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::Component
virtual void Init ()
 
virtual bool ReadInConfig (const ComponentConfig *baseConfig)
 
virtual bool WriteOutConfig (ComponentConfig *outBaseConfig) const
 
virtual void SetEntity (Entity *entity)
 
virtual void OnAfterEntitySet ()
 Function to call after setting the entity in this component.
 
- Protected Attributes inherited from AZ::Component
Entity * m_entity
 Reference to the entity that owns the component. The value is null if the component is not attached to an entity.
 
ComponentId m_id
 A component ID that is unique for an entity. This component ID is not unique across all entities.
 

Detailed Description

The System Component that handles and defines Entity Activation Layers.

Member Function Documentation

◆ Activate()

void AZ::EntityActiveSystemComponent::Activate ( )
overridevirtual

AZ::Component overrides.

Implements AZ::Component.

◆ Deactivate()

void AZ::EntityActiveSystemComponent::Deactivate ( )
overridevirtual

Deactivates the component. The system calls this function when the owning entity is being deactivated. You must override this function. As a best practice, ensure that this function returns the component to a minimal footprint. The order of deactivation is the reverse of activation, so your component is deactivated before the components it depends on.

The system always calls the component's Deactivate() function before destroying the component. However, deactivation is not always followed by the destruction of the component. An entity and its components can be deactivated and reactivated without being destroyed. Ensure that your Deactivate() implementation can handle this scenario.

Implements AZ::Component.

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