scene

This package implements a lightweight scene manager. It streamlines the game loop by mapping directory names to scene enums.

Features:

• Auto-generated enums: The SceneName enum from the bonsai:generated package is generated automatically based on directories found in source/game/scenes.
• Lifecycle management: Standardized hooks for init, update, draw and exit.
• State persistence: Data is passed between procedures via a rawptr to a state array.
• Simple navigation: Specific change function to handle transitions, changing on the next frame to allow cleanup within the exit function.

Usage

To create a new scene, create a directory in source/game/sources and include the following code:

package scene_name // Name the package accordingly

// Cast the rawptr to your specific Data state struct
init :: proc(data: rawptr) {
  // state := (^Data)(data)
}

update :: proc(data: rawptr) {
  // state := (^Data)(data)
}

draw :: proc(data: rawptr) {
  // state := (^Data)(data)
}

exit :: proc(data: rawptr) {
  // state := (^Data)(data)
}

Then, in your main game.odin file:

init :: proc() {
  // Initialize with the starting scene enum
  scene.init(.mainmenu)
}

update :: proc() {
  scene.update()
}

draw :: proc() {
  scene.draw()
}

---

change

change :: proc (sceneName: generated.SceneName)

Queues a transition to a new scene. The actual transition occurs at the start of the next frame.

---

draw

draw :: proc ()

Calls the draw procedure of the currently active scene.

---

init

init :: proc (sceneName: generated.SceneName)

Bootstraps the Scene Manager with the starting scene. Immediately initializes and sets the current scene. Accepts a SceneName enum as an argument.

---

update

update :: proc ()

Main update loop for the active scene. Handles the lifecycle of scene transitions automatically.

---