UNPKG

phaser

Version:

A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers from the team at Phaser Studio Inc.

26 lines (25 loc) 2.12 kB
/** * @typedef {object} Phaser.Types.Tilemaps.TiledObject * @since 3.0.0 * * @property {number} id - The unique object ID. * @property {string} name - The name this object was assigned in Tiled. * @property {string} type - The string type of this instance, as assigned in Tiled. Tiled supports inheriting instance types from tilesets; in that case, the type will be set in the tile's data, but will be `''` here; use the `gid` to fetch the tile data or properties. * @property {boolean} [visible] - The visible state of this object. * @property {number} [x] - The horizontal position of this object, in pixels, relative to the tilemap. * @property {number} [y] - The vertical position of this object, in pixels, relative to the tilemap. * @property {number} [width] - The width of this object, in pixels. * @property {number} [height] - The height of this object, in pixels. * @property {number} [rotation] - The rotation of the object in clockwise degrees. * @property {any} [properties] - Custom properties object. * @property {number} [gid] - Only set if of type 'tile'. * @property {boolean} [flippedHorizontal] - Only set if a tile object. The horizontal flip value. * @property {boolean} [flippedVertical] - Only set if a tile object. The vertical flip value. * @property {boolean} [flippedAntiDiagonal] - Only set if a tile object. The diagonal flip value. * @property {Phaser.Types.Math.Vector2Like[]} [polyline] - Only set if a polyline object. An array of objects corresponding to points, where each point has an `x` property and a `y` property. * @property {Phaser.Types.Math.Vector2Like[]} [polygon] - Only set if a polygon object. An array of objects corresponding to points, where each point has an `x` property and a `y` property. * @property {any} [text] - Only set if a text object. Contains the text objects properties. * @property {boolean} [rectangle] - Only set, and set to `true`, if a rectangle object. * @property {boolean} [ellipse] - Only set, and set to `true`, if a ellipse object. * @property {boolean} [point] - Only set, and set to `true`, if a point object. */