Menu
Lumberyard
C++ API Reference (Version 1.10)

AZ::EditContext::EnumInfo Class Reference

Builder class that reflects global enum data to the edit context. More...

Public Member Functions

EnumInfooperator-> ()
 Returns the current EnumInfo object so that you can continue building it. More...
 
template<class E >
EnumInfoValue (const char *name, E value)
 Reflects an enum value to the edit context. More...
 

Detailed Description

Builder class that reflects global enum data to the edit context.

You reflect global enum data to the edit context by using a builder pattern to call a function of this class for every enum value. An example is as follows:

editContext->Enum<MyEnum>("My enum", "Description")
->Value("SomeValue", MyEnum::SomeValue)
->Value("SomeOtherValue", MyEnum::SomeOtherValue);

Member Function Documentation

◆ operator->()

EnumInfo* AZ::EditContext::EnumInfo::operator-> ( )
inline

Returns the current EnumInfo object so that you can continue building it.

◆ Value()

template<class E >
EnumInfo* AZ::EditContext::EnumInfo::Value ( const char *  name,
value 
)

Reflects an enum value to the edit context.

Parameters
nameA name to represent the enum value in the editor. This name does not need to be the same as the enum value that it represents.
valueThe value of the enum data to reflect.
Returns
A pointer to the EnumInfo instance that was updated with this information.

The documentation for this class was generated from the following file:
  • C:/lumberyard-root/dev/Code/Framework/AZCore/AZCore/Serialization/EditContext.h