class ScriptedAlbum
package funkin.ui.freeplay
extends Album
implements HScriptedClass
Available on all platforms
A script that can be tied to an Album. Create a scripted class that extends Album to use this. This allows you to customize how a specific album appears.
Static methods
staticinit(clsName:String, id:String, ?params:Dynamic):ScriptedAlbum
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
getAlbumArtAssetKey():String
Polymod HScriptedClass override of getAlbumArtAssetKey.
Get the asset key for the album art.
Returns:
The asset key
getAlbumArtGraphic():FlxGraphic
Polymod HScriptedClass override of getAlbumArtGraphic.
Get the album art as a graphic, ready to apply to a sprite.
Returns:
The built graphic
getAlbumArtists():Array<String>
Polymod HScriptedClass override of getAlbumArtists.
Return the artists of the album.
Returns:
The list of artists
getAlbumName():String
Polymod HScriptedClass override of getAlbumName.
Return the name of the album. @
getAlbumTitleAnimations():Array<AnimationData>
Polymod HScriptedClass override of getAlbumTitleAnimations.
getAlbumTitleAssetKey():String
Polymod HScriptedClass override of getAlbumTitleAssetKey.
Get the asset key for the album title.
getAlbumTitleOffsets():Null<Array<Float>>
Polymod HScriptedClass override of getAlbumTitleOffsets.
Get the offsets for the album title.
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.