phaser/resources/docgen/output/Phaser.TilemapParser.json

{"class":{"name":"Phaser.TilemapParser","extends":"","static":true,"constructor":false,"parameters":[],"help":"Phaser.TilemapParser parses data objects from Phaser.Loader that need more preparation before they can be inserted into a Tilemap."},"consts":[],"methods":{"public":[{"name":"getEmptyData","static":false,"returns":{"types":["object"],"help":"Generated map data."},"help":"Returns an empty map data object.","line":126,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"parse","static":false,"returns":{"types":["object"],"help":"The parsed map object."},"help":"Parse tilemap data from the cache and creates a Tilemap object.","line":26,"public":true,"protected":false,"private":false,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Game reference to the currently running game.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The key of the tilemap in the Cache.","optional":false,"default":null},{"name":"tileWidth","type":["number"],"help":"The pixel width of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.","optional":true,"default":"32"},{"name":"tileHeight","type":["number"],"help":"The pixel height of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.","optional":true,"default":"32"},{"name":"width","type":["number"],"help":"The width of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this.","optional":true,"default":"10"},{"name":"height","type":["number"],"help":"The height of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this.","optional":true,"default":"10"}],"inherited":false,"inheritedFrom":""},{"name":"parseCSV","static":false,"returns":{"types":["object"],"help":"Generated map data."},"help":"Parses a CSV file into valid map data.","line":72,"public":true,"protected":false,"private":false,"parameters":[{"name":"data","type":["string"],"help":"The CSV file data.","optional":false,"default":null},{"name":"tileWidth","type":["number"],"help":"The pixel width of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.","optional":true,"default":"32"},{"name":"tileHeight","type":["number"],"help":"The pixel height of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.","optional":true,"default":"32"}],"inherited":false,"inheritedFrom":""},{"name":"parseJSON","static":false,"returns":{"types":["object"],"help":"Generated and parsed map data."},"help":"Parses a Tiled JSON file into valid map data.","line":188,"public":true,"protected":false,"private":false,"parameters":[{"name":"json","type":["object"],"help":"The JSON map data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}}