Open 3D Engine ScriptCanvas Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Public Attributes | List of all members
ScriptCanvas::ExecutionState Class Referenceabstract

base abstract class that is the interface for the ScriptCanvas runtime and the hosting environment. It allows for customization of initialization, starting, and stopping execution. It only works on on valid runtime data, and holds user data. For example, in the Entity/Component system, the user data stores the information required to provide the Entity and Component that own the running graph. The actual runtime implementation is entirely up to subclasses. More...

Inherited by ScriptCanvas::ExecutionStateInterpreted.

Public Member Functions

 AZ_RTTI (ExecutionState, k_ExecutionStateAzTypeIdString)
 
 AZ_CLASS_ALLOCATOR (ExecutionState, AZ::SystemAllocator)
 
 ExecutionState (ExecutionStateConfig &config)
 
virtual void Execute ()=0
 
AZ::Data::AssetId GetAssetId () const
 
const Grammar::DebugExecution * GetDebugSymbolIn (size_t index) const
 
const Grammar::DebugExecution * GetDebugSymbolIn (size_t index, const AZ::Data::AssetId &id) const
 
const Grammar::DebugExecution * GetDebugSymbolOut (size_t index) const
 
const Grammar::DebugExecution * GetDebugSymbolOut (size_t index, const AZ::Data::AssetId &id) const
 
const Grammar::DebugExecution * GetDebugSymbolReturn (size_t index) const
 
const Grammar::DebugExecution * GetDebugSymbolReturn (size_t index, const AZ::Data::AssetId &id) const
 
const Grammar::DebugDataSource * GetDebugSymbolVariableChange (size_t index) const
 
const Grammar::DebugDataSource * GetDebugSymbolVariableChange (size_t index, const AZ::Data::AssetId &id) const
 
virtual ExecutionMode GetExecutionMode () const =0
 
const RuntimeDataOverrides & GetRuntimeDataOverrides () const
 
const RuntimeData & GetRuntimeData () const
 
const ExecutionUserData & GetUserData () const
 
virtual void Initialize ()=0
 
virtual bool IsPure () const
 
ExecutionUserData & ModUserData () const
 
ExecutionStatePtr SharedFromThis ()
 
ExecutionStateConstPtr SharedFromThisConst () const
 
virtual void StopExecution ()=0
 
AZStd::string ToString () const
 
ExecutionStateWeakPtr WeakFromThis ()
 
ExecutionStateWeakConstPtr WeakFromThisConst () const
 

Public Attributes

const AZ::u32 m_lightUserDataMark = UserDataMark
 

Detailed Description

base abstract class that is the interface for the ScriptCanvas runtime and the hosting environment. It allows for customization of initialization, starting, and stopping execution. It only works on on valid runtime data, and holds user data. For example, in the Entity/Component system, the user data stores the information required to provide the Entity and Component that own the running graph. The actual runtime implementation is entirely up to subclasses.

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