Flow Control category - Stingray Flow Node Reference

Related help topics

Nodes

Branch

Creates a decision based data flow from a single boolean condition.

Outputs
		True		event	The output event fired if the condition is true.
		False		event	The output event fired if the condition is false.
Inputs
boolean		Condition			A boolean value to take a decision upon.
event		In			This event triggers the evaluation of this node.

When executed, the node looks at the incoming value and outputs the event firing based on the boolean's condition.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Compare Numerics

Compares two numeric values and fires events based on whether A is less than B, A is less or equal to B, A is equal to B, A is greater or equal to B, and A is greater than B.

Outputs
		Less		event	The output event fired if the first value is less than the second value.
		Less Or Equal		event	The output event fired if the first value is less than or equal to the second value.
		Equal		event	The output event fired if the first value is equal to the second value.
		Greater Or Equal		event	The output event fired if the first value is greater than or equal to the second value.
		Greater		event	The output event fired if the first value is greater than the second value.
Inputs
float		A			The first value to compare.
float		B			The second value to compare.
event		Compare			The input event that triggers the comparison.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Compare Objects

Compares two objects as inputs and fires event outputs based on if the objects are equal or unequal.

Outputs
		Equal		event	The output event fired if the first object is equal to the second one.
		Unequal		event	The output event fired if the first object is not equal to the second one.
Inputs
generic		A			The first object to compare.
generic		B			The second object to compare.
event		Compare			The input event that triggers the comparison.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Counter

Increases or decreases a specified value by an increment based on the increase and decrease event inputs.

Outputs
		Changed		event	The changed output event.
		Value		float	The resultant value.
Inputs
float		Start Value			The starting value.
float		Increment			The counter value.
event		Increase			The input event for increasing the value.
event		Decrease			The input event for decreasing the value.
event		Reset			The input event for reseting the value.

Returns a current value and a changed output event.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Delay

Inserts a delay in evaluation by the specified numeric value.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
float		Time			The time to delay the evaluation, in seconds.
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

For Loop

Fires an event output for each index between the start and end value.

Outputs
		Loop Body		event	The output event triggered for each index of the loop.
		Completed		event	The output event triggered when the loop is completed.
		Current Value		float	The current value of the loop.
Inputs
float		Start Value			The start value of the loop.
float		End Value			The end value of the loop.
float		Increment			The increment value of the loop.
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Once

Fires an event output just once.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
event		In			This event triggers the evaluation of this node.

After the event has been fired, this node will cease all execution until the level is reloaded.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Randomize

Allows a single input event to randomly trigger one of a set of possible output events.

Outputs
		Out 1		event
		Out 2		event
		Out 3		event
		Out 4		event
		Out 5		event
		Out 6		event
		Out 7		event
		Out 8		event
Inputs
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Relay

Opens and closes a stream of execution.

Outputs
		Enabled		boolean	Returns true if the execution is enabled and false otherwise.
		Out		event	This event is triggered when the node finishes its evaluation.
Variables
		Start Enabled		boolean	A boolean to enable execution.
Inputs
event		In			This event triggers the evaluation of this node.
event		Enable			The input event for enabling the execution.
event		Disable			The input event for disabling the execution.
event		Toggle			The input event for toggling the execution decision.

The stream will remain active so long as the Open function is triggered.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Sequence

Allows a single input event event to trigger multiple output events in order.

Outputs
		Out 1		event
		Out 2		event
		Out 3		event
		Out 4		event
		Out 5		event
		Out 6		event
		Out 7		event
		Out 8		event
Inputs
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Timer

Fires an output event at every period set by the time input.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
		Enabled		boolean	Returns true if the loop is enabled and false otherwise.
		Loop Count		float	The number of times the loop is executed.
Inputs
float		Time			The time interval, in seconds.
boolean		Loop			A boolean to enable the loop (true).
event		In			This event triggers the evaluation of this node.
event		Enable
event		Disable

Will continuously loop at the specified time interval if loop is enabled. Enable event input must be connected to evaluate.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Toggle

Alternates between the even and odd output events every time the in event gets fired.

Outputs
		Even		event	This event is triggered when this node has been evaluated an even number of times.
		Odd		event	This event is triggered when this node has been evaluated an odd number of times.
Inputs
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

While Loop

Outputs a result as long as the input condition remains true.

Outputs
		Loop Body		event	The output event triggered for each execution of the loop.
		Completed		event	The output event triggered when the loop is completed.
		Loop Count		float	The number of times the loop is executed.
Inputs
boolean		Condition			A boolean to indicate the state of the input condition.
event		In			This event triggers the evaluation of this node.

When the input condition returns false, the node will break.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.