funkin.play.character

Friday Night Funkin' API Reference

..
AnimateAtlasCharacter

An AnimateAtlasCharacter is a Character which is rendered by displaying an animation derived from an Adobe Animate texture atlas spritesheet file.

BaseCharacter

A Character is a stage prop which bops to the music as well as controlled by the strumlines.

CharacterType

The type of a given character sprite. Defines its default behaviors.

MultiAnimateAtlasCharacter

This render type is the most complex, and is used by characters which use multiple Adobe Animate texture atlases. This render type concatenates multiple texture atlases into a single sprite.

MultiSparrowCharacter

For some characters which use Sparrow atlases, the spritesheets need to be split into multiple files. This character renderer concatenates these together into a single sprite.

PackerCharacter

A PackerCharacter is a Character which is rendered by displaying an animation derived from a Packer spritesheet file.

ScriptedAnimateAtlasCharacter

A script that can be tied to an AnimateAtlasCharacter, which persists across states. Create a scripted class that extends AnimateAtlasCharacter, then call super('charId') in the constructor to use this.

ScriptedBaseCharacter

A script that can be tied to a BaseCharacter, which persists across states. Create a scripted class that extends BaseCharacter to use this. Note: Making a scripted class extending BaseCharacter is not recommended. Do so ONLY if are handling all the character rendering yourself, and can't use one of the built-in render modes.

ScriptedMultiAnimateAtlasCharacter

A script that can be tied to a MultiAnimateAtlasCharacter, which persists across states. Create a scripted class that extends MultiAnimateAtlasCharacter, then call super('charId') in the constructor to use this.

ScriptedMultiSparrowCharacter

A script that can be tied to a MultiSparrowCharacter, which persists across states. Create a scripted class that extends MultiSparrowCharacter, then call super('charId') in the constructor to use this.

ScriptedPackerCharacter

A script that can be tied to a PackerCharacter, which persists across states. Create a scripted class that extends PackerCharacter, then call super('charId') in the constructor to use this.

ScriptedSparrowCharacter

A script that can be tied to a SparrowCharacter, which persists across states. Create a scripted class that extends SparrowCharacter, then call super('charId') in the constructor to use this.

SparrowCharacter

A SparrowCharacter is a Character which is rendered by displaying an animation derived from a SparrowV2 atlas spritesheet file.