Open 3D Engine AzCore 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.
AZ::ModuleDataImpl Struct Reference

#include <ModuleManager.h>

Inherits AZ::ModuleData.

Public Member Functions

 AZ_CLASS_ALLOCATOR (ModuleDataImpl, SystemAllocator)
 
 ModuleDataImpl (const ModuleDataImpl &)=delete
 
ModuleDataImploperator= (const ModuleDataImpl &)=delete
 
 ModuleDataImpl (ModuleDataImpl &&rhs)=delete
 
ModuleDataImploperator= (ModuleDataImpl &&)=delete
 
DynamicModuleHandleGetDynamicModuleHandle () const override
 Get the handle to the actual dynamic module.
 
ModuleGetModule () const override
 Get the handle to the module class.
 
EntityGetEntity () const override
 Get the entity this module uses as a System Entity.
 
const char * GetDebugName () const override
 Get the debug name of the module.
 
virtual DynamicModuleHandleGetDynamicModuleHandle () const =0
 Get the handle to the actual dynamic module.
 
virtual ModuleGetModule () const =0
 Get the handle to the module class.
 
virtual EntityGetEntity () const =0
 Get the entity this module uses as a System Entity.
 
virtual const char * GetDebugName () const =0
 Get the debug name of the module.
 

Public Attributes

AZStd::unique_ptr< DynamicModuleHandlem_dynamicHandle
 
Modulem_module = nullptr
 Handle to the module class within the module.
 
AZStd::unique_ptr< ModuleEntitym_moduleEntity
 Entity that holds this module's provided system components.
 
ModuleInitializationSteps m_lastCompletedStep = ModuleInitializationSteps::None
 The last step this module completed.
 

Detailed Description

Contains a static or dynamic AZ::Module.

Member Function Documentation

◆ GetDebugName()

const char * AZ::ModuleDataImpl::GetDebugName ( ) const
overridevirtual

Get the debug name of the module.

Implements AZ::ModuleData.

◆ GetDynamicModuleHandle()

DynamicModuleHandle * AZ::ModuleDataImpl::GetDynamicModuleHandle ( ) const
inlineoverridevirtual

Get the handle to the actual dynamic module.

Implements AZ::ModuleData.

◆ GetEntity()

Entity * AZ::ModuleDataImpl::GetEntity ( ) const
inlineoverridevirtual

Get the entity this module uses as a System Entity.

Implements AZ::ModuleData.

◆ GetModule()

Module * AZ::ModuleDataImpl::GetModule ( ) const
inlineoverridevirtual

Get the handle to the module class.

Implements AZ::ModuleData.

Member Data Documentation

◆ m_dynamicHandle

AZStd::unique_ptr<DynamicModuleHandle> AZ::ModuleDataImpl::m_dynamicHandle

Deals with loading and unloading the AZ::Module's DLL. This is null when the AZ::Module comes from a static LIB.


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