View source

class NoteStyle

package funkin.play.notes.notestyle

implements IRegistryEntry<NoteStyleData>

extended by ScriptedNoteStyle

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

Available on all platforms

Holds the data for what assets to use for a note style, and provides convenience methods for building sprites based on them.

Constructor

new(id:String, ?params:Dynamic)

Parameters:

id

The ID of the JSON file to parse.

Variables

final_data:NoteStyleData

Note style data as parsed from the JSON file.

finalid:String

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>

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>

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

Get the author of the note style.

Returns:

String

getComboNumSpriteOffsets(digit:Int):Array<Float>

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

getCountdownSpriteOffsets(step:CountdownStep):Array<Float>

getFallbackID():Null<String>

Get the note style ID of the parent note style.

Returns:

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

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

getHoldCoverOffsets():Array<Float>

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

getHoldNoteOffsets():Array<Float>

getJudgementSpriteOffsets(rating:String):Array<Float>

getName():String

Get the readable name of the note style.

Returns:

String

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

getNoteOffsets():Array<Float>

getNoteScale():Float

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

getSplashFramerate():Int

getSplashFramerateVariance():Int

getSplashOffsets():Array<Float>

getSplashScale():Float

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

toString():String