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

#include <ClientTransceiver.h>

Inherits ScriptCanvas::Debugger::Message::NotificationVisitor, AZ::SystemTickBus::Handler, ClientRequestsBus::Handler, and ClientUIRequestBus::Handler.

Public Member Functions

 AZ_CLASS_ALLOCATOR (ClientTransceiver, AZ::SystemAllocator)
 
 AZ_RTTI (ClientTransceiver, "{C6F5ACDC-5415-48FE-A7C3-E6398FDDED33}")
 
AzFramework::RemoteToolsEndpointContainer EnumerateAvailableNetworkTargets () override
 
bool HasValidConnection () const override
 
bool IsConnected (const AzFramework::RemoteToolsEndpointInfo &) const override
 
bool IsConnectedToSelf () const override
 
AzFramework::RemoteToolsEndpointInfo GetNetworkTarget () override
 
void AddBreakpoint (const Breakpoint &) override
 
void AddVariableChangeBreakpoint (const VariableChangeBreakpoint &) override
 
void Break () override
 
void Continue () override
 
void RemoveBreakpoint (const Breakpoint &) override
 
void RemoveVariableChangeBreakpoint (const VariableChangeBreakpoint &) override
 
void SetVariableValue () override
 
void StepOver () override
 
void GetAvailableScriptTargets () override
 
void GetActiveEntities () override
 
void GetActiveGraphs () override
 
void GetVariableValue () override
 
void DesiredTargetConnected (bool connected)
 
void DesiredTargetChanged (AZ::u32 newId, AZ::u32 oldId)
 
void TargetJoinedNetwork (AzFramework::RemoteToolsEndpointInfo info)
 
void TargetLeftNetwork (AzFramework::RemoteToolsEndpointInfo info)
 
void OnReceivedMsg (AzFramework::RemoteToolsMessagePointer msg)
 
void Visit (Message::ActiveEntitiesResult &notification) override
 
void Visit (Message::ActiveGraphsResult &notification) override
 
void Visit (Message::AnnotateNode &notification) override
 
void Visit (Message::AvailableScriptTargetsResult &notification) override
 
void Visit (Message::BreakpointAdded &notification) override
 
void Visit (Message::BreakpointHit &notification) override
 
void Visit (Message::Connected &notification) override
 
void Visit (Message::Disconnected &notification) override
 
void Visit (Message::Continued &notification) override
 
void Visit (Message::GraphActivated &notification) override
 
void Visit (Message::GraphDeactivated &notification) override
 
void Visit (Message::SignaledInput &notification) override
 
void Visit (Message::SignaledOutput &notification) override
 
void Visit (Message::VariableChanged &notification) override
 
void OnSystemTick () override
 
void StartEditorSession () override
 
void StopEditorSession () override
 
void StartLogging (ScriptTarget &initialTargets) override
 
void StopLogging () override
 
void AddEntityLoggingTarget (const AZ::EntityId &entityId, const ScriptCanvas::GraphIdentifier &assetId) override
 
void RemoveEntityLoggingTarget (const AZ::EntityId &entityId, const ScriptCanvas::GraphIdentifier &assetId) override
 
void AddGraphLoggingTarget (const AZ::Data::AssetId &assetId) override
 
void RemoveGraphLoggingTarget (const AZ::Data::AssetId &assetId) override
 
virtual void Visit (ActiveEntitiesResult &notification)=0
 
virtual void Visit (ActiveGraphsResult &notification)=0
 
virtual void Visit (AnnotateNode &notification)=0
 
virtual void Visit (AvailableScriptTargetsResult &notification)=0
 
virtual void Visit (BreakpointHit &notification)=0
 
virtual void Visit (BreakpointAdded &notification)=0
 
virtual void Visit (Connected &notification)=0
 
virtual void Visit (Disconnected &notification)=0
 
virtual void Visit (Continued &notification)=0
 
virtual void Visit (GraphActivated &notification)=0
 
virtual void Visit (GraphDeactivated &notification)=0
 
virtual void Visit (SignaledInput &notification)=0
 
virtual void Visit (SignaledOutput &notification)=0
 
virtual void Visit (VariableChanged &notification)=0
 

Protected Member Functions

void DiscoverNetworkTargets ()
 
void BreakpointAdded (const Breakpoint &breakpoint)
 
void ClearMessages ()
 
void ProcessMessages ()
 

Detailed Description

ClientTransceiver listens to debugger service messages on the target manager bus, and translates them to ServiceNotifications

listens to client requests, and translates them to debugger client request messages

listens to target manager client messages and translated them to service notifications

Member Function Documentation

◆ Visit() [1/14]

void ScriptCanvas::Debugger::ClientTransceiver::Visit ( Message::ActiveEntitiesResult &  notification)
overridevirtual

Implements ScriptCanvas::Debugger::Message::NotificationVisitor.

◆ Visit() [2/14]

void ScriptCanvas::Debugger::ClientTransceiver::Visit ( Message::ActiveGraphsResult &  notification)
overridevirtual

Implements ScriptCanvas::Debugger::Message::NotificationVisitor.

◆ Visit() [3/14]

void ScriptCanvas::Debugger::ClientTransceiver::Visit ( Message::AnnotateNode &  notification)
overridevirtual

Implements ScriptCanvas::Debugger::Message::NotificationVisitor.

◆ Visit() [4/14]

void ScriptCanvas::Debugger::ClientTransceiver::Visit ( Message::AvailableScriptTargetsResult &  notification)
overridevirtual

Implements ScriptCanvas::Debugger::Message::NotificationVisitor.

◆ Visit() [5/14]

void ScriptCanvas::Debugger::ClientTransceiver::Visit ( Message::BreakpointAdded &  notification)
overridevirtual

Implements ScriptCanvas::Debugger::Message::NotificationVisitor.

◆ Visit() [6/14]

void ScriptCanvas::Debugger::ClientTransceiver::Visit ( Message::BreakpointHit &  notification)
overridevirtual

Implements ScriptCanvas::Debugger::Message::NotificationVisitor.

◆ Visit() [7/14]

void ScriptCanvas::Debugger::ClientTransceiver::Visit ( Message::Connected &  notification)
overridevirtual

Implements ScriptCanvas::Debugger::Message::NotificationVisitor.

◆ Visit() [8/14]

void ScriptCanvas::Debugger::ClientTransceiver::Visit ( Message::Continued &  notification)
overridevirtual

Implements ScriptCanvas::Debugger::Message::NotificationVisitor.

◆ Visit() [9/14]

void ScriptCanvas::Debugger::ClientTransceiver::Visit ( Message::Disconnected &  notification)
overridevirtual

Implements ScriptCanvas::Debugger::Message::NotificationVisitor.

◆ Visit() [10/14]

void ScriptCanvas::Debugger::ClientTransceiver::Visit ( Message::GraphActivated &  notification)
overridevirtual

Implements ScriptCanvas::Debugger::Message::NotificationVisitor.

◆ Visit() [11/14]

void ScriptCanvas::Debugger::ClientTransceiver::Visit ( Message::GraphDeactivated &  notification)
overridevirtual

Implements ScriptCanvas::Debugger::Message::NotificationVisitor.

◆ Visit() [12/14]

void ScriptCanvas::Debugger::ClientTransceiver::Visit ( Message::SignaledInput &  notification)
overridevirtual

Implements ScriptCanvas::Debugger::Message::NotificationVisitor.

◆ Visit() [13/14]

void ScriptCanvas::Debugger::ClientTransceiver::Visit ( Message::SignaledOutput &  notification)
overridevirtual

Implements ScriptCanvas::Debugger::Message::NotificationVisitor.

◆ Visit() [14/14]

void ScriptCanvas::Debugger::ClientTransceiver::Visit ( Message::VariableChanged &  notification)
overridevirtual

Implements ScriptCanvas::Debugger::Message::NotificationVisitor.

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