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.
Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
ScriptCanvas::Translation::GraphToLua Class Reference

Inherits ScriptCanvas::Translation::GraphToX.

Static Public Member Functions

static AZ::Outcome< TargetResult, ErrorList > Translate (const Grammar::AbstractCodeModel &source)
 

Protected Types

enum class  IsNamed { No , Yes }
 
enum class  NilCheck { None , Single , Multiple }
 
enum class  OutSourceType { Nodeable , InterpretedClass }
 
enum class  IsLeadingCommaRequired { No , Yes }
 
enum class  PostDisconnectAction { None , SetToNil }
 
enum class  IsFormatStringInput { No , Yes }
 

Protected Member Functions

 GraphToLua (const Grammar::AbstractCodeModel &source)
 
const AZStd::string & FindAbbreviation (AZStd::string_view dependency) const
 
const AZStd::string & FindLibrary (AZStd::string_view dependency) const
 
AZStd::string_view GetOperatorString (Grammar::ExecutionTreeConstPtr execution)
 
bool IsConstructCallRequired () const
 
bool IsDebugInfoWritten () const
 
AZStd::pair< NilCheck, AZStd::string > IsReturnValueNilCheckRequired (ScriptCanvas::Grammar::ExecutionTreeConstPtr execution)
 
TargetResult MoveResult ()
 
void OpenFunctionBlock (Writer &writer)
 
void TranslateBody ()
 
void TranslateBody (BuildConfiguration configuration)
 
void TranslateClassClose ()
 
void TranslateClassOpen ()
 
void TranslateConstructMethod ()
 
void TranslateConstruction ()
 
void TranslateDependencies ()
 
void TranslateDestruction ()
 
void TranslateEBusEvents (Grammar::EBusHandlingConstPtr ebusHandling, AZStd::string_view leftValue)
 
void TranslateEBusHandlerCreation (Grammar::EBusHandlingConstPtr ebusHandling, AZStd::string_view leftValue)
 
void TranslateEBusHandling (AZStd::string_view leftValue)
 
void TranslateExecutionTreeChildPost (Grammar::ExecutionTreeConstPtr execution, const Grammar::ExecutionChild &child, size_t index, size_t rootIndex)
 
void TranslateExecutionTreeChildPre (Grammar::ExecutionTreeConstPtr execution, const Grammar::ExecutionChild &child, size_t index, size_t rootIndex)
 
void TranslateExecutionTreeEntry (Grammar::ExecutionTreeConstPtr execution, size_t index)
 
void TranslateExecutionTreeEntryPost (Grammar::ExecutionTreeConstPtr execution, size_t index)
 
void TranslateExecutionTreeEntryPre (Grammar::ExecutionTreeConstPtr execution, size_t index)
 
void TranslateExecutionTreeEntryRecurse (Grammar::ExecutionTreeConstPtr execution, size_t index)
 
void TranslateExecutionTreeFunctionCall (Grammar::ExecutionTreeConstPtr execution)
 
void TranslateExecutionTreeUserOutCall (Grammar::ExecutionTreeConstPtr execution)
 
void TranslateExecutionTrees ()
 
void TranslateFunction (Grammar::ExecutionTreeConstPtr execution, IsNamed lex)
 
void TranslateFunctionBlock (Grammar::ExecutionTreeConstPtr execution, IsNamed lex)
 
void TranslateFunctionBlock (Grammar::ExecutionTreeConstPtr execution, FunctionBlockConfig functionBlockConfig, IsNamed lex)
 
void TranslateFunctionDefinition (Grammar::ExecutionTreeConstPtr execution, IsNamed lex)
 
void TranslateInheritance ()
 
void TranslateExecutionOut (Grammar::VariableConstPtr host, Grammar::ExecutionTreeConstPtr execution, OutSourceType sourceType)
 
void TranslateExecutionOuts (Grammar::VariableConstPtr host, Grammar::ExecutionTreeConstPtr execution)
 
void TranslateNodeableParse ()
 
void TranslateStaticInitialization ()
 
void TranslateVariableInitialization (AZStd::string_view leftValue)
 
void WriteClassPropertyRead (Grammar::ExecutionTreeConstPtr)
 
void WriteClassPropertyWrite (Grammar::ExecutionTreeConstPtr)
 
void WriteConditionalCaseSwitch (Grammar::ExecutionTreeConstPtr execution, Grammar::Symbol symbol, const Grammar::ExecutionChild &child, size_t index)
 
void WriteConstructionArgs ()
 
void WriteConstructionDependencyArgs ()
 
void WriteConstructionInput ()
 
void WriteConstructMethod ()
 
void WriteCycleBegin (Grammar::ExecutionTreeConstPtr execution)
 
void WriteDebugInfoIn (Grammar::ExecutionTreeConstPtr execution, AZStd::string_view)
 
void WriteDebugInfoIn (Grammar::ExecutionTreeConstPtr execution, AZStd::string_view, size_t inputCountOverride)
 
void WriteDebugInfoOut (Grammar::ExecutionTreeConstPtr execution, size_t index, AZStd::string_view)
 
void WriteDebugInfoReturn (Grammar::ExecutionTreeConstPtr execution, AZStd::string_view)
 
void WriteDebugInfoVariableChange (Grammar::ExecutionTreeConstPtr execution, Grammar::OutputAssignmentConstPtr output)
 
void WriteEventConnectCall (Grammar::ExecutionTreeConstPtr execution)
 
void WriteEventConnectCaller (Grammar::ExecutionTreeConstPtr execution, Grammar::EventHandlingConstPtr)
 
void WriteEventDisconnectCall (Grammar::ExecutionTreeConstPtr execution, PostDisconnectAction postAction)
 
void WriteForEachChildPost (Grammar::ExecutionTreeConstPtr execution, size_t index)
 
void WriteForEachChildPre (Grammar::ExecutionTreeConstPtr execution)
 
void WriteFloatingPointErrorNumberEqualityComparision (Grammar::ExecutionTreeConstPtr execution)
 
void WriteFunctionCallInput (Grammar::ExecutionTreeConstPtr execution)
 
void WriteFunctionCallInput (Grammar::ExecutionTreeConstPtr execution, size_t inputCountOverride)
 
void WriteFunctionCallInput (Grammar::ExecutionTreeConstPtr execution, size_t index, IsFormatStringInput convertToStrings)
 
size_t WriteFunctionCallInputThisPointer (Grammar::ExecutionTreeConstPtr execution)
 
void WriteFunctionCallNamespace (Grammar::ExecutionTreeConstPtr)
 
void WriteFunctionCallNullCheckPost (Grammar::ExecutionTreeConstPtr execution)
 
void WriteFunctionCallNullCheckPre (Grammar::ExecutionTreeConstPtr execution)
 
void WriteFunctionCallOfNode (Grammar::ExecutionTreeConstPtr, AZStd::string nameOverride="", size_t inputOverride=AZStd::numeric_limits< size_t >::max())
 
void WriteGlobalPropertyRead (Grammar::ExecutionTreeConstPtr)
 
void WriteHeader ()
 
void WriteInfiniteLoopCheckPost (Grammar::ExecutionTreeConstPtr execution)
 
void WriteInfiniteLoopCheckPre (Grammar::ExecutionTreeConstPtr execution)
 
void WriteInitializeLocalSelfEntityId ()
 
void WriteLocalInputCreation (Grammar::ExecutionTreeConstPtr execution)
 
void WriteLocalOutputInitialization (Grammar::ExecutionTreeConstPtr execution)
 
void WriteLocalVariableInitializion (Grammar::ExecutionTreeConstPtr execution)
 
void WriteLogicalExpression (Grammar::ExecutionTreeConstPtr execution)
 
void WritePreFirstCaseSwitch (Grammar::ExecutionTreeConstPtr execution, Grammar::Symbol symbol)
 
void WriteOnVariableWritten (Grammar::ExecutionTreeConstPtr execution, const AZStd::vector< AZStd::pair< const Slot *, Grammar::OutputAssignmentConstPtr > > &output)
 
bool WriteOnVariableWritten (Grammar::VariableConstPtr variable)
 
void WriteOperatorArithmetic (Grammar::ExecutionTreeConstPtr execution)
 
void WriteOutputAssignments (Grammar::ExecutionTreeConstPtr execution)
 
void WriteOutputAssignments (Grammar::ExecutionTreeConstPtr execution, const AZStd::vector< AZStd::pair< const Slot *, Grammar::OutputAssignmentConstPtr > > &output)
 
void WriteResolvedScope (Grammar::ExecutionTreeConstPtr execution, const Grammar::LexicalScope &lexicalScope)
 
void WriteReturnStatement (Grammar::ExecutionTreeConstPtr execution)
 
void WriteReturnValueInitialization (Grammar::ExecutionTreeConstPtr execution)
 
void WriteStaticInitializerInput (IsLeadingCommaRequired commaRequired)
 
void WriteSwitchEnd (Grammar::Symbol symbol)
 
void WriteVariableRead (Grammar::VariableConstPtr variable)
 
void WriteVariableReadConvertible (const Grammar::ConversionByIndex &conversions, size_t index, Grammar::VariableConstPtr source)
 
void WriteVariableReference (Grammar::VariableConstPtr variable)
 
void WriteVariableWrite (Grammar::ExecutionTreeConstPtr execution, const AZStd::vector< AZStd::pair< const Slot *, Grammar::OutputAssignmentConstPtr > > &output)
 
void WriteWrittenMathExpression (Grammar::ExecutionTreeConstPtr execution)
 
- Protected Member Functions inherited from ScriptCanvas::Translation::GraphToX
 GraphToX (const Configuration &configuration, const Grammar::AbstractCodeModel &model)
 
void AddError (Grammar::ExecutionTreeConstPtr execution, ValidationConstPtr error)
 
AZStd::string AddMultiReturnName ()
 
AZStd::string GetMultiReturnName () const
 
void CloseBlockComment (Writer &writer)
 
void CloseFunctionBlock (Writer &writer)
 
void CloseScope (Writer &writer)
 
void CloseNamespace (Writer &writer, AZStd::string_view ns)
 
AZStd::string_view GetGraphName () const
 
AZStd::string_view GetFullPath () const
 
AZStd::sys_time_t GetTranslationDuration () const
 
AZStd::vector< ValidationConstPtr > && MoveErrors ()
 
void OpenBlockComment (Writer &writer)
 
void OpenFunctionBlock (Writer &writer)
 
void OpenNamespace (Writer &writer, AZStd::string_view ns)
 
void OpenScope (Writer &writer)
 
AZStd::string ResolveScope (const AZStd::vector< AZStd::string > &namespaces)
 
void SingleLineComment (Writer &writer)
 
void WriteCopyright (Writer &writer)
 
void WriteDoNotModify (Writer &writer)
 
void WriteLastWritten (Writer &writer)
 
void MarkTranslationStart ()
 
void MarkTranslationStop ()
 

Static Protected Member Functions

static IsNamed IsInputNamed (Grammar::VariableConstPtr input, Grammar::ExecutionTreeConstPtr execution)
 
static AZStd::string SanitizeFunctionCallName (AZStd::string_view name)
 

Protected Attributes

RuntimeInputs m_runtimeInputs
 
BuildConfiguration m_buildConfiguration = BuildConfiguration::Release
 
FunctionBlockConfig m_functionBlockConfig = FunctionBlockConfig::Ignored
 
Context m_context
 
AZStd::string m_tableName
 
Writer m_dotLua
 
SystemComponentConfiguration m_systemConfiguration
 
- Protected Attributes inherited from ScriptCanvas::Translation::GraphToX
const Grammar::AbstractCodeModel & m_model
 
const Configuration m_configuration
 
AZ::s32 m_multiReturnCount = 0
 

Additional Inherited Members

- Public Member Functions inherited from ScriptCanvas::Translation::GraphToX
bool IsSuccessfull () const
 
The documentation for this class was generated from the following file: