Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: ace47f729c
Branches Tags
godot-docs
/
classes
/
class_tilemap.rst

class_tilemap.rst 41 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the TileMap.xml source instead.
    3. 

  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
    4. 

  4. 

  5. .. _class_TileMap:
    6. 

  6. 

  7. TileMap
    8. 

  8. =======
    9. 

  9. 

  10. **Inherits:** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
    11. 

  11. 

  12. **Category:** Core
    13. 

  13. 

  14. Brief Description
    15. 

  15. -----------------
    16. 

  16. 

  17. Node for 2D tile-based maps.
    18. 

  18. 

  19. Member Functions
    20. 

  20. ----------------
    21. 

  21. 

  22. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    23. 

  23. | void                                   | :ref:`clear<class_TileMap_clear>`  **(** **)**                                                                                                                                                                                                          |
    24. 

  24. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    25. 

  25. | :ref:`int<class_int>`                  | :ref:`get_cell<class_TileMap_get_cell>`  **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y  **)** const                                                                                                                                            |
    26. 

  26. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | :ref:`Vector2<class_vector2>`          | :ref:`get_cell_size<class_TileMap_get_cell_size>`  **(** **)** const                                                                                                                                                                                    |
    28. 

  28. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`int<class_int>`                  | :ref:`get_cellv<class_TileMap_get_cellv>`  **(** :ref:`Vector2<class_vector2>` position  **)** const                                                                                                                                                    |
    30. 

  30. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | :ref:`bool<class_bool>`                | :ref:`get_center_x<class_TileMap_get_center_x>`  **(** **)** const                                                                                                                                                                                      |
    32. 

  32. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | :ref:`bool<class_bool>`                | :ref:`get_center_y<class_TileMap_get_center_y>`  **(** **)** const                                                                                                                                                                                      |
    34. 

  34. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. | :ref:`float<class_float>`              | :ref:`get_collision_bounce<class_TileMap_get_collision_bounce>`  **(** **)** const                                                                                                                                                                      |
    36. 

  36. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37. | :ref:`float<class_float>`              | :ref:`get_collision_friction<class_TileMap_get_collision_friction>`  **(** **)** const                                                                                                                                                                  |
    38. 

  38. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39. | :ref:`int<class_int>`                  | :ref:`get_collision_layer<class_TileMap_get_collision_layer>`  **(** **)** const                                                                                                                                                                        |
    40. 

  40. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41. | :ref:`bool<class_bool>`                | :ref:`get_collision_layer_bit<class_TileMap_get_collision_layer_bit>`  **(** :ref:`int<class_int>` bit  **)** const                                                                                                                                     |
    42. 

  42. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43. | :ref:`int<class_int>`                  | :ref:`get_collision_mask<class_TileMap_get_collision_mask>`  **(** **)** const                                                                                                                                                                          |
    44. 

  44. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. | :ref:`bool<class_bool>`                | :ref:`get_collision_mask_bit<class_TileMap_get_collision_mask_bit>`  **(** :ref:`int<class_int>` bit  **)** const                                                                                                                                       |
    46. 

  46. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47. | :ref:`bool<class_bool>`                | :ref:`get_collision_use_kinematic<class_TileMap_get_collision_use_kinematic>`  **(** **)** const                                                                                                                                                        |
    48. 

  48. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49. | :ref:`Transform2D<class_transform2d>`  | :ref:`get_custom_transform<class_TileMap_get_custom_transform>`  **(** **)** const                                                                                                                                                                      |
    50. 

  50. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51. | :ref:`int<class_int>`                  | :ref:`get_half_offset<class_TileMap_get_half_offset>`  **(** **)** const                                                                                                                                                                                |
    52. 

  52. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

  53. | :ref:`int<class_int>`                  | :ref:`get_mode<class_TileMap_get_mode>`  **(** **)** const                                                                                                                                                                                              |
    54. 

  54. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    55. 

  55. | :ref:`int<class_int>`                  | :ref:`get_occluder_light_mask<class_TileMap_get_occluder_light_mask>`  **(** **)** const                                                                                                                                                                |
    56. 

  56. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    57. 

  57. | :ref:`int<class_int>`                  | :ref:`get_quadrant_size<class_TileMap_get_quadrant_size>`  **(** **)** const                                                                                                                                                                            |
    58. 

  58. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    59. 

  59. | :ref:`int<class_int>`                  | :ref:`get_tile_origin<class_TileMap_get_tile_origin>`  **(** **)** const                                                                                                                                                                                |
    60. 

  60. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    61. 

  61. | :ref:`TileSet<class_tileset>`          | :ref:`get_tileset<class_TileMap_get_tileset>`  **(** **)** const                                                                                                                                                                                        |
    62. 

  62. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    63. 

  63. | :ref:`Array<class_array>`              | :ref:`get_used_cells<class_TileMap_get_used_cells>`  **(** **)** const                                                                                                                                                                                  |
    64. 

  64. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    65. 

  65. | :ref:`Array<class_array>`              | :ref:`get_used_cells_by_id<class_TileMap_get_used_cells_by_id>`  **(** :ref:`int<class_int>` id  **)** const                                                                                                                                            |
    66. 

  66. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    67. 

  67. | :ref:`Rect2<class_rect2>`              | :ref:`get_used_rect<class_TileMap_get_used_rect>`  **(** **)**                                                                                                                                                                                          |
    68. 

  68. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    69. 

  69. | :ref:`bool<class_bool>`                | :ref:`is_cell_transposed<class_TileMap_is_cell_transposed>`  **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y  **)** const                                                                                                                        |
    70. 

  70. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    71. 

  71. | :ref:`bool<class_bool>`                | :ref:`is_cell_x_flipped<class_TileMap_is_cell_x_flipped>`  **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y  **)** const                                                                                                                          |
    72. 

  72. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    73. 

  73. | :ref:`bool<class_bool>`                | :ref:`is_cell_y_flipped<class_TileMap_is_cell_y_flipped>`  **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y  **)** const                                                                                                                          |
    74. 

  74. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    75. 

  75. | :ref:`bool<class_bool>`                | :ref:`is_y_sort_mode_enabled<class_TileMap_is_y_sort_mode_enabled>`  **(** **)** const                                                                                                                                                                  |
    76. 

  76. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    77. 

  77. | :ref:`Vector2<class_vector2>`          | :ref:`map_to_world<class_TileMap_map_to_world>`  **(** :ref:`Vector2<class_vector2>` map_position, :ref:`bool<class_bool>` ignore_half_ofs=false  **)** const                                                                                           |
    78. 

  78. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    79. 

  79. | void                                   | :ref:`set_cell<class_TileMap_set_cell>`  **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` tile, :ref:`bool<class_bool>` flip_x=false, :ref:`bool<class_bool>` flip_y=false, :ref:`bool<class_bool>` transpose=false  **)** |
    80. 

  80. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    81. 

  81. | void                                   | :ref:`set_cell_size<class_TileMap_set_cell_size>`  **(** :ref:`Vector2<class_vector2>` size  **)**                                                                                                                                                      |
    82. 

  82. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    83. 

  83. | void                                   | :ref:`set_cellv<class_TileMap_set_cellv>`  **(** :ref:`Vector2<class_vector2>` position, :ref:`int<class_int>` tile, :ref:`bool<class_bool>` flip_x=false, :ref:`bool<class_bool>` flip_y=false, :ref:`bool<class_bool>` transpose=false  **)**         |
    84. 

  84. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    85. 

  85. | void                                   | :ref:`set_center_x<class_TileMap_set_center_x>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                                                                                            |
    86. 

  86. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    87. 

  87. | void                                   | :ref:`set_center_y<class_TileMap_set_center_y>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                                                                                            |
    88. 

  88. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    89. 

  89. | void                                   | :ref:`set_collision_bounce<class_TileMap_set_collision_bounce>`  **(** :ref:`float<class_float>` value  **)**                                                                                                                                           |
    90. 

  90. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    91. 

  91. | void                                   | :ref:`set_collision_friction<class_TileMap_set_collision_friction>`  **(** :ref:`float<class_float>` value  **)**                                                                                                                                       |
    92. 

  92. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    93. 

  93. | void                                   | :ref:`set_collision_layer<class_TileMap_set_collision_layer>`  **(** :ref:`int<class_int>` layer  **)**                                                                                                                                                 |
    94. 

  94. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    95. 

  95. | void                                   | :ref:`set_collision_layer_bit<class_TileMap_set_collision_layer_bit>`  **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value  **)**                                                                                                            |
    96. 

  96. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    97. 

  97. | void                                   | :ref:`set_collision_mask<class_TileMap_set_collision_mask>`  **(** :ref:`int<class_int>` mask  **)**                                                                                                                                                    |
    98. 

  98. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    99. 

  99. | void                                   | :ref:`set_collision_mask_bit<class_TileMap_set_collision_mask_bit>`  **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value  **)**                                                                                                              |
    100. 

  100. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    101. 

  101. | void                                   | :ref:`set_collision_use_kinematic<class_TileMap_set_collision_use_kinematic>`  **(** :ref:`bool<class_bool>` use_kinematic  **)**                                                                                                                       |
    102. 

  102. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    103. 

  103. | void                                   | :ref:`set_custom_transform<class_TileMap_set_custom_transform>`  **(** :ref:`Transform2D<class_transform2d>` custom_transform  **)**                                                                                                                    |
    104. 

  104. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    105. 

  105. | void                                   | :ref:`set_half_offset<class_TileMap_set_half_offset>`  **(** :ref:`int<class_int>` half_offset  **)**                                                                                                                                                   |
    106. 

  106. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    107. 

  107. | void                                   | :ref:`set_mode<class_TileMap_set_mode>`  **(** :ref:`int<class_int>` mode  **)**                                                                                                                                                                        |
    108. 

  108. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    109. 

  109. | void                                   | :ref:`set_occluder_light_mask<class_TileMap_set_occluder_light_mask>`  **(** :ref:`int<class_int>` mask  **)**                                                                                                                                          |
    110. 

  110. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    111. 

  111. | void                                   | :ref:`set_quadrant_size<class_TileMap_set_quadrant_size>`  **(** :ref:`int<class_int>` size  **)**                                                                                                                                                      |
    112. 

  112. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    113. 

  113. | void                                   | :ref:`set_tile_origin<class_TileMap_set_tile_origin>`  **(** :ref:`int<class_int>` origin  **)**                                                                                                                                                        |
    114. 

  114. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    115. 

  115. | void                                   | :ref:`set_tileset<class_TileMap_set_tileset>`  **(** :ref:`TileSet<class_tileset>` tileset  **)**                                                                                                                                                       |
    116. 

  116. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    117. 

  117. | void                                   | :ref:`set_y_sort_mode<class_TileMap_set_y_sort_mode>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                                                                                      |
    118. 

  118. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    119. 

  119. | :ref:`Vector2<class_vector2>`          | :ref:`world_to_map<class_TileMap_world_to_map>`  **(** :ref:`Vector2<class_vector2>` world_position  **)** const                                                                                                                                        |
    120. 

  120. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    121. 

  121. 

  122. Signals
    123. 

  123. -------
    124. 

  124. 

  125. -  **settings_changed**  **(** **)**
    126. 

  126. Emitted when a tilemap setting has changed.
    127. 

  127. 

  128. 

  129. Member Variables
    130. 

  130. ----------------
    131. 

  131. 

  132. - :ref:`Transform2D<class_transform2d>` **cell_custom_transform** - The custom [Transform2D] to be applied to the TileMap's cells.
    133. 

  133. - :ref:`int<class_int>` **cell_half_offset** - Amount to offset alternating tiles. Uses HALF_OFFSET_* constants. Default value: HALF_OFFSET_DISABLED.
    134. 

  134. - :ref:`int<class_int>` **cell_quadrant_size** - The TileMap's quadrant size.  Optimizes drawing by batching, using chunks of this size. Default value: 16.
    135. 

  135. - :ref:`Vector2<class_vector2>` **cell_size** - The TileMap's cell size.
    136. 

  136. - :ref:`int<class_int>` **cell_tile_origin** - Position for tile origin. Uses TILE_ORIGIN_* constants. Default value: TILE_ORIGIN_TOP_LEFT.
    137. 

  137. - :ref:`bool<class_bool>` **cell_y_sort** - If [code]true[/code] the TileMap's children will be drawn in order of their Y coordinate. Default value: [code]false[/code].
    138. 

  138. - :ref:`float<class_float>` **collision_bounce** - Bounce value for static body collisions (see [code]collision_use_kinematic[/code]). Default value: 0.
    139. 

  139. - :ref:`float<class_float>` **collision_friction** - Friction value for static body collisions (see [code]collision_use_kinematic[/code]). Default value: 1.
    140. 

  140. - :ref:`int<class_int>` **collision_layer** - The collision layer(s) for all colliders in the TileMap.
    141. 

  141. - :ref:`int<class_int>` **collision_mask** - The collision mask(s) for all colliders in the TileMap.
    142. 

  142. - :ref:`bool<class_bool>` **collision_use_kinematic** - If [code]true[/code] TileMap collisions will be handled as a kinematic body. If [code]false[/code] collisions will be handled as static body. Default value: [code]false[/code].
    143. 

  143. - :ref:`int<class_int>` **mode** - The TileMap orientation mode. Uses MODE_* constants. Default value: MODE_SQUARE.
    144. 

  144. - :ref:`int<class_int>` **occluder_light_mask** - The light mask assigned to all light occluders in the TileMap.  The TileSet's light occluders will cast shadows only from Light2D(s) that have the same light mask(s).
    145. 

  145. - :ref:`PoolIntArray<class_poolintarray>` **tile_data** - A [PoolIntArray] containing
    146. 

  146. - :ref:`TileSet<class_tileset>` **tile_set** - The assigned [TileSet].
    147. 

  147. 

  148. Numeric Constants
    149. 

  149. -----------------
    150. 

  150. 

  151. - **INVALID_CELL** = **-1** --- Returned when a cell doesn't exist.
    152. 

  152. - **MODE_SQUARE** = **0** --- Orthogonal orientation mode.
    153. 

  153. - **MODE_ISOMETRIC** = **1** --- Isometric orientation mode.
    154. 

  154. - **MODE_CUSTOM** = **2** --- Custom orientation mode.
    155. 

  155. - **HALF_OFFSET_X** = **0** --- Half offset on the X coordinate.
    156. 

  156. - **HALF_OFFSET_Y** = **1** --- Half offset on the Y coordinate.
    157. 

  157. - **HALF_OFFSET_DISABLED** = **2** --- Half offset disabled.
    158. 

  158. - **TILE_ORIGIN_TOP_LEFT** = **0** --- Tile origin at its top-left corner.
    159. 

  159. - **TILE_ORIGIN_CENTER** = **1** --- Tile origin at its center.
    160. 

  160. - **TILE_ORIGIN_BOTTOM_LEFT** = **2**
    161. 

  161. 

  162. Description
    163. 

  163. -----------
    164. 

  164. 

  165. Node for 2D tile-based maps. Tilemaps use a :ref:`TileSet<class_tileset>` which contain a list of tiles (textures plus optional collision, navigation, and/or occluder shapes) which are used to create grid-based maps.
    166. 

  166. 

  167. Member Function Description
    168. 

  168. ---------------------------
    169. 

  169. 

  170. .. _class_TileMap_clear:
    171. 

  171. 

  172. - void  **clear**  **(** **)**
    173. 

  173. 

  174. Clear all cells.
    175. 

  175. 

  176. .. _class_TileMap_get_cell:
    177. 

  177. 

  178. - :ref:`int<class_int>`  **get_cell**  **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y  **)** const
    179. 

  179. 

  180. Return the tile index of the referenced cell.
    181. 

  181. 

  182. .. _class_TileMap_get_cell_size:
    183. 

  183. 

  184. - :ref:`Vector2<class_vector2>`  **get_cell_size**  **(** **)** const
    185. 

  185. 

  186. Return the cell size.
    187. 

  187. 

  188. .. _class_TileMap_get_cellv:
    189. 

  189. 

  190. - :ref:`int<class_int>`  **get_cellv**  **(** :ref:`Vector2<class_vector2>` position  **)** const
    191. 

  191. 

  192. Return the tile index of the cell referenced by a Vector2.
    193. 

  193. 

  194. .. _class_TileMap_get_center_x:
    195. 

  195. 

  196. - :ref:`bool<class_bool>`  **get_center_x**  **(** **)** const
    197. 

  197. 

  198. Return true if tiles are to be centered in x coordinate (by default this is false and they are drawn from upper left cell corner).
    199. 

  199. 

  200. .. _class_TileMap_get_center_y:
    201. 

  201. 

  202. - :ref:`bool<class_bool>`  **get_center_y**  **(** **)** const
    203. 

  203. 

  204. Return true if tiles are to be centered in y coordinate (by default this is false and they are drawn from upper left cell corner).
    205. 

  205. 

  206. .. _class_TileMap_get_collision_bounce:
    207. 

  207. 

  208. - :ref:`float<class_float>`  **get_collision_bounce**  **(** **)** const
    209. 

  209. 

  210. Return the collision bounce parameter.
    211. 

  211. 

  212. .. _class_TileMap_get_collision_friction:
    213. 

  213. 

  214. - :ref:`float<class_float>`  **get_collision_friction**  **(** **)** const
    215. 

  215. 

  216. Return the collision friction parameter.
    217. 

  217. 

  218. .. _class_TileMap_get_collision_layer:
    219. 

  219. 

  220. - :ref:`int<class_int>`  **get_collision_layer**  **(** **)** const
    221. 

  221. 

  222. Return the collision layer.
    223. 

  223. 

  224. .. _class_TileMap_get_collision_layer_bit:
    225. 

  225. 

  226. - :ref:`bool<class_bool>`  **get_collision_layer_bit**  **(** :ref:`int<class_int>` bit  **)** const
    227. 

  227. 

  228. .. _class_TileMap_get_collision_mask:
    229. 

  229. 

  230. - :ref:`int<class_int>`  **get_collision_mask**  **(** **)** const
    231. 

  231. 

  232. Return the collision mask.
    233. 

  233. 

  234. .. _class_TileMap_get_collision_mask_bit:
    235. 

  235. 

  236. - :ref:`bool<class_bool>`  **get_collision_mask_bit**  **(** :ref:`int<class_int>` bit  **)** const
    237. 

  237. 

  238. .. _class_TileMap_get_collision_use_kinematic:
    239. 

  239. 

  240. - :ref:`bool<class_bool>`  **get_collision_use_kinematic**  **(** **)** const
    241. 

  241. 

  242. Return whether the tilemap handles collisions as a kinematic body.
    243. 

  243. 

  244. .. _class_TileMap_get_custom_transform:
    245. 

  245. 

  246. - :ref:`Transform2D<class_transform2d>`  **get_custom_transform**  **(** **)** const
    247. 

  247. 

  248. Return the custom transform matrix.
    249. 

  249. 

  250. .. _class_TileMap_get_half_offset:
    251. 

  251. 

  252. - :ref:`int<class_int>`  **get_half_offset**  **(** **)** const
    253. 

  253. 

  254. Return the current half offset configuration.
    255. 

  255. 

  256. .. _class_TileMap_get_mode:
    257. 

  257. 

  258. - :ref:`int<class_int>`  **get_mode**  **(** **)** const
    259. 

  259. 

  260. Return the orientation mode.
    261. 

  261. 

  262. .. _class_TileMap_get_occluder_light_mask:
    263. 

  263. 

  264. - :ref:`int<class_int>`  **get_occluder_light_mask**  **(** **)** const
    265. 

  265. 

  266. .. _class_TileMap_get_quadrant_size:
    267. 

  267. 

  268. - :ref:`int<class_int>`  **get_quadrant_size**  **(** **)** const
    269. 

  269. 

  270. Return the quadrant size.
    271. 

  271. 

  272. .. _class_TileMap_get_tile_origin:
    273. 

  273. 

  274. - :ref:`int<class_int>`  **get_tile_origin**  **(** **)** const
    275. 

  275. 

  276. Return the tile origin configuration.
    277. 

  277. 

  278. .. _class_TileMap_get_tileset:
    279. 

  279. 

  280. - :ref:`TileSet<class_tileset>`  **get_tileset**  **(** **)** const
    281. 

  281. 

  282. Return the current tileset.
    283. 

  283. 

  284. .. _class_TileMap_get_used_cells:
    285. 

  285. 

  286. - :ref:`Array<class_array>`  **get_used_cells**  **(** **)** const
    287. 

  287. 

  288. Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1).
    289. 

  289. 

  290. .. _class_TileMap_get_used_cells_by_id:
    291. 

  291. 

  292. - :ref:`Array<class_array>`  **get_used_cells_by_id**  **(** :ref:`int<class_int>` id  **)** const
    293. 

  293. 

  294. .. _class_TileMap_get_used_rect:
    295. 

  295. 

  296. - :ref:`Rect2<class_rect2>`  **get_used_rect**  **(** **)**
    297. 

  297. 

  298. .. _class_TileMap_is_cell_transposed:
    299. 

  299. 

  300. - :ref:`bool<class_bool>`  **is_cell_transposed**  **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y  **)** const
    301. 

  301. 

  302. Return whether the referenced cell is transposed, i.e. the X and Y axes are swapped (mirroring with regard to the (1,1) vector).
    303. 

  303. 

  304. .. _class_TileMap_is_cell_x_flipped:
    305. 

  305. 

  306. - :ref:`bool<class_bool>`  **is_cell_x_flipped**  **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y  **)** const
    307. 

  307. 

  308. Return whether the referenced cell is flipped over the X axis.
    309. 

  309. 

  310. .. _class_TileMap_is_cell_y_flipped:
    311. 

  311. 

  312. - :ref:`bool<class_bool>`  **is_cell_y_flipped**  **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y  **)** const
    313. 

  313. 

  314. Return whether the referenced cell is flipped over the Y axis.
    315. 

  315. 

  316. .. _class_TileMap_is_y_sort_mode_enabled:
    317. 

  317. 

  318. - :ref:`bool<class_bool>`  **is_y_sort_mode_enabled**  **(** **)** const
    319. 

  319. 

  320. Return the Y sort mode.
    321. 

  321. 

  322. .. _class_TileMap_map_to_world:
    323. 

  323. 

  324. - :ref:`Vector2<class_vector2>`  **map_to_world**  **(** :ref:`Vector2<class_vector2>` map_position, :ref:`bool<class_bool>` ignore_half_ofs=false  **)** const
    325. 

  325. 

  326. Return the absolute world position corresponding to the tilemap (grid-based) coordinates given as an argument.
    327. 

  327. 

  328. Optionally, the tilemap's potential half offset can be ignored.
    329. 

  329. 

  330. .. _class_TileMap_set_cell:
    331. 

  331. 

  332. - void  **set_cell**  **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` tile, :ref:`bool<class_bool>` flip_x=false, :ref:`bool<class_bool>` flip_y=false, :ref:`bool<class_bool>` transpose=false  **)**
    333. 

  333. 

  334. Set the tile index for the cell referenced by its grid-based X and Y coordinates.
    335. 

  335. 

  336. A tile index of -1 clears the cell.
    337. 

  337. 

  338. Optionally, the tile can also be flipped over the X and Y coordinates or transposed.
    339. 

  339. 

  340. .. _class_TileMap_set_cell_size:
    341. 

  341. 

  342. - void  **set_cell_size**  **(** :ref:`Vector2<class_vector2>` size  **)**
    343. 

  343. 

  344. Set the cell size.
    345. 

  345. 

  346. .. _class_TileMap_set_cellv:
    347. 

  347. 

  348. - void  **set_cellv**  **(** :ref:`Vector2<class_vector2>` position, :ref:`int<class_int>` tile, :ref:`bool<class_bool>` flip_x=false, :ref:`bool<class_bool>` flip_y=false, :ref:`bool<class_bool>` transpose=false  **)**
    349. 

  349. 

  350. Set the tile index for the cell referenced by a Vector2 of grid-based coordinates.
    351. 

  351. 

  352. A tile index of -1 clears the cell.
    353. 

  353. 

  354. Optionally, the tile can also be flipped over the X and Y axes or transposed.
    355. 

  355. 

  356. .. _class_TileMap_set_center_x:
    357. 

  357. 

  358. - void  **set_center_x**  **(** :ref:`bool<class_bool>` enable  **)**
    359. 

  359. 

  360. Set tiles to be centered in x coordinate. (by default this is false and they are drawn from upper left cell corner).
    361. 

  361. 

  362. .. _class_TileMap_set_center_y:
    363. 

  363. 

  364. - void  **set_center_y**  **(** :ref:`bool<class_bool>` enable  **)**
    365. 

  365. 

  366. Set tiles to be centered in y coordinate. (by default this is false and they are drawn from upper left cell corner).
    367. 

  367. 

  368. .. _class_TileMap_set_collision_bounce:
    369. 

  369. 

  370. - void  **set_collision_bounce**  **(** :ref:`float<class_float>` value  **)**
    371. 

  371. 

  372. Set the collision bounce parameter. Allowable values range from 0 to 1.
    373. 

  373. 

  374. .. _class_TileMap_set_collision_friction:
    375. 

  375. 

  376. - void  **set_collision_friction**  **(** :ref:`float<class_float>` value  **)**
    377. 

  377. 

  378. Set the collision friction parameter. Allowable values range from 0 to 1.
    379. 

  379. 

  380. .. _class_TileMap_set_collision_layer:
    381. 

  381. 

  382. - void  **set_collision_layer**  **(** :ref:`int<class_int>` layer  **)**
    383. 

  383. 

  384. Set the collision layer.
    385. 

  385. 

  386. Layers are referenced by binary indexes, so allowable values to describe the 20 available layers range from 0 to 2^20-1.
    387. 

  387. 

  388. .. _class_TileMap_set_collision_layer_bit:
    389. 

  389. 

  390. - void  **set_collision_layer_bit**  **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value  **)**
    391. 

  391. 

  392. .. _class_TileMap_set_collision_mask:
    393. 

  393. 

  394. - void  **set_collision_mask**  **(** :ref:`int<class_int>` mask  **)**
    395. 

  395. 

  396. Set the collision masks.
    397. 

  397. 

  398. Masks are referenced by binary indexes, so allowable values to describe the 20 available masks range from 0 to 2^20-1.
    399. 

  399. 

  400. .. _class_TileMap_set_collision_mask_bit:
    401. 

  401. 

  402. - void  **set_collision_mask_bit**  **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value  **)**
    403. 

  403. 

  404. .. _class_TileMap_set_collision_use_kinematic:
    405. 

  405. 

  406. - void  **set_collision_use_kinematic**  **(** :ref:`bool<class_bool>` use_kinematic  **)**
    407. 

  407. 

  408. Set the tilemap to handle collisions as a kinematic body (enabled) or a static body (disabled).
    409. 

  409. 

  410. .. _class_TileMap_set_custom_transform:
    411. 

  411. 

  412. - void  **set_custom_transform**  **(** :ref:`Transform2D<class_transform2d>` custom_transform  **)**
    413. 

  413. 

  414. Set custom transform matrix, to use in combination with the custom orientation mode.
    415. 

  415. 

  416. .. _class_TileMap_set_half_offset:
    417. 

  417. 

  418. - void  **set_half_offset**  **(** :ref:`int<class_int>` half_offset  **)**
    419. 

  419. 

  420. Set a half offset on the X coordinate, Y coordinate, or none (use HALF_OFFSET\_\* constants as argument).
    421. 

  421. 

  422. Half offset sets every other tile off by a half tile size in the specified direction.
    423. 

  423. 

  424. .. _class_TileMap_set_mode:
    425. 

  425. 

  426. - void  **set_mode**  **(** :ref:`int<class_int>` mode  **)**
    427. 

  427. 

  428. Set the orientation mode as square, isometric or custom (use MODE\_\* constants as argument).
    429. 

  429. 

  430. .. _class_TileMap_set_occluder_light_mask:
    431. 

  431. 

  432. - void  **set_occluder_light_mask**  **(** :ref:`int<class_int>` mask  **)**
    433. 

  433. 

  434. .. _class_TileMap_set_quadrant_size:
    435. 

  435. 

  436. - void  **set_quadrant_size**  **(** :ref:`int<class_int>` size  **)**
    437. 

  437. 

  438. Set the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time.
    439. 

  439. 

  440. Allowed values are integers ranging from 1 to 128.
    441. 

  441. 

  442. .. _class_TileMap_set_tile_origin:
    443. 

  443. 

  444. - void  **set_tile_origin**  **(** :ref:`int<class_int>` origin  **)**
    445. 

  445. 

  446. Set the tile origin to the tile center or its top-left corner (use TILE_ORIGIN\_\* constants as argument).
    447. 

  447. 

  448. .. _class_TileMap_set_tileset:
    449. 

  449. 

  450. - void  **set_tileset**  **(** :ref:`TileSet<class_tileset>` tileset  **)**
    451. 

  451. 

  452. Set the current tileset.
    453. 

  453. 

  454. .. _class_TileMap_set_y_sort_mode:
    455. 

  455. 

  456. - void  **set_y_sort_mode**  **(** :ref:`bool<class_bool>` enable  **)**
    457. 

  457. 

  458. 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.
    459. 

  459. 

  460. 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.
    461. 

  461. 

  462. .. _class_TileMap_world_to_map:
    463. 

  463. 

  464. - :ref:`Vector2<class_vector2>`  **world_to_map**  **(** :ref:`Vector2<class_vector2>` world_position  **)** const
    465. 

  465. 

  466. Return the tilemap (grid-based) coordinates corresponding to the absolute world position given as an argument.
    467. 

  467. 

  468.