View source

class SongDifficulty

package funkin.play.song

import funkin.play.song.Song

@:directlyUsed

Available on all platforms

Constructor

new(song:Song, diffId:String, variation:String)

Variables

@:value(null)album:Null<String> = null

@:value(null)characters:SongCharacterData = null

@:value(Constants.DEFAULT_CHARTER)charter:String = Constants.DEFAULT_CHARTER

finaldifficulty:String

The difficulty ID, such as easy or hard.

@:value(0)difficultyRating:Int = 0

@:value(null)divisions:Null<Int> = null

events:Array<SongEventData>

The event chart for this difficulty.

@:value(SongRegistry.DEFAULT_GENERATEDBY)generatedBy:String = SongRegistry.DEFAULT_GENERATEDBY

@:value(false)looped:Bool = false

@:value(Constants.DEFAULT_NOTE_STYLE)noteStyle:String = Constants.DEFAULT_NOTE_STYLE

notes:Array<SongNoteData>

The note chart for this difficulty.

@:value(new SongOffsets())offsets:SongOffsets = new SongOffsets()

@:value(Constants.DEFAULT_SCROLLSPEED)scrollSpeed:Float = Constants.DEFAULT_SCROLLSPEED

finalsong:Song

The parent song for this difficulty.

@:value(Constants.DEFAULT_ARTIST)songArtist:String = Constants.DEFAULT_ARTIST

@:value(Constants.DEFAULT_SONGNAME)songName:String = Constants.DEFAULT_SONGNAME

@:value(Constants.DEFAULT_STAGE)stage:String = Constants.DEFAULT_STAGE

@:value(null)stickerPack:Null<String> = null

@:value([])timeChanges:Array<SongTimeChange> = []

@:value(Constants.DEFAULT_TIMEFORMAT)timeFormat:SongTimeFormat = Constants.DEFAULT_TIMEFORMAT

finalvariation:String

The metadata file that contains this difficulty.

Methods

buildOpponentVoiceList():Array<String>

buildPlayerVoiceList():Array<String>

@:value({ instId : "" })buildVocals(instId:String = ""):VoicesGroup

Create a VoicesGroup, an audio object that can play the vocals for all characters.

Parameters:

charId

The player ID.

Returns:

The generated vocal group.

buildVoiceList():Array<String>

Build a list of vocal files for the given character. Automatically resolves suffixed character IDs (so bf-car will resolve to bf if needed).

Parameters:

id

The character we are about to play.

@:value({ instrumental : "" })cacheInst(instrumental:String = ""):Void

cacheVocals():Void

Cache the vocals for a given character.

Parameters:

id

The character we are about to play.

clearChart():Void

getEvents():Array<SongEventData>

@:value({ instrumental : "" })getInstPath(instrumental:String = ""):String

getStartingBPM():Float

@:value({ looped : false, instId : "", volume : 1.0 })playInst(volume:Float = 1.0, instId:String = "", looped:Bool = false):Void