From d55274b5b05198b7beee2ccf61d5259f64cb566a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Wed, 23 Sep 2015 22:58:30 +0200 Subject: Document TileMap class --- doc/base/classes.xml | 58 ++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 52 insertions(+), 6 deletions(-) (limited to 'doc/base') diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 74cacb0919..438ca6baa8 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -34362,10 +34362,10 @@ - Node for 2D Tile-Based games. + Node for 2D tile-based games. - Node for 2D Tile-Based games. Tilemaps use a TileSet which contain a list of tiles (textures, their rect and a collision) and are used to create complex grid-based maps. + Node for 2D tile-based games. Tilemaps use a [TileSet] which contain a list of tiles (textures, their rect and a collision) and are used to create complex grid-based maps. To optimize drawing and culling (sort of like [GridMap]), you can specify a quadrant size, so chunks of the map will be batched together at drawing time. @@ -34387,36 +34387,43 @@ + Set the orientation mode as square, isometric or custom (use MODE_* constants as argument). + Return the orientation mode. + Set an half offset on the X coordinate, Y coordinate, or none (use HALF_OFFSET_* constants as argument). + Half offset sets every other tile off by a half tile size in the specified direction. + Return the current half offset configuration. + Set custom transform matrix, to use in combination with the custom orientation mode. + Return the custom transform matrix. @@ -34438,25 +34445,28 @@ Set the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time. + Allowed values are integers ranging from 1 to 128. - Return the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time. + Return the quadrant size. + Set the tile origin to the tile center or its top-left corner (use TILE_ORIGIN_* constants as argument). + Return the tile origin configuration. @@ -34491,72 +34501,89 @@ + Set the Y sort mode. Enabled Y sort mode means that children of the tilemap will be drawn in the order defined by their Y coordinate. + A tile with a higher Y coordinate will therefore be drawn later, potentially covering up the tile(s) above it if its sprite is higher than its cell size. + Return the Y sort mode. + Set the tilemap to handle collisions as a kinematic body (enabled) or a static body (disabled). + Return whether the tilemap handles collisions as a kinematic body. + Set the collision layer. + Layers are referenced by binary indexes, so allowable values to describe the 20 available layers range from 0 to 2^20-1. + Return the collision layer. + Set the collision masks. + Masks are referenced by binary indexes, so allowable values to describe the 20 available masks range from 0 to 2^20-1. + Return the collision mask. + Set the collision friction parameter. + Allowable values range from 0 to 1. + Return the collision friction parameter. + Set the collision bounce parameter. + Allowable values range from 0 to 1. + Return the collision bounce parameter. @@ -34573,6 +34600,9 @@ + Set the tile index for the cell referenced by its grid-based X and Y coordinates. + A tile index of -1 clears the cell. + Optionally, the tile can also be flipped over the X and Y coordinates or transposed. @@ -34587,6 +34617,9 @@ + Set the tile index for the cell referenced by a Vector2 of grid-based coordinates. + A tile index of -1 clears the cell. + Optionally, the tile can also be flipped over the X and Y axes or transposed. @@ -34597,7 +34630,7 @@ - Return the contents of a cell. + Return the tile index of the referenced cell. @@ -34608,7 +34641,7 @@ - Return if a given cell is flipped in x axis. + Return whether the referenced cell is flipped over the X axis. @@ -34619,7 +34652,7 @@ - Return if a given cell is flipped in y axis. + Return whether the referenced cell is flipped over the Y axis. @@ -34631,6 +34664,7 @@ + Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1). @@ -34641,6 +34675,8 @@ + Return the absolute world position corresponding to the tilemap (grid-based) coordinates given as an argument. + Optionally, the tilemap's potential half offset can be ignored. @@ -34649,12 +34685,14 @@ + Return the tilemap (grid-based) coordinates corresponding to the absolute world position given as an argument. + Signal indicating that a tilemap setting has changed. @@ -34663,20 +34701,28 @@ Returned when a cell doesn't exist. + Orthogonal orientation mode. + Isometric orientation mode. + Custom orientation mode. + Half offset on the X coordinate. + Half offset on the Y coordinate. + Half offset disabled. + Tile origin at its top-left corner. + Tile origin at its center. -- cgit v1.2.3