Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2025-02-16 14:08:28 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updated jsdocs

Browse source
This commit is contained in:
Richard Davey 2024-02-20 21:38:19 +00:00
parent 6eba4f25ef
commit 0002c009f7
1 changed files with 19 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
src/tilemaps/Tilemap.js
View file

@ -913,11 +913,27 @@ var Tilemap = new Class({
},
/**
* Creates a Sprite for every object matching the given tile indexes in the layer. You can
* Creates a Sprite for every tile matching the given tile indexes in the layer. You can
* optionally specify if each tile will be replaced with a new tile after the Sprite has been
* created. This is useful if you want to lay down special tiles in a level that are converted to
* created. Set this value to -1 if you want to just remove the tile after conversion.
*
* This is useful if you want to lay down special tiles in a level that are converted to
* Sprites, but want to replace the tile itself with a floor tile or similar once converted.
*
* The following features were added in Phaser v3.80:
*
* By default, Phaser Sprites have their origin set to 0.5 x 0.5. If you don't specify a new
* origin in the spriteConfig, then it will adjust the sprite positions by half the tile size,
* to position them accurately on the map.
*
* When the Sprite is created it will copy the following properties from the tile:
*
* 'rotation', 'flipX', 'flipY', 'alpha', 'visible' and 'tint'.
*
* The spriteConfig also has a special property called `useSpriteSheet`. If this is set to
* `true` and you have loaded the tileset as a sprite sheet (not an image), then it will
* set the Sprite key and frame to match the sprite texture and tile index.
*
* @method Phaser.Tilemaps.Tilemap#createFromTiles
* @since 3.0.0
*
@ -925,7 +941,7 @@ var Tilemap = new Class({
* @param {?(number|array)} replacements - The tile index, or array of indexes, to change a converted
* tile to. Set to `null` to leave the tiles unchanged. If an array is given, it is assumed to be a
* one-to-one mapping with the indexes array.
* @param {Phaser.Types.GameObjects.Sprite.SpriteConfig} spriteConfig - The config object to pass into the Sprite creator (i.e. scene.make.sprite).
* @param {Phaser.Types.GameObjects.Sprite.SpriteConfig} [spriteConfig] - The config object to pass into the Sprite creator (i.e. scene.make.sprite).
* @param {Phaser.Scene} [scene] - The Scene to create the Sprites within.
* @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use when calculating the tile index from the world values.
* @param {(string|number|Phaser.Tilemaps.TilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.