class ScriptedFreeplayStyle
package funkin.ui.freeplay
extends FreeplayStyle
implements HScriptedClass
Available on all platforms
A script that can be tied to a Freeplay style. Create a scripted class that extends FreeplayStyle to use this. This allows you to customize how a specific style works.
Static methods
staticinit(clsName:String, id:String, ?params:Dynamic):ScriptedFreeplayStyle
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.
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
Methods
getBgAssetGraphic():FlxGraphic
Polymod HScriptedClass override of getBgAssetGraphic.
Get the background art as a graphic, ready to apply to a sprite.
Returns:
The built graphic
getBgAssetKey():String
Polymod HScriptedClass override of getBgAssetKey.
Get the asset key for the background.
Returns:
The asset key
getCapsuleAssetKey():String
Polymod HScriptedClass override of getCapsuleAssetKey.
Get the asset key for the number assets.
Returns:
The asset key
getCapsuleDeselCol():FlxColor
Polymod HScriptedClass override of getCapsuleDeselCol.
Return the deselected color of the text outline for freeplay capsules.
Returns:
The deselected color
getCapsuleSelCol():FlxColor
Polymod HScriptedClass override of getCapsuleSelCol.
Return the selected color of the text outline for freeplay capsules.
Returns:
The selected color
getNumbersAssetKey():String
Polymod HScriptedClass override of getNumbersAssetKey.
Get the asset key for the capsule art.
Returns:
The asset key
getSelectorAssetKey():String
Polymod HScriptedClass override of getSelectorAssetKey.
Get the asset key for the background.
Returns:
The asset key
getStartDelay():Float
Polymod HScriptedClass override of getStartDelay.
Return the song selection transition delay.
Returns:
The start delay
scriptCall(funcName:String, ?funcArgs:Array<Dynamic>):Dynamic
Calls a function of the scripted class with the given name and arguments.
scriptSet(varName:String, ?varValue:Dynamic):Dynamic
Directly modifies the value of a local variable of a scripted class.