Funkin/source/funkin/ui/freeplay/Album.hx

package funkin.ui.freeplay;

import funkin.data.freeplay.album.AlbumData;
import funkin.data.freeplay.album.AlbumRegistry;
import funkin.data.animation.AnimationData;
import funkin.data.IRegistryEntry;
import flixel.graphics.FlxGraphic;

/**
 * A class representing the data for an album as displayed in Freeplay.
 */
@:nullSafety
class Album implements IRegistryEntry<AlbumData>
{
  public function new(id:String, ?params:Dynamic)
  {
    this.id = id;
    this._data = _fetchData(id);

    if (_data == null)
    {
      throw 'Could not parse album data for id: $id';
    }
  }

  /**
   * Return the name of the album.
   * @
   */
  public function getAlbumName():String
  {
    return _data?.name ?? "Unknown";
  }

  /**
   * Return the artists of the album.
   * @return The list of artists
   */
  public function getAlbumArtists():Array<String>
  {
    return _data?.artists ?? ["None"];
  }

  /**
   * Get the asset key for the album art.
   * @return The asset key
   */
  public function getAlbumArtAssetKey():String
  {
    return _data?.albumArtAsset ?? 'freeplay/albumRoll/volume1"';
  }

  /**
   * Get the album art as a graphic, ready to apply to a sprite.
   * @return The built graphic
   */
  public function getAlbumArtGraphic():FlxGraphic
  {
    return FlxG.bitmap.add(Paths.image(getAlbumArtAssetKey()));
  }

  /**
   * Get the asset key for the album title.
   */
  public function getAlbumTitleAssetKey():String
  {
    return _data?.albumTitleAsset ?? "freeplay/albumRoll/volume1-text";
  }

  /**
   * Get the offsets for the album title.
   */
  public function getAlbumTitleOffsets():Null<Array<Float>>
  {
    return _data?.albumTitleOffsets ?? [0, 0];
  }

  public function hasAlbumTitleAnimations():Bool
  {
    if (_data == null || _data.albumTitleAnimations == null) return false;
    return _data.albumTitleAnimations.length > 0;
  }

  public function getAlbumTitleAnimations():Array<AnimationData>
  {
    return _data?.albumTitleAnimations ?? [];
  }
}