View source

class PlayStatePlaylist

package funkin.play

@:directlyUsed@:nullSafety

Available on all platforms

Manages playback of multiple songs in a row.

TODO: Add getters/setters for all these properties to validate them.

Static variables

@:value(Constants.DEFAULT_DIFFICULTY)staticcampaignDifficulty:String = Constants.DEFAULT_DIFFICULTY

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

The internal ID of the current playlist, for example week4 or weekend-1.

@:value(0)staticcampaignScore:Int = 0

The cumulative score for all the songs in the playlist.

@:value("UNKNOWN")staticcampaignTitle:String = "UNKNOWN"

The title of this playlist, for example Week 4 or Weekend 1.

@:value(false)staticisStoryMode:Bool = false

Whether the game is currently in Story Mode. If false, we are in Freeplay Mode.

@:value([])staticplaylistSongIds:Array<String> = []

The list of upcoming songs to be played. When the user completes a song in Story Mode, the first entry in this list is played. When this list is empty, move to the Results screen instead.

Static methods

staticreset():Void

Resets the playlist to its default state.