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.
ScriptCanvas::Executor Class Referencefinal

#include <Executor.h>

Public Member Functions

 AZ_TYPE_INFO (Executor, "{0D1E4B9D-1A2C-4B9D-8364-052255BC691F}")
 
 AZ_CLASS_ALLOCATOR (Executor, AZ::SystemAllocator)
 
void Execute ()
 
const RuntimeDataOverridesGetRuntimeOverrides () const
 
void Initialize ()
 
void InitializeAndExecute ()
 
bool IsExecutable () const
 
bool IsPure () const
 
void SetRuntimeOverrides (const RuntimeDataOverrides &overrideData)
 Set the RuntimeDataOverrides which provide a runtime Asset to run and the possible property overrides.
 
void SetUserData (const ExecutionUserData &userData)
 Set the ExecutionUserData which will be used on Execution.
 
void StopAndClearExecutable ()
 
void StopAndKeepExecutable ()
 
void TakeRuntimeDataOverrides (RuntimeDataOverrides &&overrideData)
 Take the RuntimeDataOverrides which provide a runtime Asset to run and the possible property overrides.
 
void TakeUserData (ExecutionUserData &&userData)
 Take the ExecutionUserData which will be used on Execution.
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Detailed Description

Convenience class for for containing an ExecutionStateHandler, and the RuntimeDataOverrides and ExecutionUserData that the ExecutionStateHandler requires to run properly. Like the ExecutionState and ExecutionStateHandler it provides no little or no safety checks, and host systems must take care to properly initialize it.

See also
ExecutionStateHandler for documentation on Execution and Initialization methods.

For example usage:

See also
Interpreter
RuntimeComponents

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