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::ComponentDescriptorHelper< ComponentClass > Class Template Reference

#include <Component.h>

Inherits ComponentDescriptorBus::Handler.

Inherited by AZ::ComponentDescriptorDefault< ComponentClass >.

Public Member Functions

 ComponentDescriptorHelper ()
 
ComponentCreateComponent () override
 
const char * GetName () const override
 
Uuid GetUuid () const override
 

Detailed Description

template<class ComponentClass>
class AZ::ComponentDescriptorHelper< ComponentClass >

Helps you create a custom implementation of a descriptor. For most cases we recommend using AZ_COMPONENT and ComponentDescriptorDefault instead.

Constructor & Destructor Documentation

◆ ComponentDescriptorHelper()

template<class ComponentClass >
AZ::ComponentDescriptorHelper< ComponentClass >::ComponentDescriptorHelper ( )
inline

Connects to the component descriptor bus.

Member Function Documentation

◆ CreateComponent()

template<class ComponentClass >
Component * AZ::ComponentDescriptorHelper< ComponentClass >::CreateComponent ( )
inlineoverride

Creates an instance of the component.

Returns
Returns a pointer to the component.

◆ GetName()

template<class ComponentClass >
const char * AZ::ComponentDescriptorHelper< ComponentClass >::GetName ( ) const
inlineoverride

Gets the name of the component.

Returns
Returns a pointer to the name of the component.

◆ GetUuid()

template<class ComponentClass >
Uuid AZ::ComponentDescriptorHelper< ComponentClass >::GetUuid ( ) const
inlineoverride

Gets the ID of the component.

Returns
Returns a pointer to the component ID.

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