class openfl.Assets
Available on all platforms
The Assets class provides a cross-platform interface to access * embedded images, fonts, sounds and other resource files.
* *The contents are populated automatically when an application * is compiled using the OpenFL command-line tools, based on the * contents of the *.nmml project file.
* *For most platforms, the assets are included in the same directory
* or package as the application, and the paths are handled
* automatically. For web content, the assets are preloaded before
* the start of the rest of the application. You can customize the
* preloader by extending the NMEPreloader
class,
* and specifying a custom preloader using
Class Fields
static function getBitmapData(id:String, ?useCache:Bool = true):BitmapData
Gets an instance of an embedded bitmap * @usage var bitmap = new Bitmap(Assets.getBitmapData("image.jpg")); *
id | The ID or asset path for the bitmap * |
useCache | (Optional) Whether to use BitmapData from the cache(Default: true) * |
returns | A new BitmapData object |
static function getBytes(id:String):ByteArray
Gets an instance of an embedded binary asset * @usage var bytes = Assets.getBytes("file.zip"); *
id | The ID or asset path for the file * |
returns | A new ByteArray object |
static function getFont(id:String, ?useCache:Bool = true):Font
Gets an instance of an embedded font * @usage var fontName = Assets.getFont("font.ttf").fontName; *
id | The ID or asset path for the font * |
returns | A new Font object |
static function getMovieClip(id:String):MovieClip
Gets an instance of a library MovieClip * @usage var movieClip = Assets.getMovieClip("library:BouncingBall"); *
id | The library and ID for the MovieClip * |
returns | A new Sound object |
static function getMusic(id:String, ?useCache:Bool = true):Sound
Gets an instance of an embedded streaming sound * @usage var sound = Assets.getMusic("sound.ogg"); *
id | The ID or asset path for the music track * |
returns | A new Sound object |
static function getPath(id:String):String
Gets the file path (if available) for an asset * @usage var path = Assets.getPath("image.jpg"); *
id | The ID or asset path for the asset * |
returns | The path to the asset (or null) |
static function getSound(id:String, ?useCache:Bool = true):Sound
Gets an instance of an embedded sound * @usage var sound = Assets.getSound("sound.wav"); *
id | The ID or asset path for the sound * |
returns | A new Sound object |