Menu
Lumberyard
C++ API Reference (Version 1.10)

Open 3D Engine (O3DE), the successor to Lumberyard, is now available in Developer Preview. Download O3DE or visit the AWS Game Tech blog to learn more.

Base class for all attributes that are used by reflection contexts. More...

Inherited by AZ::AttributeData< T > , and AZ::AttributeFunction< R(Args...)> .

Public Member Functions

Attribute ()
Initializes an instance of an attribute. More...
virtual ~Attribute ()
An empty destructor. More...
void SetContextData (void *contextData)
Associates additional data with the attribute. More...
void * GetContextData () const
Gets additional data that is associated with the attribute, if any. More...

Public Attributes

bool m_describesChildren
Indicates that this attribute is a container for child attributes. More...

Detailed Description

Base class for all attributes that are used by reflection contexts.

Use azrtti_cast to get the appropriate implementation of the class. If it's null, the attributes have a data mismatch.

Constructor & Destructor Documentation

Attribute()

AZ::Attribute::Attribute ( )
inline

Initializes an instance of an attribute.

By default, the attribute is not associated with any additional data and is not a container for child attributes.

~Attribute()

virtual AZ::Attribute::~Attribute ( )
inline virtual

An empty destructor.

Member Function Documentation

GetContextData()

void* AZ::Attribute::GetContextData ( ) const
inline

Gets additional data that is associated with the attribute, if any.

Returns
A pointer to data that is associated with the attribute. Null if the attribute does not have any additional data.

SetContextData()

void AZ::Attribute::SetContextData ( void * contextData )
inline

Associates additional data with the attribute.

Parameters
contextData A pointer to data to associate with the attribute.

Member Data Documentation

m_describesChildren

bool AZ::Attribute::m_describesChildren

Indicates that this attribute is a container for child attributes.


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