funkin.ui

Friday Night Funkin' API Reference

..
charSelect
credits
freeplay
haxeui
mainmenu
options
story
title
transition
AtlasAsset

AtlasChar

AtlasFont

AtlasMenuItem

A menu list item which uses single texture atlas.

AtlasMenuList

A menulist whose items share a single texture atlas.

AtlasText

AtlasText is an improved version of Alphabet and FlxBitmapText. It supports animations on the letters, and is less buggy than Alphabet.

ButtonStyle

Case

Codex

The Codex class is what holds our Page objects together. Apologies for the potentially obtuse quirky name. Codex stands for "Collection Of Pages ex"... imagine P is rotated 180 degress now its a d :) I just wanted something not called "PageManager" grr...

FullScreenScaleMode

MenuItem

MenuListItem

MenuTypedItem

MenuTypedList

MusicBeatState

MusicBeatState actually represents the core utility FlxState of the game. It includes functionality for event handling, as well as maintaining BPM-based update events.

MusicBeatSubState

MusicBeatSubState reincorporates the functionality of MusicBeatState into an FlxSubState.

NavControls

Page

A page in a menu system.

PageName

For you to fill in your own page name stuff, see OptionsState.hx and it's OptionsMenuPageName

PixelatedIcon

The icon that gets used for Freeplay capsules and char select NOT to be confused with the CharIcon class, which is for the in-game icons

Prompt

Opens a yes/no dialog box as a substate over the current state.

ScriptedMusicBeatState

A script that can be tied to a MusicBeatState. Create a scripted class that extends MusicBeatState to use this.

ScriptedMusicBeatSubState

A script that can be tied to a MusicBeatSubState. Create a scripted class that extends MusicBeatSubState to use this.

TextMenuItem

TextMenuList

TextTypedMenuItem

UIState

Simple state machine for UI components Replaces scattered boolean flags with clean state management

UIStateMachine

Note: Not to be confust with FlxState or FlxSubState! State as in the design pattern! https://refactoring.guru/design-patterns/state

WeekType

WrapMode