asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: Clarify TileMap world_to_map and map_to_world usage

Browse source 
Per discussion in #38551.
Fixes #31663.
Fixes #37394.
This commit is contained in:
David Buchmann 2021-02-12 11:20:35 +01:00
parent ece69f8208
commit 26e2eaf068
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/classes/TileMap.xml
View file

@ -144,7 +144,12 @@
<argument index="1" name="ignore_half_ofs" type="bool" default="false">
</argument>
<description>
Returns the local position corresponding to the given tilemap (grid-based) coordinates.
Returns the local position of the top left corner of the cell corresponding to the given tilemap (grid-based) coordinates.
To get the global position, use [method Node2D.to_global]:
[codeblock]
var local_position = my_tilemap.map_to_world(map_position)
var global_position = my_tilemap.to_global(local_position)
[/codeblock]
Optionally, the tilemap's half offset can be ignored.
</description>
</method>
@ -258,6 +263,11 @@
</argument>
<description>
Returns the tilemap (grid-based) coordinates corresponding to the given local position.
To use this with a global position, first determine the local position with [method Node2D.to_local]:
[codeblock]
var local_position = my_tilemap.to_local(global_position)
var map_position = my_tilemap.world_to_map(local_position)
[/codeblock]
</description>
</method>
</methods>