EventDispatcher → Node →

LoopNode

This module offers a variety of ways to implement loops in TSL. In it's basic form it's:

However, it is also possible to define a start and end ranges, data types and loop conditions:

Loop( { start: int( 0 ), end: int( 10 ), type: 'int', condition: '<' }, ( { i } ) => {
} );

Nested loops can be defined in a compacted form:

Loop( 10, 5, ( { i, j } ) => {
} );

Loops that should run backwards can be defined like so:

Loop( { start: 10 }, () => {} );

It is possible to execute with boolean values, similar to the while syntax.

const value = float( 0 ).toVar();
Loop( value.lessThan( 10 ), () => {
	value.addAssign( 1 );
} );

The module also provides Break() and Continue() TSL expression for loop control.

Code Example

Loop( count, ( { i } ) => {
} );

Constructor

new LoopNode( params : Array.<any> )

Constructs a new loop node.

params

Depending on the loop type, array holds different parameterization values for the loop.

Methods

.getNodeType( builder : NodeBuilder ) : string

This method is overwritten since the node type is inferred based on the loop configuration.

builder

The current node builder.
Overrides: Node#getNodeType
Returns: The node type.

.getProperties( builder : NodeBuilder ) : Object

Returns properties about this node.

builder

The current node builder.
Returns: The node properties.

.getVarName( index : number ) : string

Returns a loop variable name based on an index. The pattern is 0 = i, 1= j, 2= k and so on.

index

The index.
Returns: The loop variable name.

Source

src/nodes/utils/LoopNode.js