Skip to content

add wildcard support for transitions and state config validation #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gaggioaxel wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add wildcard support for transitions and state config validation #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified FsmTD.tox
View file
Open in desktop
Binary file not shown.
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,16 @@ Requires a single column: `state_name`. List all possible states here.

### Transitions Table
Requires four columns: `source`, `event`, `target`, and `timeout`.
* `source`: The state you are leaving.
* `source`: The state you are leaving. Supports wildcard `*` (allows transitioning from any state to the target state). Wildcard transitions have the highest priority.
* `event`: The trigger required to leave.
* `target`: The destination state.
* `timeout`: (Optional) Float value in seconds. The FSM will automatically trigger the transition after this time elapses.

## ⚠️ State Validation & Error Handling
To help you build and debug your FSM, the component validates your configuration tables on load:
* **Missing Source State**: If a source state in the transitions table does not exist in the states table, a **warning** is raised. (Note: The wildcard `*` is a valid source state).
* **Missing Target State**: If a target state in the transitions table does not exist in the states table, an **error** is raised to prevent entering undefined states.

## 🤝 Contributing
Pull requests are welcome! If you build something cool with this, let me know and remember to mention us.
Feel free to open issues for bug reports, feature requests, or just to say hi!
Expand Down