phaser/resources/docgen/output/PIXI.AtlasLoader.json

{"class":{"name":"PIXI.AtlasLoader","extends":"","static":false,"constructor":true,"parameters":[{"name":"url","type":["string"],"help":"The url of the JSON file","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"Whether requests should be treated as crossorigin","optional":false,"default":null}],"help":"The atlas file loader is used to load in Texture Atlas data and parse it. When loaded this class will dispatch a 'loaded' event. If loading fails this class will dispatch an 'error' event.\\n\\nTo generate the data you can use http:\/\/www.codeandweb.com\/texturepacker and publish in the 'JSON' format.\\n\\nIt is highly recommended to use texture atlases (also know as 'sprite sheets') as it allowed sprites to be batched and drawn together for highly increased rendering speed.\\nOnce the data has been loaded the frames are stored in the PIXI texture cache and can be accessed though PIXI.Texture.fromFrameId() and PIXI.Sprite.fromFrameId()"},"consts":[],"methods":{"public":[{"name":"load","static":false,"returns":null,"help":"Starts loading the JSON file","line":37,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"onAtlasLoaded","static":false,"returns":null,"help":"Invoked when the Atlas has fully loaded. Parses the JSON and builds the texture frames.","line":52,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onError","static":false,"returns":null,"help":"Invoked when an error occurs.","line":188,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onLoaded","static":false,"returns":null,"help":"Invoked when json file has loaded.","line":172,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[],"protected":[],"private":[]}}