Class: StrictConnectionChecker
Defined in: plugins/strict-connection-checker/src/index.js:25
A connection checker that imposes stricter typing rules than the default checker in Blockly, but uses the same rules for dragging and safety. This checker still expects nullable arrays of string for connection type checks, and still looks for intersections in the arrays. Unlike the default checker, null checks arrays are only compatible with other null arrays.
Implements
Extends
ConnectionChecker
Methods index
| Method | Description |
|---|---|
| canConnect | Check whether the current connection can connect with the target connection. |
| canConnectToPrevious_ | Helper function for drag checking. |
| canConnectWithReason | Checks whether the current connection can connect with the target connection, and return an error code if there are problems. |
| doDragChecks | Check whether this connection can be made by dragging. |
| doSafetyChecks | Check that connecting the given connections is safe, meaning that it would not break any of Blockly's basic assumptions (e.g. no self connections). |
| doTypeChecks | Type check arrays must either intersect or both be null. |
| getErrorMessage | Helper method that translates a connection error code into a string. |
Constructors
Constructor
new StrictConnectionChecker(): StrictConnectionChecker;
Defined in: plugins/strict-connection-checker/src/index.js:29
Constructor for the connection checker.
Returns
StrictConnectionChecker
Overrides
Blockly.ConnectionChecker.constructor
Methods
canConnect()
canConnect(
a,
b,
isDragging,
opt_distance?
): boolean;
Check whether the current connection can connect with the target connection.
Parameters
| Parameter | Type | Description |
|---|---|---|
a | Connection | null | Connection to check compatibility with. |
b | Connection | null | Connection to check compatibility with. |
isDragging | boolean | True if the connection is being made by dragging a block. |
opt_distance? | number | The max allowable distance between the connections for drag checks. |
Returns
boolean
Whether the connection is legal.
Inherited from
Blockly.ConnectionChecker.canConnect
canConnectToPrevious_()
protected canConnectToPrevious_(a, b): boolean;
Helper function for drag checking.
Parameters
| Parameter | Type | Description |
|---|---|---|
a | Connection | The connection to check, which must be a statement input or next connection. |
b | Connection | A nearby connection to check, which must be a previous connection. |
Returns
boolean
True if the connection is allowed, false otherwise.
Inherited from
Blockly.ConnectionChecker.canConnectToPrevious_
canConnectWithReason()
canConnectWithReason(
a,
b,
isDragging,
opt_distance?
): number;
Checks whether the current connection can connect with the target connection, and return an error code if there are problems.
Parameters
| Parameter | Type | Description |
|---|---|---|
a | Connection | null | Connection to check compatibility with. |
b | Connection | null | Connection to check compatibility with. |
isDragging | boolean | True if the connection is being made by dragging a block. |
opt_distance? | number | The max allowable distance between the connections for drag checks. |
Returns
number
Connection.CAN_CONNECT if the connection is legal, an error code otherwise.
Inherited from
Blockly.ConnectionChecker.canConnectWithReason
doDragChecks()
doDragChecks(
a,
b,
distance
): boolean;
Check whether this connection can be made by dragging.
Parameters
| Parameter | Type | Description |
|---|---|---|
a | RenderedConnection | Connection to compare (on the block that's being dragged). |
b | RenderedConnection | Connection to compare against. |
distance | number | The maximum allowable distance between connections. |
Returns
boolean
True if the connection is allowed during a drag.
Inherited from
Blockly.ConnectionChecker.doDragChecks
doSafetyChecks()
doSafetyChecks(a, b): number;
Check that connecting the given connections is safe, meaning that it would not break any of Blockly's basic assumptions (e.g. no self connections).
Parameters
| Parameter | Type | Description |
|---|---|---|
a | Connection | null | The first of the connections to check. |
b | Connection | null | The second of the connections to check. |
Returns
number
An enum with the reason this connection is safe or unsafe.
Inherited from
Blockly.ConnectionChecker.doSafetyChecks
doTypeChecks()
doTypeChecks(a, b): boolean;
Defined in: plugins/strict-connection-checker/src/index.js:37
Type check arrays must either intersect or both be null.
Parameters
| Parameter | Type |
|---|---|
a | any |
b | any |
Returns
boolean
Overrides
Blockly.ConnectionChecker.doTypeChecks
getErrorMessage()
getErrorMessage(
errorCode,
a,
b
): string;
Helper method that translates a connection error code into a string.
Parameters
| Parameter | Type | Description |
|---|---|---|
errorCode | number | The error code. |
a | Connection | null | One of the two connections being checked. |
b | Connection | null | The second of the two connections being checked. |
Returns
string
A developer-readable error string.
Inherited from
Blockly.ConnectionChecker.getErrorMessage