2024-03-20 14:37:24 -04:00
|
|
|
package funkin.data.freeplay;
|
|
|
|
|
2024-03-28 01:46:50 -04:00
|
|
|
import funkin.data.animation.AnimationData;
|
|
|
|
|
2024-03-20 14:37:24 -04:00
|
|
|
/**
|
|
|
|
* A type definition for the data for an album of songs.
|
|
|
|
* It includes things like what graphics to display in Freeplay.
|
|
|
|
* @see https://lib.haxe.org/p/json2object/
|
|
|
|
*/
|
|
|
|
typedef AlbumData =
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* Semantic version for album data.
|
|
|
|
*/
|
|
|
|
public var version:String;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Readable name of the album.
|
|
|
|
*/
|
|
|
|
public var name:String;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Readable name of the artist(s) of the album.
|
|
|
|
*/
|
|
|
|
public var artists:Array<String>;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Asset key for the album art.
|
|
|
|
* The album art will be displayed in Freeplay.
|
|
|
|
*/
|
|
|
|
public var albumArtAsset:String;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Asset key for the album title.
|
|
|
|
* The album title will be displayed below the album art in Freeplay.
|
|
|
|
*/
|
|
|
|
public var albumTitleAsset:String;
|
2024-03-28 01:46:50 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* An optional array of animations for the album title.
|
|
|
|
*/
|
|
|
|
@:optional
|
|
|
|
@:default([])
|
|
|
|
public var albumTitleAnimations:Array<AnimationData>;
|
2024-03-20 14:37:24 -04:00
|
|
|
}
|