funkin.play.notes.notestyle.ScriptedNoteStyle

A script that can be tied to a NoteStyle. Create a scripted class that extends NoteStyle to use this. This allows you to customize how a specific note style appears.

Static methods

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

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

`applyStrumlineAnimations(target:StrumlineNote, dir:NoteDirection):Void`

Polymod HScriptedClass override of applyStrumlineAnimations.

`applyStrumlineFrames(target:StrumlineNote):Void`

Polymod HScriptedClass override of applyStrumlineFrames.

`applyStrumlineOffsets(target:StrumlineNote):Void`

Polymod HScriptedClass override of applyStrumlineOffsets.

`buildComboNumSprite(digit:Int):Null<FunkinSprite>`

Polymod HScriptedClass override of buildComboNumSprite.

`buildComboNumSpritePath(digit:Int):Null<String>`

Polymod HScriptedClass override of buildComboNumSpritePath.

`buildCountdownSprite(step:CountdownStep):Null<FunkinSprite>`

Polymod HScriptedClass override of buildCountdownSprite.

Build a sprite for the given step of the countdown.

Parameters:

`step`

Returns:

A FunkinSprite, or null if no graphic is available for this step.

`buildCountdownSpritePath(step:CountdownStep):Null<String>`

Polymod HScriptedClass override of buildCountdownSpritePath.

`buildHoldCoverSprite(target:NoteHoldCover):Void`

Polymod HScriptedClass override of buildHoldCoverSprite.

`buildJudgementSprite(rating:String):Null<FunkinSprite>`

Polymod HScriptedClass override of buildJudgementSprite.

`buildJudgementSpritePath(rating:String):Null<String>`

Polymod HScriptedClass override of buildJudgementSpritePath.

`buildNoteSprite(target:NoteSprite):Void`

Polymod HScriptedClass override of buildNoteSprite.

`buildSplashSprite(target:NoteSplash):Void`

Polymod HScriptedClass override of buildSplashSprite.

`destroy():Void`

Polymod HScriptedClass override of destroy.

`fetchHoldNoteScale():Float`

Polymod HScriptedClass override of fetchHoldNoteScale.

`getAuthor():String`

Polymod HScriptedClass override of getAuthor.

Get the author of the note style.

Returns:

String

`getComboNumSpriteOffsets(digit:Int):Array<Float>`

Polymod HScriptedClass override of getComboNumSpriteOffsets.

`@:value({ raw : false })@:value({ raw : false })getCountdownSoundPath(step:CountdownStep, raw:Bool = false):Null<String>`

Polymod HScriptedClass override of getCountdownSoundPath.

`getCountdownSpriteOffsets(step:CountdownStep):Array<Float>`

Polymod HScriptedClass override of getCountdownSpriteOffsets.

`getFallbackID():Null<String>`

Polymod HScriptedClass override of getFallbackID.

Get the note style ID of the parent note style.

Returns:

The string ID, or null if there is no parent.

`@:value({ raw : false })@:value({ raw : false })getHoldCoverDirectionAssetPath(direction:NoteDirection, raw:Bool = false):Null<String>`

Polymod HScriptedClass override of getHoldCoverDirectionAssetPath.

`getHoldCoverOffsets():Array<Float>`

Polymod HScriptedClass override of getHoldCoverOffsets.

`@:value({ raw : false })@:value({ raw : false })getHoldNoteAssetPath(raw:Bool = false):Null<String>`

Polymod HScriptedClass override of getHoldNoteAssetPath.

`getHoldNoteOffsets():Array<Float>`

Polymod HScriptedClass override of getHoldNoteOffsets.

`getJudgementSpriteOffsets(rating:String):Array<Float>`

Polymod HScriptedClass override of getJudgementSpriteOffsets.

`getName():String`

Polymod HScriptedClass override of getName.

Get the readable name of the note style.

Returns:

String

`@:value({ raw : false })@:value({ raw : false })getNoteAssetPath(raw:Bool = false):Null<String>`

Polymod HScriptedClass override of getNoteAssetPath.

`getNoteOffsets():Array<Float>`

Polymod HScriptedClass override of getNoteOffsets.

`getNoteScale():Float`

Polymod HScriptedClass override of getNoteScale.

`@:value({ raw : false })@:value({ raw : false })getSplashAssetPath(raw:Bool = false):Null<String>`

Polymod HScriptedClass override of getSplashAssetPath.

`getSplashFramerate():Int`

Polymod HScriptedClass override of getSplashFramerate.

`getSplashFramerateVariance():Int`

Polymod HScriptedClass override of getSplashFramerateVariance.

`getSplashOffsets():Array<Float>`

Polymod HScriptedClass override of getSplashOffsets.

`getSplashScale():Float`

Polymod HScriptedClass override of getSplashScale.

`@:value({ raw : false })@:value({ raw : false })getStrumlineAssetPath(raw:Bool = false):Null<String>`

Polymod HScriptedClass override of getStrumlineAssetPath.

`getStrumlineOffsets():Array<Float>`

Polymod HScriptedClass override of getStrumlineOffsets.

`getStrumlineScale():Float`

Polymod HScriptedClass override of getStrumlineScale.

`isComboNumSpritePixel(digit:Int):Bool`

Polymod HScriptedClass override of isComboNumSpritePixel.

`isCountdownSpritePixel(step:CountdownStep):Bool`

Polymod HScriptedClass override of isCountdownSpritePixel.

`isHoldNoteCoverEnabled():Bool`

Polymod HScriptedClass override of isHoldNoteCoverEnabled.

`isHoldNotePixel():Bool`

Polymod HScriptedClass override of isHoldNotePixel.

`isJudgementSpritePixel(rating:String):Bool`

Polymod HScriptedClass override of isJudgementSpritePixel.

`isNoteAnimated():Bool`

Polymod HScriptedClass override of isNoteAnimated.

`isNoteSplashEnabled():Bool`

Polymod HScriptedClass override of isNoteSplashEnabled.

`isSplashAnimated():Bool`

Polymod HScriptedClass override of isSplashAnimated.

`@: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.

class ScriptedNoteStyle

package funkin.play.notes.notestyle

extends NoteStyle

implements HScriptedClass

Static methods

staticinit(clsName:String, id:String, ?params:Dynamic):ScriptedNoteStyle

staticlistScriptClasses():Array<String>

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

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

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

Constructor

new(id:String, ?params:Dynamic)

Methods

applyStrumlineAnimations(target:StrumlineNote, dir:NoteDirection):Void

applyStrumlineFrames(target:StrumlineNote):Void

applyStrumlineOffsets(target:StrumlineNote):Void

buildComboNumSprite(digit:Int):Null<FunkinSprite>

buildComboNumSpritePath(digit:Int):Null<String>

buildCountdownSprite(step:CountdownStep):Null<FunkinSprite>

buildCountdownSpritePath(step:CountdownStep):Null<String>

buildHoldCoverSprite(target:NoteHoldCover):Void

buildJudgementSprite(rating:String):Null<FunkinSprite>

buildJudgementSpritePath(rating:String):Null<String>

buildNoteSprite(target:NoteSprite):Void

buildSplashSprite(target:NoteSplash):Void

destroy():Void

fetchHoldNoteScale():Float

getAuthor():String

getComboNumSpriteOffsets(digit:Int):Array<Float>

@:value({ raw : false })@:value({ raw : false })getCountdownSoundPath(step:CountdownStep, raw:Bool = false):Null<String>

getCountdownSpriteOffsets(step:CountdownStep):Array<Float>

getFallbackID():Null<String>

@:value({ raw : false })@:value({ raw : false })getHoldCoverDirectionAssetPath(direction:NoteDirection, raw:Bool = false):Null<String>

getHoldCoverOffsets():Array<Float>

@:value({ raw : false })@:value({ raw : false })getHoldNoteAssetPath(raw:Bool = false):Null<String>

getHoldNoteOffsets():Array<Float>

getJudgementSpriteOffsets(rating:String):Array<Float>

getName():String

@:value({ raw : false })@:value({ raw : false })getNoteAssetPath(raw:Bool = false):Null<String>

getNoteOffsets():Array<Float>

getNoteScale():Float

@:value({ raw : false })@:value({ raw : false })getSplashAssetPath(raw:Bool = false):Null<String>

getSplashFramerate():Int

getSplashFramerateVariance():Int

getSplashOffsets():Array<Float>

getSplashScale():Float

@:value({ raw : false })@:value({ raw : false })getStrumlineAssetPath(raw:Bool = false):Null<String>

getStrumlineOffsets():Array<Float>

getStrumlineScale():Float

isComboNumSpritePixel(digit:Int):Bool

isCountdownSpritePixel(step:CountdownStep):Bool

isHoldNoteCoverEnabled():Bool

isHoldNotePixel():Bool

isJudgementSpritePixel(rating:String):Bool

isNoteAnimated():Bool

isNoteSplashEnabled():Bool

isSplashAnimated():Bool

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

scriptGet(varName:String):Dynamic

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

Inherited Variables

Defined by NoteStyle

final_data:NoteStyleData

finalid:String

Inherited Methods

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

`staticlistScriptClasses():Array<String>`

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

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

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

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

`applyStrumlineAnimations(target:StrumlineNote, dir:NoteDirection):Void`

`applyStrumlineFrames(target:StrumlineNote):Void`

`applyStrumlineOffsets(target:StrumlineNote):Void`

`buildComboNumSprite(digit:Int):Null<FunkinSprite>`

`buildComboNumSpritePath(digit:Int):Null<String>`

`buildCountdownSprite(step:CountdownStep):Null<FunkinSprite>`

`buildCountdownSpritePath(step:CountdownStep):Null<String>`

`buildHoldCoverSprite(target:NoteHoldCover):Void`

`buildJudgementSprite(rating:String):Null<FunkinSprite>`

`buildJudgementSpritePath(rating:String):Null<String>`

`buildNoteSprite(target:NoteSprite):Void`

`buildSplashSprite(target:NoteSplash):Void`

`destroy():Void`

`fetchHoldNoteScale():Float`

`getAuthor():String`

`getComboNumSpriteOffsets(digit:Int):Array<Float>`

`@:value({ raw : false })@:value({ raw : false })getCountdownSoundPath(step:CountdownStep, raw:Bool = false):Null<String>`

`getCountdownSpriteOffsets(step:CountdownStep):Array<Float>`

`getFallbackID():Null<String>`

`@:value({ raw : false })@:value({ raw : false })getHoldCoverDirectionAssetPath(direction:NoteDirection, raw:Bool = false):Null<String>`

`getHoldCoverOffsets():Array<Float>`

`@:value({ raw : false })@:value({ raw : false })getHoldNoteAssetPath(raw:Bool = false):Null<String>`

`getHoldNoteOffsets():Array<Float>`

`getJudgementSpriteOffsets(rating:String):Array<Float>`

`getName():String`

`@:value({ raw : false })@:value({ raw : false })getNoteAssetPath(raw:Bool = false):Null<String>`

`getNoteOffsets():Array<Float>`

`getNoteScale():Float`

`@:value({ raw : false })@:value({ raw : false })getSplashAssetPath(raw:Bool = false):Null<String>`

`getSplashFramerate():Int`

`getSplashFramerateVariance():Int`

`getSplashOffsets():Array<Float>`

`getSplashScale():Float`

`@:value({ raw : false })@:value({ raw : false })getStrumlineAssetPath(raw:Bool = false):Null<String>`

`getStrumlineOffsets():Array<Float>`

`getStrumlineScale():Float`

`isComboNumSpritePixel(digit:Int):Bool`

`isCountdownSpritePixel(step:CountdownStep):Bool`

`isHoldNoteCoverEnabled():Bool`

`isHoldNotePixel():Bool`

`isJudgementSpritePixel(rating:String):Bool`

`isNoteAnimated():Bool`

`isNoteSplashEnabled():Bool`

`isSplashAnimated():Bool`

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

`scriptGet(varName:String):Dynamic`

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

`final_data:NoteStyleData`

`finalid:String`