Menu
Lumberyard
C++ API Reference (Version 1.10)

AZ::ComponentDescriptorHelper< ComponentClass > Class Template Reference

Helps you create a custom implementation of a descriptor. More...

Inherits AZ::Internal::EBusEventHandler< EBus, IsNotUsingId >.

Inherited by AZ::ComponentDescriptorDefault< ComponentClass >.

Public Member Functions

 ComponentDescriptorHelper ()
 Connects to the component descriptor bus. More...
 
ComponentCreateComponent () override
 Creates an instance of the component. More...
 
const char * GetName () const override
 Gets the name of the component. More...
 
const Uuid & GetUuid () const override
 Gets the ID of the component. More...
 

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 >
const 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:
  • C:/lumberyard-root/dev/Code/Framework/AzCore/AzCore/Component/Component.h