package funkin; import flixel.graphics.frames.FlxAtlasFrames; import animate.FlxAnimateFrames; import funkin.graphics.FunkinSprite.AtlasSpriteSettings; import openfl.utils.AssetType; import funkin.util.macro.ConsoleMacro; import haxe.io.Path; /** * A core class which handles determining asset paths. */ @:nullSafety class Paths implements ConsoleClass { static var currentLevel:Null = null; public static function setCurrentLevel(name:Null):Void { if (name == null) { currentLevel = null; } else { currentLevel = name.toLowerCase(); } } public static function stripLibrary(path:String):String { var parts:Array = path.split(':'); if (parts.length < 2) return path; return parts[1]; } public static function getLibrary(path:String):String { var parts:Array = path.split(':'); if (parts.length < 2) return 'preload'; return parts[0]; } static function getPath(file:String, type:AssetType, library:Null):String { if (library != null) return getLibraryPath(file, library); if (currentLevel != null) { var levelPath:String = getLibraryPathForce(file, currentLevel); if (Assets.exists(levelPath, type)) return levelPath; } var levelPath:String = getLibraryPathForce(file, 'shared'); if (Assets.exists(levelPath, type)) return levelPath; return getPreloadPath(file); } public static function getLibraryPath(file:String, library = 'preload'):String { return if (library == 'preload' || library == 'default') getPreloadPath(file); else getLibraryPathForce(file, library); } static inline function getLibraryPathForce(file:String, library:String):String { return '$library:assets/$library/$file'; } static inline function getPreloadPath(file:String):String { return 'assets/$file'; } public static function file(file:String, type:AssetType = TEXT, ?library:String):String { return getPath(file, type, library); } public static function animateAtlas(path:String, ?library:String):String { return getLibraryPath('images/$path', library); } public static function txt(key:String, ?library:String):String { return getPath('data/$key.txt', TEXT, library); } public static function frag(key:String, ?library:String):String { return getPath('shaders/$key.frag', TEXT, library); } public static function vert(key:String, ?library:String):String { return getPath('shaders/$key.vert', TEXT, library); } public static function xml(key:String, ?library:String):String { return getPath('data/$key.xml', TEXT, library); } public static function json(key:String, ?library:String):String { return getPath('data/$key.json', TEXT, library); } public static function srt(key:String, ?library:String, ?directory:String = 'data/'):String { return getPath('$directory$key.srt', TEXT, library); } public static function sound(key:String, ?library:String):String { return getPath('sounds/$key.${Constants.EXT_SOUND}', SOUND, library); } public static function soundRandom(key:String, min:Int, max:Int, ?library:String):String { return sound(key + FlxG.random.int(min, max), library); } public static function music(key:String, ?library:String):String { return getPath('music/$key.${Constants.EXT_SOUND}', MUSIC, library); } public static function videos(key:String, ?library:String):String { final path:Path = new Path(key); if (path.ext != null) { return getPath('videos/${path.file}.${path.ext}', BINARY, library ?? 'videos'); } return getPath('videos/$key.${Constants.EXT_VIDEO}', BINARY, library ?? 'videos'); } public static function voices(song:String, ?suffix:String = ''):String { if (suffix == null) suffix = ''; // no suffix, for a sorta backwards compatibility with older-ish voice files return 'songs:assets/songs/${song.toLowerCase()}/Voices$suffix.${Constants.EXT_SOUND}'; } /** * Gets the path to an `Inst.mp3/ogg` song instrumental from songs:assets/songs/`song`/ * @param song name of the song to get instrumental for * @param suffix any suffix to add to end of song name, used for `-erect` variants usually * @param withExtension if it should return with the audio file extension `.mp3` or `.ogg`. * @return String */ public static function inst(song:String, ?suffix:String = '', withExtension:Bool = true):String { var ext:String = withExtension ? '.${Constants.EXT_SOUND}' : ''; return 'songs:assets/songs/${song.toLowerCase()}/Inst$suffix$ext'; } public static function image(key:String, ?library:String):String { return getPath('images/$key.png', IMAGE, library); } public static function font(key:String):String { return 'assets/fonts/$key'; } public static function ui(key:String, ?library:String):String { return xml('ui/$key', library); } public static function getSparrowAtlas(key:String, ?library:String):FlxAtlasFrames { return FlxAtlasFrames.fromSparrow(image(key, library), file('images/$key.xml', library)); } public static function getAnimateAtlas(key:String, ?library:String, settings:AtlasSpriteSettings):FlxAnimateFrames { var assetLibrary:String = library ?? ''; var graphicKey:String = ''; if (assetLibrary != '') { graphicKey = Paths.animateAtlas(key, assetLibrary); } else { graphicKey = Paths.animateAtlas(key); } var validatedSettings:AtlasSpriteSettings = { swfMode: settings?.swfMode ?? false, cacheOnLoad: settings?.cacheOnLoad ?? false, filterQuality: settings?.filterQuality ?? MEDIUM, spritemaps: settings?.spritemaps ?? null, metadataJson: settings?.metadataJson ?? null, cacheKey: settings?.cacheKey ?? null, uniqueInCache: settings?.uniqueInCache ?? false, onSymbolCreate: settings?.onSymbolCreate ?? null, applyStageMatrix: settings?.applyStageMatrix ?? false, useRenderTexture: settings?.useRenderTexture ?? false }; // Validate asset path. if (!Assets.exists('${graphicKey}/Animation.json')) { throw 'No Animation.json file exists at the specified path (${graphicKey})'; } return FlxAnimateFrames.fromAnimate(graphicKey, validatedSettings.spritemaps, validatedSettings.metadataJson, validatedSettings.cacheKey, validatedSettings.uniqueInCache, { swfMode: validatedSettings.swfMode, cacheOnLoad: validatedSettings.cacheOnLoad, filterQuality: validatedSettings.filterQuality, onSymbolCreate: validatedSettings.onSymbolCreate }); } public static function getPackerAtlas(key:String, ?library:String):FlxAtlasFrames { return FlxAtlasFrames.fromSpriteSheetPacker(image(key, library), file('images/$key.txt', library)); } } enum abstract PathsFunction(String) { public var MUSIC; public var INST; public var VOICES; public var SOUND; }