Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anthonyec/godot_state_machine
🤖 Simple code only finite state machine for Godot
https://github.com/anthonyec/godot_state_machine
addon fsm godot state
Last synced: about 2 months ago
JSON representation
🤖 Simple code only finite state machine for Godot
- Host: GitHub
- URL: https://github.com/anthonyec/godot_state_machine
- Owner: anthonyec
- Created: 2023-06-14T10:15:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-25T00:04:25.000Z (about 1 year ago)
- Last Synced: 2024-11-01T17:05:27.623Z (3 months ago)
- Topics: addon, fsm, godot, state
- Language: GDScript
- Homepage:
- Size: 8.79 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Godot State Machine
Simple code only state machine that's is originally based off [GDQuest's implementation](https://www.gdquest.com/tutorial/godot/design-patterns/finite-state-machine/).
## Features (or problems)
- States are nodes
- Nested states, but only 1 level (parent and child)
- Support for deferred state transitions
- Bulk of the logic is in one file (under 200 lines)
## Usage
### State node
```gdscript
# Invoked when transitioning to this state. Used for setup and
# handling any paramaters passed from the previous state.
func enter(params: Dictionary) -> void:
pass
# Invoked when transitioning to another state. Generally used
# for cleanup, it also will yield if `await` is used inside of it.
func exit() -> void:
pass
# Equivalent to `_ready`.
func awake() -> void:
pass
# Equivalent to `_process`.
func update(delta: float) -> void:
pass
# Equivalent to `_physics_process`.
func physics_update(delta: float) -> void:
pass
# Equivalent to `_input`.
func handle_input(event: InputEvent) -> void:
pass
# Handle messages that have been sent to the state machine.
#
# This is usefull for when something external wants to change
# the state, but avoids forefully transitioning by using
# `transition_to` directly.
func handle_message(title: String, _params: Dictionary) -> void:
pass
```
### Transition to a state
```gdscript
# Transition to a state using the name of the node.
state_machine.transition_to("Jump")
# Additional parameters can be passed along to the next state, which helps avoids globals.
state_machine.transition_to("Jump", {
"height": 100
})
```
### Deffered transition
```gdscript
# This will queue a state change, waiting for one physics frame to have been completed before transitioning.
state_machine.deffered_transition_to("Jump")
# Parameters are passed as a callback to ensure that when the transition occurs, any variable references in the params are the latest values.
state_machine.deffered_transition_to("Jump", func():
return {
"velocity": velocity
}
)
```
### Transition to the previous state
```gdscript
# Transition to whatever previous state invoked the current state.
state_machine.transition_to_previous_state()
```