Open 3D Engine ScriptCanvasDeveloper 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.
Public Types | Public Member Functions | Protected Member Functions | List of all members
ScriptCanvas::Developer::CreateVariableAction Class Reference

#include <VariableActions.h>

Inherits ScriptCanvas::Developer::CompoundAction, and ScriptCanvas::GraphVariableManagerNotificationBus::Handler.

Public Types

enum class  CreationType { Palette , AutoComplete , Programmatic }
 

Public Member Functions

 AZ_CLASS_ALLOCATOR (CreateVariableAction, AZ::SystemAllocator)
 
 AZ_RTTI (CreateVariableAction, "{0C2A4B3C-FCE3-4611-BACB-4651B40CD715}", CompoundAction)
 
 CreateVariableAction (ScriptCanvas::Data::Type dataType, CreationType creationType=CreationType::AutoComplete)
 
 CreateVariableAction (ScriptCanvas::Data::Type dataType, QString variableName, CreationType creationType=CreationType::AutoComplete)
 
void SetErrorOnNameMisMatch (bool enabled)
 
void SetupAction () override
 
ScriptCanvas::VariableId GetVariableId () const
 
void OnVariableAddedToGraph (const ScriptCanvas::VariableId &variableId, AZStd::string_view variableName) override
 
ActionReport GenerateReport () const override
 
- Public Member Functions inherited from ScriptCanvas::Developer::CompoundAction
 AZ_CLASS_ALLOCATOR (CompoundAction, AZ::SystemAllocator)
 
 AZ_RTTI (CompoundAction, "{3F9A5736-111C-4D49-A3D5-BA3484D74F4D}", EditorAutomationAction)
 
void SetupAction () override
 
bool Tick () override
 
void AddAction (EditorAutomationAction *action)
 
ActionReport GenerateReport () const override
 
- Public Member Functions inherited from ScriptCanvas::Developer::EditorAutomationAction
 AZ_CLASS_ALLOCATOR (EditorAutomationAction, AZ::SystemAllocator)
 
bool IsAtPreconditionLimit () const
 
virtual bool IsMissingPrecondition ()
 
void ResetPreconditionAttempts ()
 
EditorAutomationAction * GenerationPreconditionActions ()
 
void SignalActionBegin ()
 
virtual bool Tick ()=0
 
virtual ActionReport GenerateReport () const
 

Protected Member Functions

void OnActionsComplete () override
 
- Protected Member Functions inherited from ScriptCanvas::Developer::CompoundAction
void ClearActionQueue ()
 
virtual void OnActionsComplete ()
 
- Protected Member Functions inherited from ScriptCanvas::Developer::EditorAutomationAction
virtual EditorAutomationAction * GenerateMissingPreconditionAction ()
 
virtual void SetupAction ()
 

Detailed Description

EditorAutomationAction that will create a variable in the active graph using the specified creation action

Member Function Documentation

◆ GenerateReport()

ActionReport ScriptCanvas::Developer::CreateVariableAction::GenerateReport ( ) const
overridevirtual

Reimplemented from ScriptCanvas::Developer::CompoundAction.

◆ OnActionsComplete()

void ScriptCanvas::Developer::CreateVariableAction::OnActionsComplete ( )
overrideprotectedvirtual

Reimplemented from ScriptCanvas::Developer::CompoundAction.

◆ SetupAction()

void ScriptCanvas::Developer::CreateVariableAction::SetupAction ( )
overridevirtual

Reimplemented from ScriptCanvas::Developer::CompoundAction.

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