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.
AZ::ScriptPropertyGenericClass Class Reference

Inherits AZ::FunctionalScriptProperty, and BehaviorObjectSignals::Handler.

Public Member Functions

 AZ_CLASS_ALLOCATOR (ScriptPropertyGenericClass, AZ::SystemAllocator)
 
 AZ_TYPE_INFO_WITH_NAME_DECL (ScriptPropertyGenericClass)
 
 AZ_RTTI_NO_TYPE_INFO_DECL ()
 
 ScriptPropertyGenericClass (const char *name, const AZ::DynamicSerializableField &value)
 
const void * GetDataAddress () const override
 
AZ::TypeId GetDataTypeUuid () const override
 
bool DoesTypeMatch (AZ::ScriptDataContext &context, int valueIndex) const override
 
ScriptPropertyGenericClassClone (const char *name=nullptr) const override
 
bool Write (AZ::ScriptContext &context) override
 
bool TryRead (AZ::ScriptDataContext &context, int valueIndex) override
 
const AZ::DynamicSerializableFieldGetSerializableField () const
 
template<class T >
const T * Get () const
 
template<class T >
T * Get ()
 
template<class T >
void Set (T *value)
 
void Set (const AZ::DynamicSerializableField &sourceField)
 
void EnableInPlaceControls () override
 
void DisableInPlaceControls () override
 
void OnMemberMethodCalled (const BehaviorMethod *behaviorMethod) override
 
- Public Member Functions inherited from AZ::FunctionalScriptProperty
 AZ_TYPE_INFO_WITH_NAME_DECL (FunctionalScriptProperty)
 
 AZ_RTTI_NO_TYPE_INFO_DECL ()
 
 FunctionalScriptProperty (const char *name)
 
virtual void EnableInPlaceControls ()=0
 
virtual void DisableInPlaceControls ()=0
 
void AddWatcher (AZ::ScriptPropertyWatcher *scriptPropertyWatcher)
 
void RemoveWatcher (AZ::ScriptPropertyWatcher *scriptPropertyWatcher)
 
- Public Member Functions inherited from AZ::ScriptProperty
 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 ScriptPropertyClone (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 Reflect (AZ::ReflectContext *reflection)
 
static ScriptPropertyTryCreateProperty (AZ::ScriptDataContext &context, int valueIndex, const char *name)
 
- Static Public Member Functions inherited from AZ::ScriptProperty
static void UpdateScriptProperty (AZ::ScriptDataContext &sdc, int valueIndex, ScriptProperty **targetProperty)
 
static void Reflect (AZ::ReflectContext *reflection)
 

Protected Member Functions

void OnWatcherAdded (ScriptPropertyWatcher *scriptPropertyWatcher) override
 
void OnWatcherRemoved (ScriptPropertyWatcher *scriptPropertyWatcher) override
 
void CloneDataFrom (const AZ::ScriptProperty *scriptProperty) override
 
- Protected Member Functions inherited from AZ::FunctionalScriptProperty
virtual void OnWatcherAdded (AZ::ScriptPropertyWatcher *scriptPropertyWatcher)
 
virtual void OnWatcherRemoved (AZ::ScriptPropertyWatcher *scriptPropertyWatcher)
 
void SignalPropertyChanged ()
 
virtual void CloneDataFrom (const AZ::ScriptProperty *scriptProperty)=0
 

Friends

class AzFramework::ScriptPropertyMarshaler
 
class AzToolsFramework::Components::ScriptEditorComponent
 

Additional Inherited Members

- Public Attributes inherited from AZ::ScriptProperty
AZ::u64 m_id
 
AZStd::string m_name
 
- Protected Attributes inherited from AZ::FunctionalScriptProperty
AZStd::set< AZ::ScriptPropertyWatcher * > m_watchers
 

Member Function Documentation

◆ Clone()

ScriptPropertyGenericClass * AZ::ScriptPropertyGenericClass::Clone ( const char *  name = nullptr) const
overridevirtual

Implements AZ::ScriptProperty.

◆ CloneDataFrom()

void AZ::ScriptPropertyGenericClass::CloneDataFrom ( const AZ::ScriptProperty scriptProperty)
overrideprotectedvirtual

Implements AZ::ScriptProperty.

◆ DisableInPlaceControls()

void AZ::ScriptPropertyGenericClass::DisableInPlaceControls ( )
overridevirtual

◆ DoesTypeMatch()

bool AZ::ScriptPropertyGenericClass::DoesTypeMatch ( AZ::ScriptDataContext ,
int   
) const
overridevirtual

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

Reimplemented from AZ::ScriptProperty.

◆ EnableInPlaceControls()

void AZ::ScriptPropertyGenericClass::EnableInPlaceControls ( )
overridevirtual

◆ GetDataAddress()

const void * AZ::ScriptPropertyGenericClass::GetDataAddress ( ) const
inlineoverridevirtual

Implements AZ::ScriptProperty.

◆ GetDataTypeUuid()

AZ::TypeId AZ::ScriptPropertyGenericClass::GetDataTypeUuid ( ) const
inlineoverridevirtual

Implements AZ::ScriptProperty.

◆ OnWatcherAdded()

void AZ::ScriptPropertyGenericClass::OnWatcherAdded ( ScriptPropertyWatcher scriptPropertyWatcher)
overrideprotectedvirtual

Reimplemented from AZ::FunctionalScriptProperty.

◆ OnWatcherRemoved()

void AZ::ScriptPropertyGenericClass::OnWatcherRemoved ( ScriptPropertyWatcher scriptPropertyWatcher)
overrideprotectedvirtual

Reimplemented from AZ::FunctionalScriptProperty.

◆ TryRead()

bool AZ::ScriptPropertyGenericClass::TryRead ( AZ::ScriptDataContext context,
int  valueIndex 
)
overridevirtual

Reimplemented from AZ::ScriptProperty.

◆ Write()

bool AZ::ScriptPropertyGenericClass::Write ( AZ::ScriptContext context)
overridevirtual

Implements AZ::ScriptProperty.


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