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::GraphVariableManagerComponent Class Reference

Inherits AZ::Component, GraphConfigurationNotificationBus::Handler, GraphVariableManagerRequestBus::Handler, and VariableRequestBus::MultiHandler.

Inherited by ScriptCanvasEditor::EditorGraphVariableManagerComponent.

Public Member Functions

 AZ_COMPONENT (GraphVariableManagerComponent, "{825DC28D-667D-43D0-AF11-73681351DD2F}")
 
 GraphVariableManagerComponent (ScriptCanvasId scriptCanvasId)
 
void Init () override
 
void Activate () override
 
void Deactivate () override
 
void ConfigureScriptCanvasId (const ScriptCanvasId &scriptCanvasId) override
 
ScriptCanvasId GetScriptCanvasId () const
 
GraphVariableGetVariable () override
 
const GraphVariableGetVariableConst () const override
 
Data::Type GetType () const override
 
AZStd::string_view GetName () const override
 
AZ::Outcome< void, AZStd::string > RenameVariable (AZStd::string_view newVarName) override
 
AZ::Outcome< VariableId, AZStd::string > CloneVariable (const GraphVariable &variableConfiguration) override
 
AZ::Outcome< VariableId, AZStd::string > RemapVariable (const GraphVariable &variableConfiguration) override
 
AZ::Outcome< VariableId, AZStd::string > AddVariable (AZStd::string_view name, const Datum &value, bool functionScope) override
 
AZ::Outcome< VariableId, AZStd::string > AddVariablePair (const AZStd::pair< AZStd::string_view, Datum > &nameValuePair) override
 
VariableValidationOutcome IsNameValid (AZStd::string_view key) override
 
bool RemoveVariable (const VariableId &variableId) override
 
AZStd::size_t RemoveVariableByName (AZStd::string_view variableName) override
 
GraphVariableFindVariable (AZStd::string_view propName) override
 
GraphVariableFindVariableById (const VariableId &variableId) override
 
GraphVariableFindFirstVariableWithType (const Data::Type &dataType, const AZStd::unordered_set< ScriptCanvas::VariableId > &excludedVariableIds) override
 
Data::Type GetVariableType (const VariableId &variableId) override
 
const GraphVariableMapping * GetVariables () const override
 
AZStd::string_view GetVariableName (const VariableId &) const override
 
AZ::Outcome< void, AZStd::string > RenameVariable (const VariableId &, AZStd::string_view) override
 
bool IsRemappedId (const VariableId &remappedId) const override
 
GraphVariableMapping * GetVariables ()
 
const VariableDataGetVariableDataConst () const override
 
VariableDataGetVariableData () override
 
void SetVariableData (const VariableData &variableData) override
 
void DeleteVariableData (const VariableData &variableData) override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Protected Member Functions

void RegisterCopiedVariableRemapping (const VariableId &originalValue, const VariableId &remappedId)
 
void UnregisterUncopiedVariableRemapping (const VariableId &remappedId)
 
VariableId FindCopiedVariableRemapping (const VariableId &variableId) const
 

Static Protected Member Functions

static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 

Protected Attributes

VariableData m_variableData
 

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