View source

class PlayerRegistry

package funkin.data.freeplay.player

extends BaseRegistry_funkin_ui_freeplay_charselect_PlayableCharacter_funkin_data_freeplay_player_PlayerData_funkin_data_freeplay_player_PlayerEntryParams

implements DefaultRegistryImpl, ISingleton

@:directlyUsed@:funkinProcessed@:build(funkin.util.macro.RegistryMacro.buildRegistry())@:autoBuild(funkin.util.macro.RegistryMacro.buildRegistry())@:build(funkin.util.macro.SingletonMacro.build())@:autoBuild(funkin.util.macro.SingletonMacro.build())@:nullSafety

Available on all platforms

Static variables

@:value("1.0.0")staticfinalread onlyPLAYER_DATA_VERSION:Version = "1.0.0"

The current version string for the stage data format. Handle breaking changes by incrementing this value and adding migration to the migratePlayerData() function.

@:value("1.0.x")staticfinalread onlyPLAYER_DATA_VERSION_RULE:VersionRule = "1.0.x"

staticread onlyinstance:PlayerRegistry

Constructor

new()

Methods

countUnlockedCharacters():Int

getCharacterOwnerId(characterId:Null<String>):Null<String>

Get the playable character associated with a given stage character.

Parameters:

characterId

The stage character ID.

Returns:

The playable character.

hasNewCharacter():Bool

isCharacterOwned(characterId:String):Bool

Return true if the given stage character is associated with a specific playable character. If so, the level should only appear if that character is selected in Freeplay. NOTE: This is NOT THE SAME as player.isUnlocked()!

Parameters:

characterId

The stage character ID.

Returns:

Whether the character is owned by any one character.

isCharacterSeen(characterId:String):Bool

Parameters:

characterId

The character ID to check.

Returns:

Whether the player saw the character unlock animation in Character Select.

listBaseGameEntryIds():Array<String>

listModdedEntryIds():Array<String>

listNewCharacters():Array<String>