Skip to content
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.

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

Added notes to caveats #296

Merged
merged 5 commits into from
Oct 10, 2024
Merged

Conversation

albertok
Copy link
Contributor

@albertok albertok commented Oct 9, 2024

Updating docs with some notes on caveats based on recent chats


### State Machines

Many state machine addons don't expect to be updated multiple times in a frame. Beware of safeguards that prevent state backtracking quickly or basing the state on a value that is not updated in `_rollback_tick`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please also add a note about state transitions? Also many state machine implementations treat any state change as a transition, even if that's the rollback applying an earlier state.

@elementbound elementbound merged commit 64f2f3f into foxssake:main Oct 10, 2024
@albertok albertok deleted the caveat-doc-update branch October 12, 2024 05:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants