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.
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
AZ::ScriptProperty Class Referenceabstract

#include <ScriptProperty.h>

Inherited by AZ::FunctionalScriptProperty, AZ::ScriptPropertyAsset, AZ::ScriptPropertyBoolean, AZ::ScriptPropertyBooleanArray, AZ::ScriptPropertyGenericClassArray, AZ::ScriptPropertyNil, AZ::ScriptPropertyNumber, AZ::ScriptPropertyNumberArray, AZ::ScriptPropertyString, and AZ::ScriptPropertyStringArray.

Public Member Functions

 AZ_TYPE_INFO_WITH_NAME_DECL (ScriptProperty)
 
 AZ_RTTI_NO_TYPE_INFO_DECL ()
 
 ScriptProperty (const char *name)
 
virtual const void * GetDataAddress () const =0
 
virtual AZ::TypeId GetDataTypeUuid () const =0
 
virtual bool DoesTypeMatch (AZ::ScriptDataContext &, int) const
 
virtual ScriptProperty * Clone (const char *name=nullptr) const =0
 
virtual bool Write (AZ::ScriptContext &context)=0
 
virtual bool TryRead (AZ::ScriptDataContext &context, int valueIndex)
 
bool TryUpdate (const AZ::ScriptProperty *scriptProperty)
 

Static Public Member Functions

static void UpdateScriptProperty (AZ::ScriptDataContext &sdc, int valueIndex, ScriptProperty **targetProperty)
 
static void Reflect (AZ::ReflectContext *reflection)
 

Public Attributes

AZ::u64 m_id
 
AZStd::string m_name
 

Protected Member Functions

virtual void CloneDataFrom (const AZ::ScriptProperty *scriptProperty)=0
 

Detailed Description

Base class for all script properties.

Member Function Documentation

◆ DoesTypeMatch()

virtual bool AZ::ScriptProperty::DoesTypeMatch ( AZ::ScriptDataContext &  ,
int   
) const
inlinevirtual

Test if the value at the index valueIndex is of the same type as that of the instance of ScriptProperty's subclass.

Reimplemented in AZ::ScriptPropertyBoolean, AZ::ScriptPropertyNumber, AZ::ScriptPropertyString, AZ::ScriptPropertyGenericClass, AZ::ScriptPropertyNumberArray, AZ::ScriptPropertyBooleanArray, AZ::ScriptPropertyStringArray, AZ::ScriptPropertyGenericClassArray, and AZ::ScriptPropertyAsset.

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