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

{"class":{"name":"PIXI.SpriteSheetLoader","extends":"","static":false,"constructor":true,"parameters":[{"name":"url","type":["string"],"help":"The url of the sprite sheet JSON file","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"Whether requests should be treated as crossorigin","optional":false,"default":null}],"help":"The sprite sheet loader is used to load in JSON sprite sheet data\\nTo generate the data you can use http:\/\/www.codeandweb.com\/texturepacker and publish in the 'JSON' format\\nThere is a free version so thats nice, although the paid version is great value for money.\\nIt is highly recommended to use Sprite sheets (also know as a 'texture atlas') as it means sprites can 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()\\nThis loader will load the image file that the Spritesheet points to as well as the data.\\nWhen loaded this class will dispatch a 'loaded' event"},"consts":[],"methods":{"public":[{"name":"load","static":false,"returns":null,"help":"This will begin loading the JSON file","line":74,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"onLoaded","static":false,"returns":null,"help":"Invoke when all files are loaded (json and texture)","line":90,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"baseUrl","type":["string"],"help":"[read-only] The base url of the bitmap font data","inlineHelp":"","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"crossorigin","type":["boolean"],"help":"Whether the requests should be treated as cross origin","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frames","type":["object"],"help":"The frames of the sprite sheet","inlineHelp":"","line":61,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"texture","type":["PIXI.Texture"],"help":"The texture being loaded","inlineHelp":"","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"url","type":["string"],"help":"The url of the atlas data","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}}