summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2018-07-22 16:09:08 +0200
committerGitHub <noreply@github.com>2018-07-22 16:09:08 +0200
commitc02f639aa5dbb1a9fb251bb996151ae4771a7178 (patch)
tree2f5edaf0eb3bfa54964261d1e846a99abce26041 /doc/classes
parent790a81d715e00cb4e58ffe2a77743c3b620b5642 (diff)
parentb2c797c584fea1933b9c9d1c237a09cad6e088ed (diff)
Merge pull request #20352 from PJB3005/18-07-22-defer-tile-quad-update
Fix TileMap::set_cell performance regression
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/TileMap.xml11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml
index 656063771d..3486b721ca 100644
--- a/doc/classes/TileMap.xml
+++ b/doc/classes/TileMap.xml
@@ -153,6 +153,8 @@
Sets the tile index for the cell given by a Vector2.
An index of [code]-1[/code] clears the cell.
Optionally, the tile can also be flipped, transposed, or given autotile coordinates.
+ Note that data such as navigation polygons and collision shapes are not immediately updated for performance reasons.
+ If you need these to be immediately updated, you can call [method update_dirty_quadrants].
</description>
</method>
<method name="set_cellv">
@@ -172,6 +174,8 @@
Sets the tile index for the given cell.
An index of [code]-1[/code] clears the cell.
Optionally, the tile can also be flipped or transposed.
+ Note that data such as navigation polygons and collision shapes are not immediately updated for performance reasons.
+ If you need these to be immediately updated, you can call [method update_dirty_quadrants].
</description>
</method>
<method name="set_collision_layer_bit">
@@ -217,6 +221,13 @@
Calling with invalid (or missing) parameters applies autotiling rules for the entire tilemap.
</description>
</method>
+ <method name="update_dirty_quadrants">
+ <return type="void">
+ </return>
+ <description>
+ Updates the tile map's quadrants, allowing things such as navigation and collision shapes to be immediately used if modified.
+ </description>
+ </method>
<method name="world_to_map" qualifiers="const">
<return type="Vector2">
</return>