Sequine - Scripting API
Calcatz.Sequine.RunSubFlowComponentCommand Class Reference

Executes a Sequine Flow Component, and continue to next command only when the specified Sequine Flow Component finished its execution. More...

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

Public Member Functions

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...
 
- Public Member Functions inherited from Calcatz.Sequine.RunSubFlowCommand
override void Execute (CommandExecutionFlow _flow)
 The process to execute upon visiting the main in-point (white in-point). 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...
 

Public Attributes

UnityEngine.Object target
 
TargetObject< SequineFlowComponentflowComponentRef
 

Protected Member Functions

override ICommandData GetFlowObjectToExecute (CommandExecutionFlow _flow)
 
SequineFlowComponent GetSequineFlowComponent (CommandExecutionFlow _flow)
 
override bool Editor_OnDrawTargetField ()
 
override void Editor_UpdateVariables (CommandData _subData, UnityEngine.Object _targetObject, bool _isValidate)
 
- Protected Member Functions inherited from Calcatz.Sequine.RunSubFlowCommand
void SetupSubFlowExit (CommandExecutionFlow _flow)
 

Properties

override CommandDatasubData [get]
 
- Properties inherited from Calcatz.Sequine.RunSubFlowCommand
override float nodeWidth [get]
 
virtual CommandData subData [get]
 

Additional Inherited Members

- Protected Attributes inherited from Calcatz.Sequine.RunSubFlowCommand
List< VariablePairvariablePairs = new List<VariablePair>()
 
ICommandData flowObjectToExecute
 
- Static Protected Attributes inherited from Calcatz.Sequine.RunSubFlowCommand
const int IN_PORT_TARGET = 0
 

Detailed Description

Executes a Sequine Flow Component, and continue to next command only when the specified Sequine Flow Component finished its execution.

Member Function Documentation

◆ Editor_OnDrawTargetField()

override bool Calcatz.Sequine.RunSubFlowComponentCommand.Editor_OnDrawTargetField ( )
protectedvirtual

Returns
Returns true if the target is changed.

Reimplemented from Calcatz.Sequine.RunSubFlowCommand.

◆ Editor_UpdateVariables()

override void Calcatz.Sequine.RunSubFlowComponentCommand.Editor_UpdateVariables ( CommandData  _subData,
UnityEngine.Object  _targetObject,
bool  _isValidate 
)
protectedvirtual

Reimplemented from Calcatz.Sequine.RunSubFlowCommand.

◆ GetFlowObjectToExecute()

override ICommandData Calcatz.Sequine.RunSubFlowComponentCommand.GetFlowObjectToExecute ( CommandExecutionFlow  _flow)
protectedvirtual

Reimplemented from Calcatz.Sequine.RunSubFlowCommand.

◆ GetSequineFlowComponent()

SequineFlowComponent Calcatz.Sequine.RunSubFlowComponentCommand.GetSequineFlowComponent ( CommandExecutionFlow  _flow)
protected

◆ Validate()

override bool Calcatz.Sequine.RunSubFlowComponentCommand.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.Sequine.RunSubFlowCommand.

Member Data Documentation

◆ flowComponentRef

TargetObject<SequineFlowComponent> Calcatz.Sequine.RunSubFlowComponentCommand.flowComponentRef

◆ target

UnityEngine.Object Calcatz.Sequine.RunSubFlowComponentCommand.target

Property Documentation

◆ subData

override CommandData? Calcatz.Sequine.RunSubFlowComponentCommand.subData
get