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 | List of all members
ScriptCanvasEditor::Interpreter Class Referencefinal

#include <Interpreter.h>

Inherits ScriptCanvasBuilder::DataSystemAssetNotificationsBus::Handler.

Public Member Functions

 AZ_TYPE_INFO (Interpreter, "{B77E5BC8-766A-4657-A30F-67797D04D10E}")
 
 AZ_CLASS_ALLOCATOR (Interpreter, AZ::SystemAllocator)
 
AZ::EventHandler< const Interpreter & > ConnectOnStatusChanged (AZStd::function< void(const Interpreter &)> &&function) const
 
bool Execute ()
 
const Configuration & GetConfiguration () const
 
InterpreterStatus GetStatus () const
 
AZStd::string_view GetStatusString () const
 
bool IsExecutable () const
 
Configuration & ModConfiguration ()
 
void RefreshConfiguration ()
 Allows a manual refresh of the configuration to update Editor properties.
 
void ResetUserData ()
 Sets the default user data in the Executable to a pointer to this Interpreter object.
 
void SetScript (SourceHandle source)
 
void Stop ()
 Stops the execution of the script if it is executable and stoppable. If the script does not require being stopped, does nothing.
 
void TakeUserData (ScriptCanvas::ExecutionUserData &&runtimeUserData)
 Sets the user data in the Executable to the input runtimeUserData.
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Detailed Description

This class defines provides source and property configuration for ScriptCanvas graphs, and executes them as safely as possible. This can be used while the graph is being actively edited, whether in the O3DE provided editor or in another editor. When the graph properties are updated, the interpreter will always present and (attempt to) run the latest version.

Member Function Documentation

◆ Execute()

bool ScriptCanvasEditor::Interpreter::Execute ( )

<summary Executes the selected Script if possible, and returns true if it did so.

Returns
true iff the script was Executable

◆ ResetUserData()

void ScriptCanvasEditor::Interpreter::ResetUserData ( )

Sets the default user data in the Executable to a pointer to this Interpreter object.

Note
It will not be used until the next execution.

◆ TakeUserData()

void ScriptCanvasEditor::Interpreter::TakeUserData ( ScriptCanvas::ExecutionUserData &&  runtimeUserData)

Sets the user data in the Executable to the input runtimeUserData.

Note
It will not be used until the next execution.
The documentation for this class was generated from the following file: