View source

class Paths

package funkin

implements ConsoleClass

@:directlyUsed@:build(funkin.util.macro.ConsoleMacro.buildConsoleClass())@:autoBuild(funkin.util.macro.ConsoleMacro.buildConsoleClass())@:nullSafety

Available on all platforms

A core class which handles determining asset paths.

Static methods

staticanimateAtlas(path:String, ?library:String):String

@:value({ type : TEXT })staticfile(file:String, type:AssetType = TEXT, ?library:String):String

staticfont(key:String):String

staticfrag(key:String, ?library:String):String

staticgetAnimateAtlas(key:String, ?library:String, settings:AtlasSpriteSettings):FlxAnimateFrames

staticgetLibrary(path:String):String

@:value({ library : "preload" })staticgetLibraryPath(file:String, library:String = "preload"):String

staticgetPackerAtlas(key:String, ?library:String):FlxAtlasFrames

staticgetSparrowAtlas(key:String, ?library:String):FlxAtlasFrames

staticimage(key:String, ?library:String):String

@:value({ withExtension : true, suffix : "" })staticinst(song:String, suffix:String = "", withExtension:Bool = true):String

Gets the path to an Inst.mp3/ogg song instrumental from songs:assets/songs/song/

Parameters:

song

name of the song to get instrumental for

suffix

any suffix to add to end of song name, used for -erect variants usually

withExtension

if it should return with the audio file extension .mp3 or .ogg.

Returns:

String

staticjson(key:String, ?library:String):String

staticmusic(key:String, ?library:String):String

staticsetCurrentLevel(name:Null<String>):Void

staticsound(key:String, ?library:String):String

staticsoundRandom(key:String, min:Int, max:Int, ?library:String):String

@:value({ directory : "data/" })staticsrt(key:String, ?library:String, directory:String = "data/"):String

staticstripLibrary(path:String):String

statictxt(key:String, ?library:String):String

staticui(key:String, ?library:String):String

staticvert(key:String, ?library:String):String

staticvideos(key:String, ?library:String):String

@:value({ suffix : "" })staticvoices(song:String, suffix:String = ""):String

staticxml(key:String, ?library:String):String