funkin.play

Friday Night Funkin' API Reference

..
character
components
cutscene
event
notes
scoring
song
stage
Countdown

CountdownStep

The countdown step. This can't be an enum abstract because scripts may need it.

GameOverParams

Parameters used to instantiate a GameOverSubState.

GameOverSubState

A substate which renders over the PlayState when the player dies. Displays the player death animation, plays the music, and handles restarting the song.

GitarooPause

PauseMenuEntry

Represents a single entry in the pause menu.

PauseMode

Which set of options the pause menu should display.

PauseSubState

The menu displayed when the Play State is paused.

PauseSubStateParams

Parameters for initializing the PauseSubState.

PlayState

The gameplay state, where all the rhythm gaming happens. SubState so it can be loaded as a child of the chart editor.

PlayStateParams

Parameters used to initialize the PlayState.

PlayStatePlaylist

Manages playback of multiple songs in a row.

ResultScore

ResultState

The state for the results screen after a song or week is finished.

ResultsStateParams

ScoreNum