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

{"class":{"name":"Phaser.Tile","extends":"","static":false,"constructor":true,"parameters":[{"name":"layer","type":["object"],"help":"The layer in the Tilemap data that this tile belongs to.","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index of this tile type in the core map data.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate of this tile.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate of this tile.","optional":false,"default":null},{"name":"width","type":["number"],"help":"Width of the tile.","optional":false,"default":null},{"name":"height","type":["number"],"help":"Height of the tile.","optional":false,"default":null}],"help":"A Tile is a representation of a single tile within the Tilemap."},"consts":[],"methods":{"public":[{"name":"containsPoint","static":false,"returns":{"types":["boolean"],"help":"True if the coordinates are within this Tile, otherwise false."},"help":"Check if the given x and y world coordinates are within this Tile.","line":154,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate to test.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to test.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"copy","static":false,"returns":null,"help":"Copies the tile data and properties from the given tile to this tile.","line":301,"public":true,"protected":false,"private":false,"parameters":[{"name":"tile","type":["Phaser.Tile"],"help":"The tile to copy from.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Clean up memory.","line":215,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"intersects","static":false,"returns":null,"help":"Check for intersection with this tile.","line":169,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x axis in pixels.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y axis in pixels.","optional":false,"default":null},{"name":"right","type":["number"],"help":"The right point.","optional":false,"default":null},{"name":"bottom","type":["number"],"help":"The bottom point.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"isInteresting","static":false,"returns":{"types":["boolean"],"help":"True if the Tile is interesting, otherwise false."},"help":"Is this tile interesting?","line":273,"public":true,"protected":false,"private":false,"parameters":[{"name":"collides","type":["boolean"],"help":"If true will check any collides value.","optional":false,"default":null},{"name":"faces","type":["boolean"],"help":"If true will check any face value.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"resetCollision","static":false,"returns":null,"help":"Reset collision status flags.","line":251,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setCollision","static":false,"returns":null,"help":"Sets the collision flags for each side of this tile and updates the interesting faces list.","line":232,"public":true,"protected":false,"private":false,"parameters":[{"name":"left","type":["boolean"],"help":"Indicating collide with any object on the left.","optional":false,"default":null},{"name":"right","type":["boolean"],"help":"Indicating collide with any object on the right.","optional":false,"default":null},{"name":"up","type":["boolean"],"help":"Indicating collide with any object on the top.","optional":false,"default":null},{"name":"down","type":["boolean"],"help":"Indicating collide with any object on the bottom.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setCollisionCallback","static":false,"returns":null,"help":"Set a callback to be called when this tile is hit by an object.\\nThe callback must true true for collision processing to take place.","line":203,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"Callback function.","optional":false,"default":null},{"name":"context","type":["object"],"help":"Callback will be called within this context.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"alpha","type":["number"],"help":"","inlineHelp":"The alpha value at which this tile is drawn to the canvas.","line":74,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"bottom","type":["number"],"help":"","inlineHelp":"The sum of the y and height properties.","line":391,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"canCollide","type":["boolean"],"help":"","inlineHelp":"True if this tile can collide on any of its faces or has a collision callback set.","line":339,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"collideDown","type":["boolean"],"help":"","inlineHelp":"Indicating collide with any object on the bottom.","line":128,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"collideLeft","type":["boolean"],"help":"","inlineHelp":"Indicating collide with any object on the left.","line":110,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"collideRight","type":["boolean"],"help":"","inlineHelp":"Indicating collide with any object on the right.","line":116,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"collideUp","type":["boolean"],"help":"","inlineHelp":"Indicating collide with any object on the top.","line":122,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"collides","type":["boolean"],"help":"","inlineHelp":"True if this tile can collide on any of its faces.","line":326,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"collisionCallback","type":["function"],"help":"","inlineHelp":"Tile collision callback.","line":134,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"collisionCallbackContext","type":["object"],"help":"","inlineHelp":"The context in which the collision callback will be called.","line":140,"default":"this","public":true,"protected":false,"private":false,"readOnly":false},{"name":"faceBottom","type":["boolean"],"help":"","inlineHelp":"Is the bottom of this tile an interesting edge?","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"faceLeft","type":["boolean"],"help":"","inlineHelp":"Is the left of this tile an interesting edge?","line":99,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"faceRight","type":["boolean"],"help":"","inlineHelp":"Is the right of this tile an interesting edge?","line":104,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"faceTop","type":["boolean"],"help":"","inlineHelp":"Is the top of this tile an interesting edge?","line":89,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"The height of the tile in pixels.","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"index","type":["number"],"help":"","inlineHelp":"The index of this tile within the map data corresponding to the tileset, or -1 if this represents a blank\/null tile.","line":29,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"layer","type":["object"],"help":"","inlineHelp":"The layer in the Tilemap data that this tile belongs to.","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"left","type":["number"],"help":"","inlineHelp":"The x value in pixels.","line":352,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"properties","type":["object"],"help":"","inlineHelp":"Tile specific properties.","line":79,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"right","type":["number"],"help":"","inlineHelp":"The sum of the x and width properties.","line":365,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"scanned","type":["boolean"],"help":"","inlineHelp":"Has this tile been walked \/ turned into a poly?","line":84,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"top","type":["number"],"help":"","inlineHelp":"The y value.","line":378,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"width","type":["number"],"help":"","inlineHelp":"The width of the tile in pixels.","line":64,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"","inlineHelp":"The x map coordinate of this tile.","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"The y map coordinate of this tile.","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}}