Class FlowGraphEventBlockAbstract
Hierarchy (View Summary)
- FlowGraphAsyncExecutionBlock
Constructors
constructor
-
Creates a new event block.
Parameters
Optionalconfig: IFlowGraphBlockConfigurationoptional configuration
Returns FlowGraphEventBlock
Properties
Optionalconfig
the configuration of the block
data
The data inputs of the block.
data
The data outputs of the block.
done
Output connection: The signal that is triggered when the asynchronous execution of this block is done.
Readonlyerror
An output connection that can be used to signal an error, if the block defines it.
Readonlyin
Input connection: The input signal of the block.
init
the priority of initialization of this block. For example, scene start should have a negative priority because it should be initialized last.
metadata
Metadata that can be used by the block.
name
The name of the block.
Readonlyout
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.
Readonlypriority
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.
signal
Input connections that activate the block.
signal
Output connections that can activate downstream blocks.
Readonlytype
The type of the event
unique
A randomly generated GUID for each block.
Accessors
event
-
get eventKey(): string
Stable key used to represent this event during propagation. Event blocks with equivalent event sources should return the same key.
Returns string
Methods
Abstract_
-
Parameters
- context: FlowGraphContext
Returns void
Abstract_
-
Execute the event. This function should be called by the flow graph when the event is triggered.
Parameters
- context: FlowGraphContext
the context in which the event is executed
- payload: any
the payload of the event
Returns boolean
a boolean indicating if the event should stop propagation. if false, the event will stop propagating.
- context: FlowGraphContext
_
-
Parameters
- context: FlowGraphContext
Returns void
deserialize
-
Deserializes from an object. Filters out the legacy "in" signal input that existed before event blocks stopped exposing it, so old serialized graphs load without error.
Parameters
- serializationObject: any
the object to deserialize from
Returns void
- serializationObject: any
get
-
Returns string
the class name
get
-
Given the name of a data input, returns the connection if it exists
Parameters
- name: string
the name of the input
Returns FlowGraphDataConnection<any> | undefined
the connection if it exists, undefined otherwise
- name: string
get
-
Given the name of a data output, returns the connection if it exists
Parameters
- name: string
the name of the output
Returns FlowGraphDataConnection<any> | undefined
the connection if it exists, undefined otherwise
- name: string
get
-
Given a name of a signal input, return that input if it exists
Parameters
- name: string
the name of the input
Returns FlowGraphSignalConnection | undefined
if the input exists, the input. Otherwise, undefined.
- name: string
get
-
Given a name of a signal output, return that input if it exists
Parameters
- name: string
the name of the input
Returns FlowGraphSignalConnection | undefined
if the input exists, the input. Otherwise, undefined.
- name: string
register
-
registerDataInput<T>(
name: string,
richType: RichType<T>,
defaultValue?: T,
): FlowGraphDataConnection<T>Registers a data input on the block.
Type Parameters
- T
Parameters
Returns FlowGraphDataConnection<T>
the created connection
register
-
registerDataOutput<T>(
name: string,
richType: RichType<T>,
defaultValue?: T,
): FlowGraphDataConnection<T>Registers a data output on the block.
Type Parameters
- T
Parameters
Returns FlowGraphDataConnection<T>
the created connection
serialize
-
Serializes this block
Parameters
- serializationObject: any = {}
the object to serialize in
Returns void
- serializationObject: any = {}
A type of block that listens to an event observable and activates its output signal when the event is triggered.