song_select_script

SongSelectScript is the Lua script interface for the song_select screen. It allows skins to define custom footer strips and state-aware overlays through the skin's Lua scripting layer.

It uses the script library (sol2) to call named functions on a Lua object defined in the skin.

SongSelectScript

SongSelectScript();

Loads the Lua object from the skin script environment and binds the update, restart_text_fade, draw_footer, and draw_overlays functions.

Methods

void update(double current_ms);

Calls the Lua update function, passing the current time in milliseconds. Used for advancing script-driven animations.

void restart_text_fade();

Calls the Lua restart_text_fade function. Invoked by the scene when the song selection state changes so the skin can reset any text fade-in effects.

void draw_footer();

Calls the Lua draw_footer function. Drawn by the song_select scene after the box strip and before the player UI, providing a skin-defined decorative strip at the bottom of the screen.

void draw_overlays(int state);

Calls the Lua draw_overlays function, passing the current SongSelectState as an integer. Allows the skin to draw state-specific overlays (e.g. different decorations while a song is selected versus while browsing).