funkin

Friday Night Funkin' API Reference

..
audio
data
effects
external
graphics
input
mobile
modding
play
ui
util
Assets

A wrapper around openfl.utils.Assets which disallows access to the harmful functions. Later we'll add Funkin-specific caching to this.

Conductor

A core class which handles musical timing throughout the game, both in gameplay and in menus.

FunkinMemory

Handles caching of textures and sounds for the game. TODO: Remove this once Eric finishes the memory system.

Highscore

A core class which handles tracking score and combo for the current song.

InitState

A core class which performs initialization of the game. The initialization state has several functions: - Calls code to set up the game, including loading saves and parsing game data. - Chooses whether to start via debug or via launching normally.

Paths

A core class which handles determining asset paths.

PathsFunction

PlayerSettings

A core class which represents the current player(s) and their controls and other configuration.

Preferences

A core class which provides a store of user-configurable, globally relevant values.

RawTallies

A structure object containing the data for highscore tallies.

Tallies