Class FlowGraphExperimental

constructor

• new FlowGraph(params: IFlowGraphParams): FlowGraph
  Experimental

  Construct a Flow Graph

  Parameters

  • params: IFlowGraphParams

    construction parameters. currently only the scene

  Returns FlowGraph

Optional Experimentalmetadata

Experimentalname

ExperimentalonStateChangedObservable

ExperimentaluniqueId

Static ExperimentalEditorURL

contextCount

• get contextCount(): number
  Experimental

  Returns the number of execution contexts currently attached to this graph.

  Returns number

coordinator

• get coordinator(): FlowGraphCoordinator
  Experimental

  The coordinator that owns this flow graph.

  Returns FlowGraphCoordinator

scene

• get scene(): Scene
  Experimental

  The scene associated with this flow graph.

  Returns Scene

sceneEventCoordinator

• get sceneEventCoordinator(): FlowGraphSceneEventCoordinator
  Experimental

  The scene event coordinator for this graph. Provides access to runtime event state such as currently pressed keys.

  Returns FlowGraphSceneEventCoordinator

state

• get state(): FlowGraphState
  Experimental

  The state of the graph

  Returns FlowGraphState

• set state(value: FlowGraphState): void
  Experimental

  The state of the graph

  Parameters

  • value: FlowGraphState

  Returns void

addBlock

• addBlock(block: FlowGraphBlock): void
  Experimental

  Register a block with the graph. This does not wire any connections; it simply ensures the block is tracked so that serialization, editor display, and validation see it even when it is not reachable from an event block.

  Parameters

  • block: FlowGraphBlock

    the block to register

  Returns void

addEventBlock

• addEventBlock(block: FlowGraphEventBlock): void
  Experimental

  Add an event block. When the graph is started, it will start listening to events from the block and execute the graph when they are triggered.

  Parameters

  • block: FlowGraphEventBlock

    the event block to be added

  Returns void

createContext

• createContext(): FlowGraphContext
  Experimental

  Create a context. A context represents one self contained execution for the graph, with its own variables.

  Returns FlowGraphContext

  the context, where you can get and set variables

dispose

• dispose(): void
  Experimental

  Disposes of the flow graph. Cancels any pending tasks and removes all event listeners.

  Returns void

edit

• edit(config?: IFlowGraphEditorLaunchOptions): Promise<void>
  Experimental

  Launches the flow graph editor for this graph. The editor is lazy-loaded from FlowGraph.EditorURL the first time it is used.

  Parameters

  • Optionalconfig: IFlowGraphEditorLaunchOptions

    defines the configuration of the editor

  Returns Promise<void>

  a promise fulfilled when the editor is visible

getAllBlocks

• getAllBlocks(): readonly FlowGraphBlock[]
  Experimental

  Returns all blocks registered in this graph, including disconnected ones.

  Returns readonly FlowGraphBlock[]

  a read-only array of all blocks

getContext

• getContext(index: number): FlowGraphContext
  Experimental

  Returns the execution context at a given index

  Parameters

  • index: number

    the index of the context

  Returns FlowGraphContext

  the execution context at that index

pause

• pause(): void
  Experimental

  Pauses the flow graph. Cancels pending tasks but keeps execution contexts and event blocks. Call start() to resume.

  Returns void

removeBlock

• removeBlock(block: FlowGraphBlock): void
  Experimental

  Remove a block from the graph. Disconnects all of its ports and, if it is an event block, unregisters it from the event-block lists.

  Parameters

  • block: FlowGraphBlock

    the block to remove

  Returns void

removeContext

• removeContext(index: number): FlowGraphContext | undefined
  Experimental

  Remove an execution context by index. Any pending async blocks on the context are cleared before removal.

  Parameters

  • index: number

    the index of the context to remove

  Returns FlowGraphContext | undefined

  the removed context, or undefined if the index was out of range

serialize

• serialize(
      serializationObject?: any,
      valueSerializeFunction?: (
          key: string,
          value: any,
          serializationObject: any,
      ) => void,
  ): void
  Experimental

  Serializes a graph

  Parameters

  • serializationObject: any = {}

    the object to write the values in

  • OptionalvalueSerializeFunction: (key: string, value: any, serializationObject: any) => void

    a function to serialize complex values

  Returns void

setScene

• setScene(scene: Scene): void
  Experimental

  Sets a new scene for this flow graph, re-wiring all event listeners. This is useful when the scene the flow graph should listen to changes (e.g. when a new scene is loaded in an editor preview). If the graph is currently running, it will be stopped first and must be restarted manually after calling this method.

  Parameters

  • scene: Scene

    the new scene to attach to

  Returns void

start

• start(): void
  Experimental

  Starts the flow graph. Initializes the event blocks and starts listening to events. Can also be called to resume from a paused state.

  Returns void

stop

• stop(): void
  Experimental

  Stops the flow graph. Cancels all pending tasks and clears execution contexts, but keeps event blocks so the graph can be restarted.

  Returns void

validate

• validate(): IFlowGraphValidationResult
  Experimental

  Validates the flow graph and returns all issues found. Uses the tracked block list for complete validation including unreachable block detection.

  Returns IFlowGraphValidationResult

  The validation result containing errors and warnings.

visitAllBlocks

• visitAllBlocks(visitor: (block: FlowGraphBlock) => void): void
  Experimental

  Executes a function in all blocks of a flow graph, starting with the event blocks.

  Parameters

  • visitor: (block: FlowGraphBlock) => void

    the function to execute.

  Returns void