Sequine - Scripting API
Calcatz.Sequine.RunSubFlowCommand Class Reference
Inheritance diagram for Calcatz.Sequine.RunSubFlowCommand:
Calcatz.CookieCutter.Command< T1, T2, T3, T4, T5, T6, T7, T8, T9, T10 > Calcatz.CookieCutter.ISubDataCommand Calcatz.Sequine.RunSubFlowAssetCommand Calcatz.Sequine.RunSubFlowComponentCommand

Classes

class  VariablePair
 

Public Member Functions

override void Execute (CommandExecutionFlow _flow)
 The process to execute upon visiting the main in-point (white in-point). More...
 
override bool Validate (CommandData _commandData)
 Validate() is called when opening the nodes editor (if in Edit Mode), or right before the command execution (if in Play Mode). The main purpose is to adapt or validate any data inside the Command, if its structure had been changed. More...
 
override void Editor_InitInPoints ()
 Called when a Command Node is initialized, specifically the in-points. Use this method to ensure inputIds as well. More...
 
override void Editor_InitOutPoints ()
 Called when a Command Node is initialized, specifically the out-points. Use this method to ensure nextIds as well. More...
 
override void Editor_OnDrawTitle (out string _tooltip)
 Called when a Command Node's title is drawn. Use this to change the tooltip of the command. Also use this to decide whether the Title should draw in-point and/or out-point. More...
 
override void Editor_OnDrawContents (Vector2 _absPosition)
 Called when a Command Node is drawn. More...
 

Protected Member Functions

virtual ICommandData GetFlowObjectToExecute (CommandExecutionFlow _flow)
 
void SetupSubFlowExit (CommandExecutionFlow _flow)
 
virtual bool Editor_OnDrawTargetField ()
 
virtual void Editor_UpdateVariables (CommandData _subData, UnityEngine.Object _targetObject, bool _isValidate=false)
 

Protected Attributes

List< VariablePairvariablePairs = new List<VariablePair>()
 
ICommandData flowObjectToExecute
 

Static Protected Attributes

const int IN_PORT_TARGET = 0
 

Properties

override float nodeWidth [get]
 
virtual CommandData subData [get]
 

Additional Inherited Members

Member Function Documentation

◆ Editor_InitInPoints()

override void Calcatz.Sequine.RunSubFlowCommand.Editor_InitInPoints ( )
virtual

Called when a Command Node is initialized, specifically the in-points. Use this method to ensure inputIds as well.

Reimplemented from Calcatz.CookieCutter.Command< T1, T2, T3, T4, T5, T6, T7, T8, T9, T10 >.

◆ Editor_InitOutPoints()

override void Calcatz.Sequine.RunSubFlowCommand.Editor_InitOutPoints ( )
virtual

Called when a Command Node is initialized, specifically the out-points. Use this method to ensure nextIds as well.

Reimplemented from Calcatz.CookieCutter.Command< T1, T2, T3, T4, T5, T6, T7, T8, T9, T10 >.

◆ Editor_OnDrawContents()

override void Calcatz.Sequine.RunSubFlowCommand.Editor_OnDrawContents ( Vector2  _absPosition)
virtual

Called when a Command Node is drawn.

Parameters
_absPosition

Reimplemented from Calcatz.CookieCutter.Command< T1, T2, T3, T4, T5, T6, T7, T8, T9, T10 >.

◆ Editor_OnDrawTargetField()

virtual bool Calcatz.Sequine.RunSubFlowCommand.Editor_OnDrawTargetField ( )
protectedvirtual

Returns
Returns true if the target is changed.

Reimplemented in Calcatz.Sequine.RunSubFlowAssetCommand, and Calcatz.Sequine.RunSubFlowComponentCommand.

◆ Editor_OnDrawTitle()

override void Calcatz.Sequine.RunSubFlowCommand.Editor_OnDrawTitle ( out string  _tooltip)
virtual

Called when a Command Node's title is drawn. Use this to change the tooltip of the command. Also use this to decide whether the Title should draw in-point and/or out-point.

Parameters
_tooltip

Reimplemented from Calcatz.CookieCutter.Command< T1, T2, T3, T4, T5, T6, T7, T8, T9, T10 >.

◆ Editor_UpdateVariables()

virtual void Calcatz.Sequine.RunSubFlowCommand.Editor_UpdateVariables ( CommandData  _subData,
UnityEngine.Object  _targetObject,
bool  _isValidate = false 
)
protectedvirtual

◆ Execute()

override void Calcatz.Sequine.RunSubFlowCommand.Execute ( CommandExecutionFlow  _flow)
virtual

The process to execute upon visiting the main in-point (white in-point).

Parameters
_flow

Reimplemented from Calcatz.CookieCutter.Command< T1, T2, T3, T4, T5, T6, T7, T8, T9, T10 >.

◆ GetFlowObjectToExecute()

virtual ICommandData Calcatz.Sequine.RunSubFlowCommand.GetFlowObjectToExecute ( CommandExecutionFlow  _flow)
protectedvirtual

◆ SetupSubFlowExit()

void Calcatz.Sequine.RunSubFlowCommand.SetupSubFlowExit ( CommandExecutionFlow  _flow)
protected

◆ Validate()

override bool Calcatz.Sequine.RunSubFlowCommand.Validate ( CommandData  _commandData)
virtual

Validate() is called when opening the nodes editor (if in Edit Mode), or right before the command execution (if in Play Mode). The main purpose is to adapt or validate any data inside the Command, if its structure had been changed.

Returns
Returns true if the command is modified due to validation.

Reimplemented from Calcatz.CookieCutter.Command< T1, T2, T3, T4, T5, T6, T7, T8, T9, T10 >.

Reimplemented in Calcatz.Sequine.RunSubFlowComponentCommand.

Member Data Documentation

◆ flowObjectToExecute

ICommandData Calcatz.Sequine.RunSubFlowCommand.flowObjectToExecute
protected

◆ IN_PORT_TARGET

const int Calcatz.Sequine.RunSubFlowCommand.IN_PORT_TARGET = 0
staticprotected

◆ variablePairs

List<VariablePair> Calcatz.Sequine.RunSubFlowCommand.variablePairs = new List<VariablePair>()
protected

Property Documentation

◆ nodeWidth

override float Calcatz.Sequine.RunSubFlowCommand.nodeWidth
get

◆ subData

virtual CommandData Calcatz.Sequine.RunSubFlowCommand.subData
get