Class FlowGraphSignalConnection
Hierarchy (View Summary)
- FlowGraphConnection<FlowGraphExecutionBlock, FlowGraphSignalConnection>
- FlowGraphSignalConnection
Constructors
constructor
-
new FlowGraphSignalConnection(
name: string,
_connectionType: FlowGraphConnectionType,
_ownerBlock: FlowGraphExecutionBlock,
): FlowGraphSignalConnectionParameters
- name: string
- _connectionType: FlowGraphConnectionType
- _ownerBlock: FlowGraphExecutionBlock
Returns FlowGraphSignalConnection
Properties
_
Optionalmetadata
Optional host-format metadata associated with this connection.
name
The name of the connection.
payload
Optional payload. Can be used, for example, when an error is thrown to pass additional information.
priority
The priority of the signal. Signals with higher priority will be executed first. Set priority before adding the connection as sorting happens only when the connection is added.
unique
A uniquely identifying string for the connection.
Accessors
connection
-
The type of the connection
Returns FlowGraphConnectionType
Methods
connect
-
Connects two connections together.
Parameters
- point: FlowGraphSignalConnection
the connection to connect to.
Returns void
- point: FlowGraphSignalConnection
deserialize
-
Deserialize from a object into this
Parameters
- serializationObject: any
the object to deserialize from.
Returns void
- serializationObject: any
disconnect
-
Disconnects two connections.
Parameters
- point: FlowGraphSignalConnection
the connection to disconnect from.
- removeFromLocal: boolean = true
if true, the connection will be removed from the local connection list.
Returns void
- point: FlowGraphSignalConnection
disconnect
-
Disconnects all connected points.
Returns void
dispose
-
Disconnects this point from every connected point.
Returns void
get
-
Returns string
class name of the connection.
is
-
Returns if a point is connected to any other point.
Returns boolean
boolean indicating if the point is connected.
serialize
-
Saves the connection to a JSON object.
Parameters
- serializationObject: any = {}
the object to serialize to.
Returns void
- serializationObject: any = {}
Represents a connection point for a signal. When an output point is activated, it will activate the connected input point. When an input point is activated, it will execute the block it belongs to.