WalrusFSM

Description

WalrusFSM is an easy to use and robust Finite State Machine library for GameMaker Studio 2.3+.

itch.io | GitHub | Discord Server

Finite state machines are structures that can exist in a set amount of predefined states that contain unique behaviors. While finite state machines are used very commonly in game development, GameMaker does not have a built-in way of setting them up easily. This library allows you to set up your own finite state machines with minimal effort and helps you keep them all organized.

// The states as an enum.
enum test_state {
    example1,
    example2,
}

// Create the finite state machine.
state_machine = new StateMachine();

// Create state 1.
var _state1 = new State();

// Set the code that will be executed at the step event.
_state1.update = function() {
    x += 4;
    if (x > room_width)
        x = -256
}

// Create state 2.
var _state2 = new State();

// Set the code that will be executed at the step event.
_state2.update = function() {
    x -= 4;
    if (x < -256)
        x = room_width
}

// Add the states to the finite state machine.
state_machine.add(test_state.example1, _state1);
state_machine.add(test_state.example2, _state2);

This library comes with 12 public methods for the StateMachine struct.

• add(index, state)
• remove(index)
• update()
• draw()
• change(index)
• next()
• reset()
• get()
• count()
• timer()
• clear()
• destroy()

There are also 4 overridable methods for the State struct that are by default empty.

• on_enter()
• on_leave()
• update()
• draw()

This library is only tested on Windows and HTML5 platforms, but it should also work on other platforms as well. It also comes with an example project that will teach you the basics.

The entirety of this project is licensed under MPL 2.0, so please give me credit if you end up using it.

If you have any questions, you can ask them on this project's itch.io page or at my Discord Server.

End User Licence Agreement (EULA).

Age Rating: 4+