wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-07-19 11:26:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Adding docs.

Browse Source
This commit is contained in:
Richard Davey
2013-10-01 15:01:46 +01:00
parent fa15f8015d
commit 305b12d76b
64 changed files with 6268 additions and 2682 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/tilemap/TilemapLayer.js
+196 -82
View File
@@ -1,113 +1,203 @@
/**
* Phaser - TilemapLayer
*
* A Tilemap Layer. Tiled format maps can have multiple overlapping layers.
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2013 Photon Storm Ltd.
* @license https://github.com/photonstorm/phaser/blob/master/license.txt MIT License
* @module Phaser.TilemapLayer
*/
/**
* TilemapLayer constructor
* Create a new <code>TilemapLayer</code>.
*
* @class Phaser.TilemapLayer
* @classdesc A Tilemap Layer. Tiled format maps can have multiple overlapping layers.
* @constructor
* @param parent {Tilemap} The tilemap that contains this layer.
* @param id {number} The ID of this layer within the Tilemap array.
* @param key {string} Asset key for this map.
* @param mapFormat {number} Format of this map data, available: Tilemap.CSV or Tilemap.JSON.
* @param mapformat {number} Format of this map data, available: Tilemap.CSV or Tilemap.JSON.
* @param name {string} Name of this layer, so you can get this layer by its name.
* @param tileWidth {number} Width of tiles in this map.
* @param tileHeight {number} Height of tiles in this map.
*/
Phaser.TilemapLayer = function (parent, id, key, mapFormat, name, tileWidth, tileHeight) {
/**
* Controls whether update() and draw() are automatically called.
* @type {bool}
*/
/**
* @property {bool} exists - Controls whether update() and draw() are automatically called.
* @default
*/
this.exists = true;
/**
* Controls whether draw() are automatically called.
* @type {bool}
*/
/**
* @property {bool} visible - Controls whether draw() are automatically called.
* @default
*/
this.visible = true;
/**
* How many tiles in each row.
* Read-only variable, do NOT recommend changing after the map is loaded!
* @type {number}
* @property {number} widthInTiles
* @default
*/
this.widthInTiles = 0;
/**
* How many tiles in each column.
* Read-only variable, do NOT recommend changing after the map is loaded!
* @type {number}
* @property {number} heightInTiles
* @default
*/
this.heightInTiles = 0;
/**
* Read-only variable, do NOT recommend changing after the map is loaded!
* @type {number}
* @property {number} widthInPixels
* @default
*/
this.widthInPixels = 0;
/**
* Read-only variable, do NOT recommend changing after the map is loaded!
* @type {number}
* @property {number} heightInPixels
* @default
*/
this.heightInPixels = 0;
/**
* Distance between REAL tiles to the tileset texture bound.
* @type {number}
* @property {number} tileMargin
* @default
*/
this.tileMargin = 0;
/**
* Distance between every 2 neighbor tile in the tileset texture.
* @type {number}
* @property {number} tileSpacing
* @default
*/
this.tileSpacing = 0;
/**
* @property {Description} parent - Description.
*/
this.parent = parent;
/**
* @property {Phaser.Game} game - Description.
*/
this.game = parent.game;
/**
* @property {Description} ID - Description.
*/
this.ID = id;
/**
* @property {Description} name - Description.
*/
this.name = name;
/**
* @property {Description} key - Description.
*/
this.key = key;
/**
* @property {Description} type - Description.
*/
this.type = Phaser.TILEMAPLAYER;
/**
* @property {tileWidth} mapFormat - Description.
*/
this.mapFormat = mapFormat;
/**
* @property {Description} tileWidth - Description.
*/
this.tileWidth = tileWidth;
/**
* @property {Description} tileHeight - Description.
*/
this.tileHeight = tileHeight;
/**
* @property {Phaser.Rectangle} boundsInTiles - Description.
*/
this.boundsInTiles = new Phaser.Rectangle();
var map = this.game.cache.getTilemap(key);
/**
* @property {Description} tileset - Description.
*/
this.tileset = map.data;
/**
* @property {Description} _alpha - Description.
* @private
* @default
*/
this._alpha = 1;
this.quadTree = null;
/**
* @property {Description} canvas - Description.
* @default
*/
this.canvas = null;
/**
* @property {Description} context - Description.
* @default
*/
this.context = null;
/**
* @property {Description} baseTexture - Description.
* @default
*/
this.baseTexture = null;
/**
* @property {Description} texture - Description.
* @default
*/
this.texture = null;
/**
* @property {Description} sprite - Description.
* @default
*/
this.sprite = null;
/**
* @property {array} mapData - Description.
*/
this.mapData = [];
/**
* @property {array} _tempTileBlock - Description.
* @private
*/
this._tempTileBlock = [];
/**
* @property {array} _tempBlockResults - Description.
* @private
*
*/
this._tempBlockResults = [];
};
Phaser.TilemapLayer.prototype = {
/**
/**
* Set a specific tile with its x and y in tiles.
* @param x {number} X position of this tile in world coordinates.
* @param y {number} Y position of this tile in world coordinates.
* @param index {number} The index of this tile type in the core map data.
* @method putTileWorldXY
* @param {number} x - X position of this tile in world coordinates.
* @param {number} y - Y position of this tile in world coordinates.
* @param {number} index - The index of this tile type in the core map data.
*/
putTileWorldXY: function (x, y, index) {
@@ -124,11 +214,12 @@ Phaser.TilemapLayer.prototype = {
},
/**
/**
* Set a specific tile with its x and y in tiles.
* @param x {number} X position of this tile.
* @param y {number} Y position of this tile.
* @param index {number} The index of this tile type in the core map data.
* @method putTile
* @param {number} x - X position of this tile.
* @param {number} y - Y position of this tile.
* @param {number} index - The index of this tile type in the core map data.
*/
putTile: function (x, y, index) {
@@ -142,14 +233,15 @@ Phaser.TilemapLayer.prototype = {
},
/**
/**
* Swap tiles with 2 kinds of indexes.
* @param tileA {number} First tile index.
* @param tileB {number} Second tile index.
* @param [x] {number} specify a Rectangle of tiles to operate. The x position in tiles of Rectangle's left-top corner.
* @param [y] {number} specify a Rectangle of tiles to operate. The y position in tiles of Rectangle's left-top corner.
* @param [width] {number} specify a Rectangle of tiles to operate. The width in tiles.
* @param [height] {number} specify a Rectangle of tiles to operate. The height in tiles.
* @method swapTile
* @param {number} tileA - First tile index.
* @param {number} tileB - Second tile index.
* @param {number} [x] - specify a Rectangle of tiles to operate. The x position in tiles of Rectangle's left-top corner.
* @param {number} [y] - specify a Rectangle of tiles to operate. The y position in tiles of Rectangle's left-top corner.
* @param {number} [width] - specify a Rectangle of tiles to operate. The width in tiles.
* @param {number} [height] - specify a Rectangle of tiles to operate. The height in tiles.
*/
swapTile: function (tileA, tileB, x, y, width, height) {
@@ -186,13 +278,14 @@ Phaser.TilemapLayer.prototype = {
},
/**
/**
* Fill a tile block with a specific tile index.
* @param index {number} Index of tiles you want to fill with.
* @param [x] {number} x position (in tiles) of block's left-top corner.
* @param [y] {number} y position (in tiles) of block's left-top corner.
* @param [width] {number} width of block.
* @param [height] {number} height of block.
* @method fillTile
* @param {number} index - Index of tiles you want to fill with.
* @param {number} [x] - X position (in tiles) of block's left-top corner.
* @param {number} [y] - Y position (in tiles) of block's left-top corner.
* @param {number} [width] - width of block.
* @param {number} [height] - height of block.
*/
fillTile: function (index, x, y, width, height) {
@@ -210,13 +303,14 @@ Phaser.TilemapLayer.prototype = {
},
/**
/**
* Set random tiles to a specific tile block.
* @param tiles {number[]} Tiles with indexes in this array will be randomly set to the given block.
* @param [x] {number} x position (in tiles) of block's left-top corner.
* @param [y] {number} y position (in tiles) of block's left-top corner.
* @param [width] {number} width of block.
* @param [height] {number} height of block.
* @method randomiseTiles
* @param {number[]} tiles - Tiles with indexes in this array will be randomly set to the given block.
* @param {number} [x] - X position (in tiles) of block's left-top corner.
* @param {number} [y] - Y position (in tiles) of block's left-top corner.
* @param {number} [width] - width of block.
* @param {number} [height] - height of block.
*/
randomiseTiles: function (tiles, x, y, width, height) {
@@ -234,14 +328,15 @@ Phaser.TilemapLayer.prototype = {
},
/**
/**
* Replace one kind of tiles to another kind.
* @param tileA {number} Index of tiles you want to replace.
* @param tileB {number} Index of tiles you want to set.
* @param [x] {number} x position (in tiles) of block's left-top corner.
* @param [y] {number} y position (in tiles) of block's left-top corner.
* @param [width] {number} width of block.
* @param [height] {number} height of block.
* @method replaceTile
* @param {number} tileA - First tile index.
* @param {number} tileB - Second tile index.
* @param {number} [x] - X position (in tiles) of block's left-top corner.
* @param {number} [y] - Y position (in tiles) of block's left-top corner.
* @param {number} [width] - width of block.
* @param {number} [height] - height of block.
*/
replaceTile: function (tileA, tileB, x, y, width, height) {
@@ -262,12 +357,13 @@ Phaser.TilemapLayer.prototype = {
},
/**
* Get a tile block with specific position and size.(both are in tiles)
* @param x {number} X position of block's left-top corner.
* @param y {number} Y position of block's left-top corner.
* @param width {number} Width of block.
* @param height {number} Height of block.
/**
* Get a tile block with specific position and size (both are in tiles).
* @method getTileBlock
* @param {number} [x] - X position (in tiles) of block's left-top corner.
* @param {number} [y] - Y position (in tiles) of block's left-top corner.
* @param {number} [width] - width of block.
* @param {number} [height] - height of block.
*/
getTileBlock: function (x, y, width, height) {
@@ -288,10 +384,11 @@ Phaser.TilemapLayer.prototype = {
},
/**
/**
* Get a tile with specific position (in world coordinate). (thus you give a position of a point which is within the tile)
* @param x {number} X position of the point in target tile.
* @param x {number} Y position of the point in target tile.
* @method getTileFromWorldXY
* @param {number} [x] - X position (in tiles) of block's left-top corner.
* @param {number} [y] - Y position (in tiles) of block's left-top corner.
*/
getTileFromWorldXY: function (x, y) {
@@ -302,10 +399,11 @@ Phaser.TilemapLayer.prototype = {
},
/**
/**
* Get tiles overlaps the given object.
* @param object {GameObject} Tiles you want to get that overlaps this.
* @return {array} Array with tiles informations. (Each contains x, y and the tile.)
* @method getTileOverlaps
* @param {GameObject} object - Tiles you want to get that overlaps this.
* @return {array} Array with tiles informations (each contains x, y, and the tile).
*/
getTileOverlaps: function (object) {
@@ -339,13 +437,14 @@ Phaser.TilemapLayer.prototype = {
},
/**
* Get a tile block with its position and size. (This method does not return, it'll set result to _tempTileBlock)
* @param x {number} X position of block's left-top corner.
* @param y {number} Y position of block's left-top corner.
* @param width {number} Width of block.
* @param height {number} Height of block.
* @param collisionOnly {bool} Whethor or not ONLY return tiles which will collide (its allowCollisions value is not Collision.NONE).
/**
* Get a tile block with its position and size (this method does not return, it'll set result to _tempTileBlock).
* @method getTempBlock
* @param {number} [x] - X position (in tiles) of block's left-top corner.
* @param {number} [y] - Y position (in tiles) of block's left-top corner.
* @param {number} [width] - width of block.
* @param {number} [height] - height of block.
* @param {bool} collisionOnly - Whethor or not ONLY return tiles which will collide (its allowCollisions value is not Collision.NONE).
*/
getTempBlock: function (x, y, width, height, collisionOnly) {
@@ -404,10 +503,11 @@ Phaser.TilemapLayer.prototype = {
}
},
/**
/**
* Get the tile index of specific position (in tiles).
* @param x {number} X position of the tile.
* @param y {number} Y position of the tile.
* @method getTileIndex
* @param {number} x - X position of the tile.
* @param {number} y - Y position of the tile.
* @return {number} Index of the tile at that position. Return null if there isn't a tile there.
*/
getTileIndex: function (x, y) {
@@ -424,9 +524,10 @@ Phaser.TilemapLayer.prototype = {
},
/**
/**
* Add a column of tiles into the layer.
* @param column {string[]/number[]} An array of tile indexes to be added.
* @method addColumn
* @param {string[]|number[]} column - An array of tile indexes to be added.
*/
addColumn: function (column) {
@@ -450,6 +551,10 @@ Phaser.TilemapLayer.prototype = {
},
/**
* Description.
* @method createCanvas
*/
createCanvas: function () {
var width = this.game.width;
@@ -484,6 +589,7 @@ Phaser.TilemapLayer.prototype = {
/**
* Update boundsInTiles with widthInTiles and heightInTiles.
* @method updateBounds
*/
updateBounds: function () {
@@ -491,12 +597,13 @@ Phaser.TilemapLayer.prototype = {
},
/**
/**
* Parse tile offsets from map data.
* Basically this creates a large array of objects that contain the x/y coordinates to grab each tile from
* for the entire map. Yes we could calculate this at run-time by using the tile index and some math, but we're
* trading a quite small bit of memory here to not have to process that in our main render loop.
* @return {number} length of tileOffsets array.
* @method parseTileOffsets
* @return {number} Length of tileOffsets array.
*/
parseTileOffsets: function () {
@@ -529,6 +636,13 @@ Phaser.TilemapLayer.prototype = {
};
/**
* Get
* @return {Description}
*//**
* Set
* @param {Description} value - Description.
*/
Object.defineProperty(Phaser.TilemapLayer.prototype, 'alpha', {
get: function() {