funkin.ui.freeplay.charselect.ScriptedPlayableCharacter

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

Static methods

`staticinit(clsName:String, id:String, ?params:Dynamic):ScriptedPlayableCharacter`

Initializes a scripted class instance using the given scripted class name and constructor arguments.

`staticlistScriptClasses():Array<String>`

Returns a list of all the scripted classes which extend this class.

`staticscriptStaticCall(clsName:String, funcName:String):Dynamic`

Call a custom static function on a scripted class, by the given name, with the given arguments.

`staticscriptStaticGet(clsName:String, fieldName:String):Dynamic`

Retrieves a custom static variable on a scripted class, by the given name.

`@:value({ fieldValue : null })staticscriptStaticSet(clsName:String, fieldName:String, ?fieldValue:Dynamic):Dynamic`

Sets the value of a custom static variable on a scripted class, by the given name.

Constructor

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

Methods

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

Polymod HScriptedClass override of _fetchData.

`destroy():Void`

Polymod HScriptedClass override of destroy.

`getCharSelectData():Null<PlayerCharSelectData>`

Polymod HScriptedClass override of getCharSelectData.

`getFreeplayDJData():Null<PlayerFreeplayDJData>`

Polymod HScriptedClass override of getFreeplayDJData.

`getFreeplayDJText(index:Int):String`

Polymod HScriptedClass override of getFreeplayDJText.

`getFreeplayStyleID():String`

Polymod HScriptedClass override of getFreeplayStyleID.

`getName():String`

Polymod HScriptedClass override of getName.

Retrieve the readable name of the playable character.

`getOwnedCharacterIds():Array<String>`

Polymod HScriptedClass override of getOwnedCharacterIds.

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

Returns:

The list of associated character IDs

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

Polymod HScriptedClass override of getResultsAnimationDatas.

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`

Polymod HScriptedClass override of getResultsMusicPath.

`getStickerPackID():String`

Polymod HScriptedClass override of getStickerPackID.

`isUnlocked():Bool`

Polymod HScriptedClass override of isUnlocked.

Returns whether this character is unlocked.

`@:value({ funcArgs : null })scriptCall(funcName:String, ?funcArgs:Array<Dynamic>):Dynamic`

Calls a function of the scripted class with the given name and arguments.

`scriptGet(varName:String):Dynamic`

Retrieves the value of a local variable of a scripted class.

`@:value({ varValue : null })scriptSet(varName:String, ?varValue:Dynamic):Dynamic`

Directly modifies the value of a local variable of a scripted class.

`shouldShowCharacter(id:String):Bool`

Polymod HScriptedClass override of shouldShowCharacter.

`shouldShowUnownedChars():Bool`

Polymod HScriptedClass override of shouldShowUnownedChars.

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

class ScriptedPlayableCharacter

package funkin.ui.freeplay.charselect

extends PlayableCharacter

implements HScriptedClass