Open 3D Engine ScriptCanvasDeveloper Gem API Reference 24.09.2
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
ScriptCanvas::Developer::CoupleNodesAction Class Reference

#include <ConnectionActions.h>

Inherits ScriptCanvas::Developer::CompoundAction, and GraphCanvas::SceneNotificationBus::Handler.

Public Member Functions

 AZ_CLASS_ALLOCATOR (CoupleNodesAction, AZ::SystemAllocator)
 
 AZ_RTTI (CoupleNodesAction, "{DC6B3198-E127-4833-BC44-B27083A36045}", CompoundAction)
 
 CoupleNodesAction (GraphCanvas::NodeId nodeToPickUp, GraphCanvas::ConnectionType connectionType, GraphCanvas::NodeId coupleTarget)
 
bool IsMissingPrecondition () override
 
EditorAutomationActionGenerateMissingPreconditionAction () override
 
AZStd::vector< GraphCanvas::ConnectionId > GetConnectionIds () const
 
void OnConnectionAdded (const AZ::EntityId &connectionId) override
 
- Public Member Functions inherited from ScriptCanvas::Developer::CompoundAction
 AZ_CLASS_ALLOCATOR (CompoundAction, AZ::SystemAllocator)
 
 AZ_RTTI (CompoundAction, "{3F9A5736-111C-4D49-A3D5-BA3484D74F4D}", EditorAutomationAction)
 
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
 
void ResetPreconditionAttempts ()
 
EditorAutomationActionGenerationPreconditionActions ()
 
void SignalActionBegin ()
 

Protected Member Functions

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

Detailed Description

EditorAutomationAction 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

◆ GenerateMissingPreconditionAction()

EditorAutomationAction * ScriptCanvas::Developer::CoupleNodesAction::GenerateMissingPreconditionAction ( )
overridevirtual

◆ IsMissingPrecondition()

bool ScriptCanvas::Developer::CoupleNodesAction::IsMissingPrecondition ( )
overridevirtual

◆ OnActionsComplete()

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

◆ SetupAction()

void ScriptCanvas::Developer::CoupleNodesAction::SetupAction ( )
overrideprotectedvirtual

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