Fail node
The fail node is used for directing the control flow of execution by throwing a failure. Once selected, it will immediately switch to a running state and then transition to a failure state, creating an execution failure.
Properties
| Property | Description |
|---|---|
| Child semantics | Can only be leaf node, cannot have any children. |
| Parameters | name: name of the node failure_message: the error message to produce upon failure |
| Success criterion | none - never succeeds |
| Failure criterion | always - immediately fails |
Python API
The node can be constructed by parameterizing it on creation with the expected error message for the induced failure.
BT.Fail(failure_message="Fail to trigger retry node")