Open 3D Engine ScriptCanvas Gem 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.
ScriptCanvas::GraphVariable Class Reference

Inherits DatumNotificationBus::Handler.

Classes

class  Comparator
 

Public Member Functions

 AZ_TYPE_INFO (GraphVariable, "{5BDC128B-8355-479C-8FA8-4BFFAB6915A8}")
 
 AZ_CLASS_ALLOCATOR (GraphVariable, AZ::SystemAllocator)
 
 GraphVariable (const Datum &variableData)
 
 GraphVariable (Datum &&variableData)
 
 GraphVariable (const Datum &variableData, const VariableId &variableId)
 
 GraphVariable (Deprecated::VariableNameValuePair &&valuePair)
 
bool operator== (const GraphVariable &rhs) const
 
bool operator!= (const GraphVariable &rhs) const
 
void DeepCopy (const GraphVariable &source)
 
const Data::TypeGetDataType () const
 
const VariableIdGetVariableId () const
 
const DatumGetDatum () const
 
DatumModDatum ()
 
bool IsComponentProperty () const
 
void ConfigureDatumView (ModifiableDatumView &accessController)
 
void SetVariableName (AZStd::string_view displayName)
 
AZStd::string_view GetVariableName () const
 
void SetScriptInputControlVisibility (const AZ::Crc32 &inputControlVisibility)
 
AZ::Crc32 GetInputControlVisibility () const
 
AZ::Crc32 GetScopeControlVisibility () const
 
AZ::Crc32 GetNetworkSettingsVisibility () const
 
AZ::Crc32 GetVisibility () const
 
void SetVisibility (AZ::Crc32 visibility)
 
void SetScope (VariableFlags::Scope scopeType)
 
VariableFlags::Scope GetScope () const
 
bool IsInScope (VariableFlags::Scope scopeType) const
 
void SetExposureCategory (AZStd::string_view exposureCategory)
 
AZStd::string_view GetExposureCategory () const
 
void GenerateNewId ()
 
void SetAllowSignalOnChange (bool allowSignalChange)
 
bool IsSynchronized () const
 
void SetOwningScriptCanvasId (const ScriptCanvasId &scriptCanvasId)
 
GraphScopedVariableId GetGraphScopedId () const
 
AZStd::string_view GetInitialValueSourceName () const
 
VariableFlags::InitialValueSource GetInitialValueSource () const
 
AZ::u32 SetInitialValueSource (VariableFlags::InitialValueSource InitialValueSource)
 
AZ::u32 SetInitialValueSourceFromName (AZStd::string_view name)
 
void OnDatumEdited (const Datum *datum) override
 
AZStd::vector< AZStd::pair< VariableFlags::Scope, AZStd::string > > GetScopes () const
 
int GetSortPriority () const
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static const char * GetVariableNotificationBusName ()
 

Static Public Attributes

static const char * s_InitialValueSourceNames [VariableFlags::InitialValueSource::COUNT]
 
static const char * s_ScopeNames [static_cast< int >(VariableFlags::Scope::COUNT)]
 

Friends

class ModifiableDatumView
 

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