funkin.backend.assets.Paths - Codename Engine API

Static variables

`staticfinalinlineread onlySOUND_EXT:String = "ogg"`

Preferred sound extension for the game's audio files. Currently is set to mp3 for web targets, and ogg for other targets.

`staticassetsTree:AssetsLibraryList`

View in GitHub

`statictempFramesCache:Map<String, FlxFramesCollection> = []`

`staticframesExists(key:String, checkAtlas:Bool = false, checkMulti:Bool = true, assetsPath:Bool = false, ?library:String):Bool`

Checks if the images needed for using getFrames() exist.

Parameters:

`key`	Path to the image
`checkAtlas`	Whenever to check for the Animation.json file (used in FlxAnimate)
`assetsPath`	Whenever to use the raw path or to pass it through Paths.image()
`library`	(Additional) library to load the frames from.

Returns:

True if the images exist, false otherwise.

View in GitHub

`staticinlinegetAsepriteAtlas(key:String, ?library:String):FlxAtlasFrames`

View in GitHub

`staticinlinegetAsepriteAtlasAlt(key:String):FlxAtlasFrames`

View in GitHub

`staticinlinegetAssetsRoot():String`

View in GitHub

`staticgetFolderContent(key:String, addPath:Bool = false, source:AssetSource = BOTH):Array<String>`

View in GitHub

`staticgetFolderDirectories(key:String, addPath:Bool = false, source:AssetSource = BOTH):Array<String>`

View in GitHub

`staticinlinegetFontName(font:String):String`

Gets the name of a registered font.

Parameters:

`font`	The font's path (if it's already passed as a font name, the same name will be returned)

View in GitHub

`staticgetFrames(key:String, assetsPath:Bool = false, ?library:String):Null<FlxFramesCollection>`

Gets frames at specified path.

Parameters:

`key`	Path to the frames
`library`	(Additional) library to load the frames from.

View in GitHub

`staticinlinegetPackerAtlas(key:String, ?library:String):FlxAtlasFrames`

View in GitHub

`staticinlinegetPackerAtlasAlt(key:String):FlxAtlasFrames`

View in GitHub

`staticinlinegetPath(file:String, ?library:String):String`

View in GitHub

`staticinlinegetSparrowAtlas(key:String, ?library:String):FlxAtlasFrames`

View in GitHub

`staticinlinegetSparrowAtlasAlt(key:String):FlxAtlasFrames`

View in GitHub

`staticimage(key:String, ?library:String, checkForAtlas:Bool = false, ext:String = "png"):String`

View in GitHub

`staticinlineini(key:String, ?library:String):String`

View in GitHub

`staticinit():Void`

View in GitHub

`staticinlineinst(song:String, difficulty:String = "normal", prefix:String = ""):String`

View in GitHub

`staticinlinejson(key:String, ?library:String):String`

View in GitHub

`staticinlinemd2(key:String):String`

View in GitHub

`staticinlinemd5(key:String):String`

View in GitHub

`staticinlinemusic(key:String, ?library:String):String`

View in GitHub

`staticinlinendll(key:String):String`

View in GitHub

`staticinlineobj(key:String):String`

View in GitHub

`staticinlinepack(key:String, ?library:String):String`

View in GitHub

`staticinlineps1(key:String, ?library:String):String`

View in GitHub

`staticinlinescript(key:String, ?library:String, isAssetsPath:Bool = false):String`

View in GitHub

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

View in GitHub

`staticinlinesoundRandom(key:String, min:Int, max:Int, ?library:String):String`

View in GitHub

`staticinlinetxt(key:String, ?library:String):String`

View in GitHub

`staticinlinevertShader(key:String, ?library:String):String`

View in GitHub

`staticinlinevideo(key:String, ext:String = "mp4"):String`

View in GitHub

`staticinlinevoices(song:String, difficulty:String = "normal", prefix:String = ""):String`

View in GitHub

class Paths

package funkin.backend.assets

Static variables

staticfinalinlineread onlySOUND_EXT:String = "ogg"

staticassetsTree:AssetsLibraryList

statictempFramesCache:Map<String, FlxFramesCollection> = []

Static methods

staticinlineawd(key:String):String

staticinlinecharacter(character:String):String

staticchart(song:String, difficulty:String = "normal"):String

staticinlinedae(key:String):String

staticinlinefile(file:String, ?library:String):String

staticinlinefont(key:String):String

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

staticframesExists(key:String, checkAtlas:Bool = false, checkMulti:Bool = true, assetsPath:Bool = false, ?library:String):Bool

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

staticinlinegetAsepriteAtlasAlt(key:String):FlxAtlasFrames

staticinlinegetAssetsRoot():String

staticgetFolderContent(key:String, addPath:Bool = false, source:AssetSource = BOTH):Array<String>

staticgetFolderDirectories(key:String, addPath:Bool = false, source:AssetSource = BOTH):Array<String>

staticinlinegetFontName(font:String):String

staticgetFrames(key:String, assetsPath:Bool = false, ?library:String):Null<FlxFramesCollection>

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

staticinlinegetPackerAtlasAlt(key:String):FlxAtlasFrames

staticinlinegetPath(file:String, ?library:String):String

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

staticinlinegetSparrowAtlasAlt(key:String):FlxAtlasFrames

staticimage(key:String, ?library:String, checkForAtlas:Bool = false, ext:String = "png"):String

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

staticinit():Void

staticinlineinst(song:String, difficulty:String = "normal", prefix:String = ""):String

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

staticinlinemd2(key:String):String

staticinlinemd5(key:String):String

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

staticinlinendll(key:String):String

staticinlineobj(key:String):String

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

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

staticinlinescript(key:String, ?library:String, isAssetsPath:Bool = false):String

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

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

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

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

staticinlinevideo(key:String, ext:String = "mp4"):String

staticinlinevoices(song:String, difficulty:String = "normal", prefix:String = ""):String

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

`staticfinalinlineread onlySOUND_EXT:String = "ogg"`

`staticassetsTree:AssetsLibraryList`

`statictempFramesCache:Map<String, FlxFramesCollection> = []`

`staticinlineawd(key:String):String`

`staticinlinecharacter(character:String):String`

`staticchart(song:String, difficulty:String = "normal"):String`

`staticinlinedae(key:String):String`

`staticinlinefile(file:String, ?library:String):String`

`staticinlinefont(key:String):String`

`staticinlinefragShader(key:String, ?library:String):String`

`staticframesExists(key:String, checkAtlas:Bool = false, checkMulti:Bool = true, assetsPath:Bool = false, ?library:String):Bool`

`staticinlinegetAsepriteAtlas(key:String, ?library:String):FlxAtlasFrames`

`staticinlinegetAsepriteAtlasAlt(key:String):FlxAtlasFrames`

`staticinlinegetAssetsRoot():String`

`staticgetFolderContent(key:String, addPath:Bool = false, source:AssetSource = BOTH):Array<String>`

`staticgetFolderDirectories(key:String, addPath:Bool = false, source:AssetSource = BOTH):Array<String>`

`staticinlinegetFontName(font:String):String`

`staticgetFrames(key:String, assetsPath:Bool = false, ?library:String):Null<FlxFramesCollection>`

`staticinlinegetPackerAtlas(key:String, ?library:String):FlxAtlasFrames`

`staticinlinegetPackerAtlasAlt(key:String):FlxAtlasFrames`

`staticinlinegetPath(file:String, ?library:String):String`

`staticinlinegetSparrowAtlas(key:String, ?library:String):FlxAtlasFrames`

`staticinlinegetSparrowAtlasAlt(key:String):FlxAtlasFrames`

`staticimage(key:String, ?library:String, checkForAtlas:Bool = false, ext:String = "png"):String`

`staticinlineini(key:String, ?library:String):String`

`staticinit():Void`

`staticinlineinst(song:String, difficulty:String = "normal", prefix:String = ""):String`

`staticinlinejson(key:String, ?library:String):String`

`staticinlinemd2(key:String):String`

`staticinlinemd5(key:String):String`

`staticinlinemusic(key:String, ?library:String):String`

`staticinlinendll(key:String):String`

`staticinlineobj(key:String):String`

`staticinlinepack(key:String, ?library:String):String`

`staticinlineps1(key:String, ?library:String):String`

`staticinlinescript(key:String, ?library:String, isAssetsPath:Bool = false):String`

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

`staticinlinesoundRandom(key:String, min:Int, max:Int, ?library:String):String`

`staticinlinetxt(key:String, ?library:String):String`

`staticinlinevertShader(key:String, ?library:String):String`

`staticinlinevideo(key:String, ext:String = "mp4"):String`

`staticinlinevoices(song:String, difficulty:String = "normal", prefix:String = ""):String`

`staticinlinexml(key:String, ?library:String):String`