Skip to content

Commit 629ead9

Browse files
committed
Making Tileset comments more specific - better explains Tiled structure
1 parent b8b0f42 commit 629ead9

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

src/gameobjects/tilemap/Tileset.js

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,14 +72,15 @@ var Tileset = new Class({
7272
this.tileSpacing = tileSpacing;
7373

7474
/**
75-
* Tileset-specific properties per tile that are typically defined in the Tiled editor.
75+
* Tileset-specific properties per tile that are typically defined in the Tiled editor in the
76+
* Tileset editor.
7677
* @property {object} tileProperties
7778
*/
7879
this.tileProperties = tileProperties;
7980

8081
/**
81-
* Tileset-specific data per tile that are typically defined in the Tiled editor. This is
82-
* where collision objects and terrain are stored.
82+
* Tileset-specific data per tile that are typically defined in the Tiled editor, e.g. within
83+
* the Tilset collision editor. This is where collision objects and terrain are stored.
8384
* @property {object} tileData
8485
*/
8586
this.tileData = tileData;
@@ -123,7 +124,7 @@ var Tileset = new Class({
123124

124125
/**
125126
* Get a tile's properties that are stored in the Tileset. Returns null if tile index is not
126-
* contained in this Tileset.
127+
* contained in this Tileset. This is typically defined in Tiled under the Tileset editor.
127128
*
128129
* @param {integer} tileIndex - The unique id of the tile across all tilesets in the map.
129130
* @returns {object|undefined|null}
@@ -135,8 +136,9 @@ var Tileset = new Class({
135136
},
136137

137138
/**
138-
* Get a tile's data that is stored in the Tileset. Returns null if tile index is not
139-
* contained in this Tileset.
139+
* Get a tile's data that is stored in the Tileset. Returns null if tile index is not contained
140+
* in this Tileset. This is typically defined in Tiled and will contain both Tileset collision
141+
* info and terrain mapping.
140142
*
141143
* @param {integer} tileIndex - The unique id of the tile across all tilesets in the map.
142144
* @returns {object|undefined|null}
@@ -148,8 +150,8 @@ var Tileset = new Class({
148150
},
149151

150152
/**
151-
* Get a tile's data that is stored in the Tileset. Returns null if tile index is not
152-
* contained in this Tileset.
153+
* Get a tile's collision group that is stored in the Tileset. Returns null if tile index is not
154+
* contained in this Tileset. This is typically defined within Tiled's tileset collision editor.
153155
*
154156
* @param {integer} tileIndex - The unique id of the tile across all tilesets in the map.
155157
* @returns {object|null}

0 commit comments

Comments
 (0)