Optional
configA config to adjust the parser
Optional
extensionOptional
loadThis is the promise that loads the URL provided resolves with a loaded asset if returned by the parser.
Optional
nameThe name of the parser (this can be used when specifying loadParser in a ResolvedAsset)
Optional
parseGets called on the asset it testParse passes. Useful to convert a raw asset into something more useful than
Optional
testeach URL to load will be tested here, if the test is passed the assets are loaded using the load function below. Good place to test for things like file extensions!
The URL to test
Optional
resolvedAsset: ResolvedAsset<META_DATA>Any custom additional information relevant to the asset being loaded
Optional
loader: LoaderThe loader instance
Optional
testThis function is used to test if the parse function should be run on the asset If this returns true then parse is called with the asset
The loaded asset data
Optional
resolvedAsset: ResolvedAsset<META_DATA>Any custom additional information relevant to the asset being loaded
Optional
loader: LoaderThe loader instance
Optional
unloadIf an asset is parsed using this parser, the unload function will be called when the user requests an asset to be unloaded. This is useful for things like sounds or textures that can be unloaded from memory
The asset to unload/destroy
Optional
resolvedAsset: ResolvedAsset<META_DATA>Any custom additional information relevant to the asset being loaded
Optional
loader: LoaderThe loader instance
Generated using TypeDoc
All functions are optional here. The flow:
for every asset,
parser.test()
: Test the asset url.parser.load()
: If test passes call the load function with the urlparser.testParse()
: Test to see if the asset should be parsed by the pluginparse.parse()
: If test is parsed, then run the parse function on the asset.some plugins may only be used for parsing, some only for loading and some for both!
Memberof
PIXI