mirror of
https://github.com/ninjamuffin99/Funkin.git
synced 2024-11-05 06:14:36 +00:00
55 lines
1.5 KiB
Haxe
55 lines
1.5 KiB
Haxe
package funkin.play;
|
|
|
|
/**
|
|
* Manages playback of multiple songs in a row.
|
|
*
|
|
* TODO: Add getters/setters for all these properties to validate them.
|
|
*/
|
|
class PlayStatePlaylist
|
|
{
|
|
/**
|
|
* Whether the game is currently in Story Mode. If false, we are in Free Play Mode.
|
|
*/
|
|
public static var isStoryMode(default, default):Bool = false;
|
|
|
|
/**
|
|
* The loist 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.
|
|
*/
|
|
public static var playlistSongIds:Array<String> = [];
|
|
|
|
/**
|
|
* The cumulative score for all the songs in the playlist.
|
|
*/
|
|
public static var campaignScore:Int = 0;
|
|
|
|
/**
|
|
* The title of this playlist, for example `Week 4` or `Weekend 1`
|
|
*/
|
|
public static var campaignTitle:String = 'UNKNOWN';
|
|
|
|
/**
|
|
* The internal ID of the current playlist, for example `week4` or `weekend-1`.
|
|
*/
|
|
public static var campaignId:String = 'unknown';
|
|
|
|
/**
|
|
* The current difficulty selected for this level (as a named ID).
|
|
*/
|
|
public static var currentDifficulty(default, default):String = Constants.DEFAULT_DIFFICULTY;
|
|
|
|
/**
|
|
* Resets the playlist to its default state.
|
|
*/
|
|
public static function reset():Void
|
|
{
|
|
isStoryMode = false;
|
|
playlistSongIds = [];
|
|
campaignScore = 0;
|
|
campaignTitle = 'UNKNOWN';
|
|
campaignId = 'unknown';
|
|
currentDifficulty = Constants.DEFAULT_DIFFICULTY;
|
|
}
|
|
}
|