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.
ScriptCanvas::Grammar::ExecutionTree Struct Reference

Inherits AZStd::enable_shared_from_this< ExecutionTree >.

Public Types

enum class  RemapVariableSource { No , Yes }
 

Public Member Functions

 AZ_TYPE_INFO (ExecutionTree, "{B062AFDC-7BC7-415B-BFC4-EFEE8D1CE87A}")
 
 AZ_CLASS_ALLOCATOR (ExecutionTree, AZ::SystemAllocator)
 
void AddChild (const ExecutionChild &child)
 
void AddInput (const ExecutionInput &input)
 
void AddReturnValue (const Slot *slot, ReturnValueConstPtr returnValue)
 
void AddPropertyExtractionSource (const Slot *slot, PropertyExtractionConstPtr propertyExtraction)
 
void Clear ()
 
void ClearChildren ()
 
void ClearInput ()
 
void ClearProperyExtractionSources ()
 
void ConvertNameToIdentifier ()
 
void CopyInput (ExecutionTreeConstPtr source, RemapVariableSource remapSource)
 
void CopyReturnValuesToInputs (ExecutionTreeConstPtr source)
 
ExecutionChildFindChild (const SlotId slotId)
 
const ExecutionChildFindChildConst (ExecutionTreeConstPtr execution) const
 
const ExecutionChildFindChildConst (const SlotId slotId) const
 
size_t FindChildIndex (ExecutionTreeConstPtr execution) const
 
const ExecutionChildGetChild (size_t index) const
 
size_t GetChildrenCount () const
 
const ConversionByIndex & GetConversions () const
 
PropertyExtractionConstPtr GetExecutedPropertyExtraction () const
 
EventType GetEventType () const
 
const ExecutionIdGetId () const
 
AZ::EntityId GetNodeId () const
 
const ExecutionInputGetInput (size_t index) const
 
size_t GetInputCount () const
 
const AZStd::vector< AZStd::pair< const Slot *, OutputAssignmentConstPtr > > * GetLocalOutput () const
 
MetaDataConstPtr GetMetaData () const
 
const AZStd::any & GetMetaDataEx () const
 
const AZStd::string & GetName () const
 
const LexicalScopeGetNameLexicalScope () const
 
VariableConstPtr GetNodeable () const
 
AZStd::optional< size_t > GetOutCallIndex () const
 
ExecutionTreeConstPtr GetParent () const
 
ExecutionTreeConstPtr GetRoot () const
 
const AZStd::vector< AZStd::pair< const Slot *, PropertyExtractionConstPtr > > & GetPropertyExtractionSources () const
 
AZStd::pair< const Slot *, ReturnValueConstPtr > GetReturnValue (size_t index) const
 
size_t GetReturnValueCount () const
 
ScopeConstPtr GetScope () const
 
Symbol GetSymbol () const
 
bool HasExplicitUserOutCalls () const
 
bool HasReturnValues () const
 
bool InputHasThisPointer () const
 
bool IsInfiniteLoopDetectionPoint () const
 
void InsertChild (size_t index, const ExecutionChild &child)
 
bool IsInputOutputPreprocessed () const
 
bool IsOnLatentPath () const
 
bool IsPure () const
 
bool IsStartCall () const
 
void MarkDebugEmptyStatement ()
 
void MarkHasExplicitUserOutCalls ()
 
void MarkInfiniteLoopDetectionPoint ()
 
void MarkInputHasThisPointer ()
 
void MarkInputOutputPreprocessed ()
 
void MarkPure ()
 
void MarkRefersToSelfEntityId ()
 
void MarkRootLatent ()
 
void MarkStartCall ()
 
ExecutionChildModChild (size_t index)
 
ConversionByIndex & ModConversions ()
 
ExecutionInputModInput (size_t index)
 
MetaDataPtr ModMetaData ()
 
AZStd::any & ModMetaDataEx ()
 
ExecutionTreePtr ModParent ()
 
ExecutionTreePtr ModRoot ()
 
ScopePtr ModScope ()
 
ScopePtr ModScopeFunction ()
 
void ReduceInputSet (const AZ::InputRestriction &indices)
 
bool RefersToSelfEntityId () const
 
AZ::Outcome< AZStd::pair< size_t, ExecutionChild > > RemoveChild (const ExecutionTreeConstPtr &child)
 
void SetExecutedPropertyExtraction (PropertyExtractionConstPtr propertyExtraction)
 
void SetEventType (EventType eventType)
 
void SetId (const ExecutionId &id)
 
void SetMetaData (MetaDataPtr metaData)
 
void SetName (AZStd::string_view name)
 
void SetNameLexicalScope (const LexicalScope &lexicalScope)
 
void SetNodeable (VariableConstPtr nodeable)
 
void SetOutCallIndex (size_t index)
 
void SetParent (ExecutionTreePtr parent)
 
void SetScope (ScopePtr scope)
 
void SetSymbol (Symbol val)
 
void SwapChildren (ExecutionTreePtr execution)
 

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