mirror of
https://github.com/vegu-ai/talemate.git
synced 2026-09-02 20:20:40 +02:00
90 lines
2.4 KiB
Markdown
90 lines
2.4 KiB
Markdown
|
# Flow Exception Nodes
|
||
|
|
|
||
|
|
Stop or redirect graph execution by raising exceptions: **Stop** ends the current run, **Input Value Error** reports invalid socket input, and **Acted As Character** signals that a character turn happened. See [Error Handling](../../core-concepts/error-handling.md).
|
||
|
|
|
||
|
|
<!-- glossary:generated - everything below this line is generated by `python -m talemate.game.engine.nodes.tools glossary --write` - do not edit -->
|
||
|
|
|
||
|
|
|
||
|
|
_3 nodes._
|
||
|
|
|
||
|
|
| Node | Registry path |
|
||
|
|
| --- | --- |
|
||
|
|
| [Acted As Character](#acted-as-character) | `raise/ActedAsCharacter` |
|
||
|
|
| [Input Value Error](#input-value-error) | `raise/InputValueError` |
|
||
|
|
| [Stop](#stop) | `raise/Stop` |
|
||
|
|
|
||
|
|
## Acted As Character
|
||
|
|
|
||
|
|
`raise/ActedAsCharacter`
|
||
|
|
|
||
|
|
Raises an ActedAsCharacter exception.
|
||
|
|
|
||
|
|
This is used to communicate to the main scene loop that the user
|
||
|
|
has performed an action as a specific character.
|
||
|
|
|
||
|
|
**Inputs**
|
||
|
|
|
||
|
|
| Input | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| `state` | `any` | The current graph state |
|
||
|
|
| `character_name` | `str` | The name of the character the user acted as |
|
||
|
|
|
||
|
|
**Outputs**
|
||
|
|
|
||
|
|
| Output | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| `state` | `any` | The state input, passed through |
|
||
|
|
|
||
|
|
## Input Value Error
|
||
|
|
|
||
|
|
`raise/InputValueError`
|
||
|
|
|
||
|
|
Raises an InputValueError exception.
|
||
|
|
|
||
|
|
**Inputs**
|
||
|
|
|
||
|
|
| Input | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| `state` | `any` | The current state |
|
||
|
|
| `message` | `str` | The message to raise the exception with |
|
||
|
|
| `field` | `str` | The field that caused the error |
|
||
|
|
|
||
|
|
**Outputs**
|
||
|
|
|
||
|
|
| Output | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| `state` | `any` | The state input, passed through |
|
||
|
|
|
||
|
|
**Properties**
|
||
|
|
|
||
|
|
| Property | Type | Default | Description |
|
||
|
|
| --- | --- | --- | --- |
|
||
|
|
| `message` | `str` | `""` | The message to raise the exception with |
|
||
|
|
| `field` | `str` | `""` | The field that caused the error |
|
||
|
|
|
||
|
|
## Stop
|
||
|
|
|
||
|
|
`raise/Stop`
|
||
|
|
|
||
|
|
Raises the specified node / scene loop exception
|
||
|
|
to stop execution of the current graph
|
||
|
|
|
||
|
|
**Inputs**
|
||
|
|
|
||
|
|
| Input | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| `state` | `any` | The current state |
|
||
|
|
| `exception` | `any` | (optional) The exception to raise |
|
||
|
|
|
||
|
|
**Outputs**
|
||
|
|
|
||
|
|
| Output | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| `state` | `any` | The current state |
|
||
|
|
|
||
|
|
**Properties**
|
||
|
|
|
||
|
|
| Property | Type | Default | Description |
|
||
|
|
| --- | --- | --- | --- |
|
||
|
|
| `exception` | `str` | `"StopGraphExecution"` | Exception. Choices: `StopGraphExecution`, `StopModule`, `LoopBreak`, `LoopContinue`, `LoopExit`, `ExitScene`, `RestartSceneLoop`, `ResetScene`, `StageExit`. |
|