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

{"class":{"name":"Phaser.Tileset","extends":"","static":false,"constructor":true,"parameters":[{"name":"name","type":["string"],"help":"The name of the tileset in the map data.","optional":false,"default":null},{"name":"firstgid","type":["number"],"help":"The Tiled firstgid value. In non-Tiled data this should be considered the starting index value of the first tile in this set.","optional":false,"default":null},{"name":"width","type":["number"],"help":"Width of each tile in pixels.","optional":true,"default":"32"},{"name":"height","type":["number"],"help":"Height of each tile in pixels.","optional":true,"default":"32"},{"name":"margin","type":["number"],"help":"The amount of margin around the tilesheet.","optional":true,"default":"0"},{"name":"spacing","type":["number"],"help":"The amount of spacing between each tile in the sheet.","optional":true,"default":"0"},{"name":"properties","type":["object"],"help":"Tileset properties.","optional":true,"default":null}],"help":"A Tile set is a combination of an image containing the tiles and collision data per tile.\\nYou should not normally instantiate this class directly."},"consts":[],"methods":{"public":[{"name":"draw","static":false,"returns":null,"help":"Draws a tile from this Tileset at the given coordinates on the context.","line":102,"public":true,"protected":false,"private":false,"parameters":[{"name":"context","type":["CanvasRenderingContext2D"],"help":"The context to draw the tile onto.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate to draw to.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to draw to.","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index of the tile within the set to draw.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setImage","static":false,"returns":null,"help":"Adds a reference from this Tileset to an Image stored in the Phaser.Cache.","line":129,"public":true,"protected":false,"private":false,"parameters":[{"name":"image","type":["Image"],"help":"The image this tileset will use to draw with.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setSpacing","static":false,"returns":null,"help":"Sets tile spacing and margins.","line":166,"public":true,"protected":false,"private":false,"parameters":[{"name":"tileMargin","type":["number"],"help":"The margin around the tiles in the sheet.","optional":true,"default":null},{"name":"tileSpacing","type":["number"],"help":"The spacing between the tiles in the sheet.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"columns","type":["number"],"help":"","inlineHelp":"The number of columns in the tile sheet.","line":76,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"firstgid","type":["number"],"help":"","inlineHelp":"The Tiled firstgid value. In non-Tiled data this should be considered the starting index value of the first tile in this set.","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"image","type":["object"],"help":"","inlineHelp":"The image used for rendering. This is a reference to the image stored in Phaser.Cache.","line":66,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"The name of the Tileset.","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"properties","type":["object"],"help":"","inlineHelp":"Tileset specific properties (typically defined in the Tiled editor).","line":61,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rows","type":["number"],"help":"","inlineHelp":"The number of rows in the tile sheet.","line":71,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tileHeight","type":["number"],"help":"","inlineHelp":"The height of a tile in pixels.","line":46,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tileMargin","type":["number"],"help":"","inlineHelp":"The margin around the tiles in the tileset.","line":51,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tileSpacing","type":["number"],"help":"","inlineHelp":"The spacing in pixels between each tile in the tileset.","line":56,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tileWidth","type":["number"],"help":"","inlineHelp":"The width of a tile in pixels.","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"total","type":["number"],"help":"","inlineHelp":"The total number of tiles in the tilesheet.","line":81,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"draw","type":["array"],"help":"","inlineHelp":"The tile drawImage look-up table","line":87,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}}