funkin.ui.freeplay.charselect.PlayableCharacter

An object used to retrieve data about a playable character (also known as "weeks"). Can be scripted to override each function, for custom behavior.

Constructor

`new(id:String, ?params:Dynamic)`

Parameters:

`id`	The ID of the JSON file to parse.

Variables

`final_data:Null<PlayerData>`

`finalid:String`

Methods

`_fetchData(id:String):Null<PlayerData>`

`destroy():Void`

`getCharSelectData():Null<PlayerCharSelectData>`

`getFreeplayDJData():Null<PlayerFreeplayDJData>`

`getFreeplayDJText(index:Int):String`

`getFreeplayStyleID():String`

`getName():String`

Retrieve the readable name of the playable character.

`getOwnedCharacterIds():Array<String>`

Retrieve the list of stage character IDs associated with this playable character.

Returns:

The list of associated character IDs

`getResultsAnimationDatas(rank:ScoringRank):Array<PlayerResultsAnimationData>`

Parameters:

`rank`	Which rank to get info for

Returns:

An array of animations. For example, BF Great has two animations, one for BF and one for GF

`getResultsMusicPath(rank:ScoringRank):String`

`getStickerPackID():String`

`isUnlocked():Bool`

Returns whether this character is unlocked.

`shouldShowCharacter(id:String):Bool`

`shouldShowUnownedChars():Bool`

Return true if, when this character is selected in Freeplay, songs unassociated with a specific character should appear.

class PlayableCharacter

package funkin.ui.freeplay.charselect

implements IRegistryEntry<PlayerData>

extended by ScriptedPlayableCharacter