View source

class PlayerData

package funkin.data.freeplay.player

@:directlyUsed@:nullSafety

Available on all platforms

Constructor

new()

Variables

@:value(null)@:optionaloptionalcharSelect:Null<PlayerCharSelectData> = null

Data for displaying this character in the Character Select menu. If null, exclude from Character Select.

@:value(null)@:optionaloptionalfreeplayDJ:Null<PlayerFreeplayDJData> = null

Data for displaying this character in the Freeplay menu. If null, display no DJ.

@:value(Constants.DEFAULT_FREEPLAY_STYLE)@:optional@:default("bf")optionalfreeplayStyle:String = Constants.DEFAULT_FREEPLAY_STYLE

Which freeplay style to use for this character.

@:value("Unknown")name:String = "Unknown"

A readable name for this playable character.

@:value([])@:default([])ownedChars:Array<String> = []

The character IDs this character is associated with. Only songs that use these characters will show up in Freeplay.

@:value(null)@:optionaloptionalresults:Null<PlayerResultsData> = null

Data for displaying this character in the results screen.

@:value(false)@:optional@:default(false)optionalshowUnownedChars:Bool = false

Whether to show songs with character IDs that aren't associated with any specific character.

@:value(Constants.DEFAULT_STICKER_PACK)@:optional@:default(funkin.util.Constants.DEFAULT_STICKER_PACK)optionalstickerPack:String = Constants.DEFAULT_STICKER_PACK

The default sticker pack to use for songs featuring this playable character. Can be overridden by specific songs.

@:value(true)@:optional@:default(true)optionalunlocked:Bool = true

Whether this character is unlocked by default. Use a ScriptedPlayableCharacter to add custom logic.

@:default(funkin.data.freeplay.player.PlayerRegistry.PLAYER_DATA_VERSION)version:String

The sematic version number of the player data JSON format. Supports fancy comparisons like NPM does it's neat.

Methods

@:value({ pretty : true })serialize(pretty:Bool = true):String

Convert this StageData into a JSON string.

updateVersionToLatest():Void