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.
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
ScriptCanvas::Debugger::ServiceComponent Class Reference

#include <Debugger.h>

Inherits AZ::Component, ScriptCanvas::Debugger::Message::RequestVisitor, and ExecutionNotificationsBus::Handler.

Public Member Functions

 AZ_COMPONENT (ServiceComponent, "{794B1BA5-DE13-46C7-9149-74FFB02CB51B}")
 
 ServiceComponent (const ServiceComponent &)=delete
 
void Init () override
 
void Activate () override
 
void Deactivate () override
 
void OnReceivedMsg (AzFramework::RemoteToolsMessagePointer msg)
 
void TargetLeftNetwork (AzFramework::RemoteToolsEndpointInfo info)
 
void GraphActivated (const GraphActivation &) override
 
void GraphDeactivated (const GraphActivation &) override
 
bool IsGraphObserved (const ExecutionState &executionState) override
 
bool IsVariableObserved (const VariableId &variableId) override
 
void NodeSignaledOutput (const OutputSignal &) override
 
void NodeSignaledInput (const InputSignal &) override
 
void NodeStateUpdated (const NodeStateChange &) override
 
void RuntimeError (const ExecutionState &executionState, const AZStd::string_view &description) override
 
void VariableChanged (const VariableChange &) override
 
void AnnotateNode (const AnnotateNodeSignal &) override
 
bool IsAssetObserved (const AZ::Data::AssetId &assetId) const
 
void Visit (Message::AddBreakpointRequest &request) override
 
void Visit (Message::BreakRequest &request) override
 
void Visit (Message::ContinueRequest &request) override
 
void Visit (Message::AddTargetsRequest &request) override
 
void Visit (Message::RemoveTargetsRequest &request) override
 
void Visit (Message::StartLoggingRequest &request) override
 
void Visit (Message::StopLoggingRequest &request) override
 
void Visit (Message::GetAvailableScriptTargets &request) override
 
void Visit (Message::GetActiveEntitiesRequest &request) override
 
void Visit (Message::GetActiveGraphsRequest &request) override
 
void Visit (Message::RemoveBreakpointRequest &request) override
 
void Visit (Message::StepOverRequest &request) override
 
virtual void Visit (AddBreakpointRequest &request)=0
 
virtual void Visit (BreakRequest &request)=0
 
virtual void Visit (ContinueRequest &request)=0
 
virtual void Visit (AddTargetsRequest &request)=0
 
virtual void Visit (RemoveTargetsRequest &request)=0
 
virtual void Visit (StartLoggingRequest &request)=0
 
virtual void Visit (StopLoggingRequest &request)=0
 
virtual void Visit (GetAvailableScriptTargets &request)=0
 
virtual void Visit (GetActiveEntitiesRequest &request)=0
 
virtual void Visit (GetActiveGraphsRequest &request)=0
 
virtual void Visit (RemoveBreakpointRequest &request)=0
 
virtual void Visit (StepOverRequest &request)=0
 

Static Public Member Functions

static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
static void GetDependentServices (AZ::ComponentDescriptor::DependencyArrayType &dependent)
 
static void Reflect (AZ::ReflectContext *reflection)
 

Protected Member Functions

void SetTargetsObserved (const TargetEntities &targetEntities, bool observedState)
 
template<typename t_SignalType , typename t_MessageType >
void NodeSignalled (const t_SignalType &nodeSignal)
 
void Connect (Target &target)
 
Message::Request * FilterMessage (AzFramework::RemoteToolsMessagePointer &msg)
 
void Interact ()
 
bool IsAttached () const
 
void ProcessMessages ()
 

Detailed Description

The ScriptCanvas debugger component, this is the runtime debugger code that directly controls the execution and provides insight into a running ScriptCanvas graph.

Member Function Documentation

◆ Visit() [1/12]

void ScriptCanvas::Debugger::ServiceComponent::Visit ( Message::AddBreakpointRequest &  request)
overridevirtual

Implements ScriptCanvas::Debugger::Message::RequestVisitor.

◆ Visit() [2/12]

void ScriptCanvas::Debugger::ServiceComponent::Visit ( Message::AddTargetsRequest &  request)
overridevirtual

Implements ScriptCanvas::Debugger::Message::RequestVisitor.

◆ Visit() [3/12]

void ScriptCanvas::Debugger::ServiceComponent::Visit ( Message::BreakRequest &  request)
overridevirtual

Implements ScriptCanvas::Debugger::Message::RequestVisitor.

◆ Visit() [4/12]

void ScriptCanvas::Debugger::ServiceComponent::Visit ( Message::ContinueRequest &  request)
overridevirtual

Implements ScriptCanvas::Debugger::Message::RequestVisitor.

◆ Visit() [5/12]

void ScriptCanvas::Debugger::ServiceComponent::Visit ( Message::GetActiveEntitiesRequest &  request)
overridevirtual

Implements ScriptCanvas::Debugger::Message::RequestVisitor.

◆ Visit() [6/12]

void ScriptCanvas::Debugger::ServiceComponent::Visit ( Message::GetActiveGraphsRequest &  request)
overridevirtual

Implements ScriptCanvas::Debugger::Message::RequestVisitor.

◆ Visit() [7/12]

void ScriptCanvas::Debugger::ServiceComponent::Visit ( Message::GetAvailableScriptTargets &  request)
overridevirtual

Implements ScriptCanvas::Debugger::Message::RequestVisitor.

◆ Visit() [8/12]

void ScriptCanvas::Debugger::ServiceComponent::Visit ( Message::RemoveBreakpointRequest &  request)
overridevirtual

Implements ScriptCanvas::Debugger::Message::RequestVisitor.

◆ Visit() [9/12]

void ScriptCanvas::Debugger::ServiceComponent::Visit ( Message::RemoveTargetsRequest &  request)
overridevirtual

Implements ScriptCanvas::Debugger::Message::RequestVisitor.

◆ Visit() [10/12]

void ScriptCanvas::Debugger::ServiceComponent::Visit ( Message::StartLoggingRequest &  request)
overridevirtual

Implements ScriptCanvas::Debugger::Message::RequestVisitor.

◆ Visit() [11/12]

void ScriptCanvas::Debugger::ServiceComponent::Visit ( Message::StepOverRequest &  request)
overridevirtual

Implements ScriptCanvas::Debugger::Message::RequestVisitor.

◆ Visit() [12/12]

void ScriptCanvas::Debugger::ServiceComponent::Visit ( Message::StopLoggingRequest &  request)
overridevirtual

Implements ScriptCanvas::Debugger::Message::RequestVisitor.

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