Open 3D Engine EMotionFX Gem API Reference 25.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | List of all members
EMotionFX::StringParameter Class Reference

Inherits EMotionFX::DefaultValueParameter< AZStd::string, StringParameter >.

Public Member Functions

 AZ_RTTI_NO_TYPE_INFO_DECL ()
 
 StringParameter (const AZStd::string &name, const AZStd::string &description={})
 
 StringParameter (const AZStd::string &defaultValue, const AZStd::string &name, const AZStd::string &description={})
 
const char * GetTypeDisplayName () const override
 
MCore::Attribute * ConstructDefaultValueAsAttribute () const override
 
uint32 GetType () const override
 
bool AssignDefaultValueToAttribute (MCore::Attribute *attribute) const override
 
bool SetDefaultValueFromAttribute (MCore::Attribute *attribute) override
 
- Public Member Functions inherited from EMotionFX::DefaultValueParameter< AZStd::string, StringParameter >
 AZ_RTTI ((DefaultValueParameter, "{AE70C43D-6BAE-4EDF-A1CF-FC18B9F92ABB}", AZStd::string, StringParameter), ValueParameter)
 
 DefaultValueParameter (const AZStd::string &defaultValue, AZStd::string name={}, AZStd::string description={})
 
AZStd::string GetDefaultValue () const
 
void SetDefaultValue (const AZStd::string &newValue)
 
- Public Member Functions inherited from EMotionFX::ValueParameter
 ValueParameter (AZStd::string name, AZStd::string description={})
 
virtual bool SetMinValueFromAttribute (MCore::Attribute *attribute)
 
virtual bool SetMaxValueFromAttribute (MCore::Attribute *attribute)
 
- Public Member Functions inherited from EMotionFX::Parameter
 Parameter (AZStd::string name, AZStd::string description={})
 
const AZStd::string & GetName () const
 
void SetName (const AZStd::string &name)
 
const AZStd::string & GetDescription () const
 
void SetDescription (const AZStd::string &description)
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from EMotionFX::DefaultValueParameter< AZStd::string, StringParameter >
static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from EMotionFX::ValueParameter
static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from EMotionFX::Parameter
static void Reflect (AZ::ReflectContext *context)
 
static bool IsNameValid (const AZStd::string &name, AZStd::string *outInvalidCharacters)
 

Additional Inherited Members

- Protected Attributes inherited from EMotionFX::DefaultValueParameter< AZStd::string, StringParameter >
AZStd::string m_defaultValue
 
- Protected Attributes inherited from EMotionFX::Parameter
AZStd::string m_name
 
AZStd::string m_description
 
- Static Protected Attributes inherited from EMotionFX::Parameter
static const char s_invalidCharacters []
 

Member Function Documentation

◆ AssignDefaultValueToAttribute()

bool EMotionFX::StringParameter::AssignDefaultValueToAttribute ( MCore::Attribute *  attribute) const
overridevirtual

Implements EMotionFX::ValueParameter.

◆ ConstructDefaultValueAsAttribute()

MCore::Attribute * EMotionFX::StringParameter::ConstructDefaultValueAsAttribute ( ) const
overridevirtual

Implements EMotionFX::ValueParameter.

◆ GetType()

uint32 EMotionFX::StringParameter::GetType ( ) const
overridevirtual

Implements EMotionFX::ValueParameter.

◆ GetTypeDisplayName()

const char * EMotionFX::StringParameter::GetTypeDisplayName ( ) const
overridevirtual

Implements EMotionFX::Parameter.

◆ SetDefaultValueFromAttribute()

bool EMotionFX::StringParameter::SetDefaultValueFromAttribute ( MCore::Attribute *  attribute)
overridevirtual

Implements EMotionFX::ValueParameter.

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