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 Member Functions | List of all members
ScriptCanvas::Developer::CoupleNodesState Class Reference

#include <ConnectionStates.h>

Inherits ScriptCanvas::Developer::NamedAutomationState.

Public Member Functions

 CoupleNodesState (AutomationStateModelId firstNode, GraphCanvas::ConnectionType connectionType, AutomationStateModelId secondNode, AutomationStateModelId outputId="")
 
void OnSetupStateActions (EditorAutomationActionRunner &actionRunner) override
 
void OnStateActionsComplete () override
 
- Public Member Functions inherited from ScriptCanvas::Developer::NamedAutomationState
 AZ_TYPE_INFO (NamedAutomationState, "{62DD037C-D80F-4B1B-9F3E-9F05400ABA24}")
 
 NamedAutomationState (const char *name)
 
 NamedAutomationState (const AZStd::string &stateName)
 
int GetStateId () const override
 
- Public Member Functions inherited from ScriptCanvas::Developer::EditorAutomationState
 AZ_TYPE_INFO (EditorAutomationState, "{B18A0531-E3C2-4209-8A9E-1B0195C28443}")
 
 AZ_CLASS_ALLOCATOR (EditorAutomationState, AZ::SystemAllocator)
 
virtual int GetStateId () const =0
 
virtual const char * GetStateName () const =0
 
void SetStateModel (StateModel *stateModel)
 
template<typename T >
void SetModelData (StateModel::DataKey dataKey, const T &modelData)
 
template<typename T >
const T * GetModelData (StateModel::DataKey dataKey)
 
StateModel * GetStateModel () const
 
void SetupStateActions (EditorAutomationActionRunner &actionRunner)
 
void StateActionsComplete ()
 
bool HasErrors () const
 
void ReportError (AZStd::string error)
 
const AZStd::string & GetError () const
 

Additional Inherited Members

- Static Public Attributes inherited from ScriptCanvas::Developer::EditorAutomationState
static constexpr int EXIT_STATE_ID = (-1)
 
- Protected Member Functions inherited from ScriptCanvas::Developer::NamedAutomationState
void SetStateName (const AZStd::string &stateName)
 
const char * GetStateName () const override
 
virtual void OnSetupStateActions (EditorAutomationActionRunner &actionRunner)=0
 
virtual void OnStateActionsComplete ()
 

Detailed Description

EditorAutomationState that will couple the two specified nodes together. The ordering of the coupling is decided by the specified connection type from the perspective of the 'nodeToPickUp'

Member Function Documentation

◆ OnSetupStateActions()

void ScriptCanvas::Developer::CoupleNodesState::OnSetupStateActions ( EditorAutomationActionRunner &  actionRunner)
overridevirtual

Implements ScriptCanvas::Developer::EditorAutomationState.

◆ OnStateActionsComplete()

void ScriptCanvas::Developer::CoupleNodesState::OnStateActionsComplete ( )
overridevirtual

Reimplemented from ScriptCanvas::Developer::EditorAutomationState.

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