FlowGraphDoNBlock | Babylon.js API documentation

Class FlowGraphDoNBlock

A block that executes a branch a set number of times.

Hierarchy (View Summary)

FlowGraphExecutionBlockWithOutSignal
- FlowGraphDoNBlock

Constructors

constructor

new FlowGraphDoNBlock(
config?: IFlowGraphDoNBlockConfiguration,
): FlowGraphDoNBlock
Parameters
- Optionalconfig: IFlowGraphDoNBlockConfiguration
  [Object] the configuration of the block
Returns FlowGraphDoNBlock
Overrides FlowGraphExecutionBlockWithOutSignal.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:107813

Properties

config

config: IFlowGraphDoNBlockConfiguration

[Object] the configuration of the block

dataInputs

dataInputs: FlowGraphDataConnection<any>[]

The data inputs of the block.

dataOutputs

dataOutputs: FlowGraphDataConnection<any>[]

The data outputs of the block.

`Readonly`error

error: FlowGraphSignalConnection

An output connection that can be used to signal an error, if the block defines it.

`Readonly`executionCount

executionCount: FlowGraphDataConnection<FlowGraphInteger>

Output connection: The number of times the block has been executed.

`Readonly`in

in: FlowGraphSignalConnection

Input connection: The input signal of the block.

`Readonly`maxExecutions

maxExecutions: FlowGraphDataConnection<FlowGraphInteger>

Input connection: The maximum number of times the block can be executed.

metadata

metadata: any

Metadata that can be used by the block.

name

name: string

The name of the block.

`Readonly`out

out: FlowGraphSignalConnection

Output connection: The signal that is synchronous triggered when the execution of this block is done. Note that is case of events or async you might want to use the done signal instead.

`Readonly`priority

priority: number

The priority of the block. Higher priority blocks will be executed first. Note that priority cannot be change AFTER the block was added as sorting happens when the block is added to the execution queue.

`Readonly`reset

reset: FlowGraphSignalConnection

Input connection: Resets the counter

signalInputs

signalInputs: FlowGraphSignalConnection[]

Input connections that activate the block.

signalOutputs

signalOutputs: FlowGraphSignalConnection[]

Output connections that can activate downstream blocks.

uniqueId

uniqueId: string

A randomly generated GUID for each block.

Methods

deserialize

deserialize(serializationObject: any): void
Deserializes from an object
Parameters
- serializationObject: any
  the object to deserialize from
Returns void
Inherited from FlowGraphExecutionBlockWithOutSignal.deserialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:105841

getClassName

getClassName(): string
Returns string
class name of the block.
Overrides FlowGraphExecutionBlockWithOutSignal.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:107822

getDataInput

getDataInput(name: string): undefined | FlowGraphDataConnection<any>
Given the name of a data input, returns the connection if it exists
Parameters
- name: string
  the name of the input
Returns undefined | FlowGraphDataConnection<any>
the connection if it exists, undefined otherwise
Inherited from FlowGraphExecutionBlockWithOutSignal.getDataInput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:106609

getDataOutput

getDataOutput(name: string): undefined | FlowGraphDataConnection<any>
Given the name of a data output, returns the connection if it exists
Parameters
- name: string
  the name of the output
Returns undefined | FlowGraphDataConnection<any>
the connection if it exists, undefined otherwise
Inherited from FlowGraphExecutionBlockWithOutSignal.getDataOutput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:106615

getSignalInput

getSignalInput(name: string): undefined | FlowGraphSignalConnection
Given a name of a signal input, return that input if it exists
Parameters
- name: string
  the name of the input
Returns undefined | FlowGraphSignalConnection
if the input exists, the input. Otherwise, undefined.
Inherited from FlowGraphExecutionBlockWithOutSignal.getSignalInput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:105825

getSignalOutput

getSignalOutput(name: string): undefined | FlowGraphSignalConnection
Given a name of a signal output, return that input if it exists
Parameters
- name: string
  the name of the input
Returns undefined | FlowGraphSignalConnection
if the input exists, the input. Otherwise, undefined.
Inherited from FlowGraphExecutionBlockWithOutSignal.getSignalOutput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:105831

registerDataInput

registerDataInput<T>(
    name: string,
    richType: RichType<T>,
    defaultValue?: T,
): FlowGraphDataConnection<T>
Registers a data input on the block.
Type Parameters
- T
Parameters
- name: string
  the name of the input
- richType: RichType<T>
  the type of the input
- OptionaldefaultValue: T
  optional default value of the input. If not set, the rich type's default value will be used.
Returns FlowGraphDataConnection<T>
the created connection
Inherited from FlowGraphExecutionBlockWithOutSignal.registerDataInput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:106595

registerDataOutput

registerDataOutput<T>(
    name: string,
    richType: RichType<T>,
    defaultValue?: T,
): FlowGraphDataConnection<T>
Registers a data output on the block.
Type Parameters
- T
Parameters
- name: string
  the name of the input
- richType: RichType<T>
  the type of the input
- OptionaldefaultValue: T
  optional default value of the input. If not set, the rich type's default value will be used.
Returns FlowGraphDataConnection<T>
the created connection
Inherited from FlowGraphExecutionBlockWithOutSignal.registerDataOutput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:106603

serialize

serialize(serializationObject?: any): void
Serializes this block
Parameters
- OptionalserializationObject: any
  the object to serialize in
Returns void
Inherited from FlowGraphExecutionBlockWithOutSignal.serialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:105836

Class FlowGraphDoNBlock

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlowGraphDoNBlock

Properties

config

dataInputs

dataOutputs

Readonlyerror

ReadonlyexecutionCount

Readonlyin

ReadonlymaxExecutions

metadata

name

Readonlyout

Readonlypriority

Readonlyreset

signalInputs

signalOutputs

uniqueId

Methods

deserialize

Parameters

Returns void

getClassName

Returns string

getDataInput

Parameters

Returns undefined | FlowGraphDataConnection<any>

getDataOutput

Parameters

Returns undefined | FlowGraphDataConnection<any>

getSignalInput

Parameters

Returns undefined | FlowGraphSignalConnection

getSignalOutput

Parameters

Returns undefined | FlowGraphSignalConnection

registerDataInput

Type Parameters

Parameters

Returns FlowGraphDataConnection<T>

registerDataOutput

Type Parameters

Parameters

Returns FlowGraphDataConnection<T>

serialize

Parameters

Returns void

Settings

On This Page

`Readonly`error

`Readonly`executionCount

`Readonly`in

`Readonly`maxExecutions

`Readonly`out

`Readonly`priority

`Readonly`reset