phaser/v2-community/resources/docgen/output/Phaser.Tile.json

1 line
9.4 KiB
JSON
Raw Normal View History

{"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 b