godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/TileMap.xml

225 lines
8.2 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Update docs to version 4.0
2020-02-01 01:03:48 +00:00
<class name="TileMap" inherits="Node2D" version="4.0">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Node for 2D tile-based maps.
</brief_description>
<description>
Node for 2D tile-based maps. Tilemaps use a [TileSet] which contain a list of tiles (textures plus optional collision, navigation, and/or occluder shapes) which are used to create grid-based maps.
Document shape metadata for `TileMap`
2021-01-22 18:03:09 +00:00
When doing physics queries against the tilemap, the cell coordinates are encoded as [code]metadata[/code] for each detected collision shape returned by methods such as [method PhysicsDirectSpaceState2D.intersect_shape], [method PhysicsDirectBodyState2D.get_contact_collider_shape_metadata] etc.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
Add link titles for all links in the class reference This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.)
2020-08-05 12:43:40 +00:00
<link title="Using Tilemaps">https://docs.godotengine.org/en/latest/tutorials/2d/using_tilemaps.html</link>
Link to demos from within the class reference
2020-10-01 08:34:47 +00:00
<link title="2D Platformer Demo">https://godotengine.org/asset-library/asset/120</link>
<link title="2D Isometric Demo">https://godotengine.org/asset-library/asset/112</link>
<link title="2D Hexagonal Demo">https://godotengine.org/asset-library/asset/111</link>
<link title="2D Navigation Astar Demo">https://godotengine.org/asset-library/asset/519</link>
<link title="2D Role Playing Game Demo">https://godotengine.org/asset-library/asset/520</link>
<link title="2D Kinematic Character Demo">https://godotengine.org/asset-library/asset/113</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</tutorials>
<methods>
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<method name="add_layer">
<return type="void" />
<argument index="0" name="arg0" type="int" />
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="clear">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[DOCS] Vector2/Vector3/TileMap wording fixes
2018-05-13 00:58:45 +00:00
Clears all cells.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
TileMap: add fix_invalid_tiles
2018-02-24 05:56:48 +00:00
<method name="fix_invalid_tiles">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
TileMap: add fix_invalid_tiles
2018-02-24 05:56:48 +00:00
<description>
[DOCS] Vector2/Vector3/TileMap wording fixes
2018-05-13 00:58:45 +00:00
Clears cells that do not exist in the tileset.
TileMap: add fix_invalid_tiles
2018-02-24 05:56:48 +00:00
</description>
</method>
Rework the TileSet resource and TileMap nodes: - Move most properties from TileMap to TileSet, - Make TileSet more flexible, supporting more feature (several collision layers, etc...), - Fusion both the TileMap and TileSet editor, - Implement TileSetSources, and thus a new way to index tiles in the TileSet, - Rework the TileSet and TileMap editors completely, - Implement an editor zoom widget (and use it in several places)
2021-05-07 13:41:39 +00:00
<method name="get_cell_alternative_tile" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<argument index="0" name="layer" type="int" />
<argument index="1" name="coords" type="Vector2i" />
<argument index="2" name="use_proxies" type="bool" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
</description>
</method>
Rework the TileSet resource and TileMap nodes: - Move most properties from TileMap to TileSet, - Make TileSet more flexible, supporting more feature (several collision layers, etc...), - Fusion both the TileMap and TileSet editor, - Implement TileSetSources, and thus a new way to index tiles in the TileSet, - Rework the TileSet and TileMap editors completely, - Implement an editor zoom widget (and use it in several places)
2021-05-07 13:41:39 +00:00
<method name="get_cell_atlas_coords" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<argument index="0" name="layer" type="int" />
<argument index="1" name="coords" type="Vector2i" />
<argument index="2" name="use_proxies" type="bool" />
doc: Sync classref with current source Fix various code formatting issues and argument names.
2018-12-27 10:10:09 +00:00
<description>
</description>
</method>
Rework the TileSet resource and TileMap nodes: - Move most properties from TileMap to TileSet, - Make TileSet more flexible, supporting more feature (several collision layers, etc...), - Fusion both the TileMap and TileSet editor, - Implement TileSetSources, and thus a new way to index tiles in the TileSet, - Rework the TileSet and TileMap editors completely, - Implement an editor zoom widget (and use it in several places)
2021-05-07 13:41:39 +00:00
<method name="get_cell_source_id" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<argument index="0" name="layer" type="int" />
<argument index="1" name="coords" type="Vector2i" />
<argument index="2" name="use_proxies" type="bool" />
<description>
</description>
</method>
<method name="get_layer_name" qualifiers="const">
<return type="String" />
<argument index="0" name="layer" type="int" />
<description>
</description>
</method>
<method name="get_layer_y_sort_origin" qualifiers="const">
<return type="int" />
<argument index="0" name="layer" type="int" />
<description>
</description>
</method>
<method name="get_layer_z_indexd" qualifiers="const">
<return type="int" />
<argument index="0" name="layer" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
</description>
</method>
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<method name="get_layers_count" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
Rework the TileSet resource and TileMap nodes: - Move most properties from TileMap to TileSet, - Make TileSet more flexible, supporting more feature (several collision layers, etc...), - Fusion both the TileMap and TileSet editor, - Implement TileSetSources, and thus a new way to index tiles in the TileSet, - Rework the TileSet and TileMap editors completely, - Implement an editor zoom widget (and use it in several places)
2021-05-07 13:41:39 +00:00
<method name="get_neighbor_cell" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="coords" type="Vector2i" />
<argument index="1" name="neighbor" type="int" enum="TileSet.CellNeighbor" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
</description>
</method>
Rework the TileSet resource and TileMap nodes: - Move most properties from TileMap to TileSet, - Make TileSet more flexible, supporting more feature (several collision layers, etc...), - Fusion both the TileMap and TileSet editor, - Implement TileSetSources, and thus a new way to index tiles in the TileSet, - Rework the TileSet and TileMap editors completely, - Implement an editor zoom widget (and use it in several places)
2021-05-07 13:41:39 +00:00
<method name="get_surrounding_tiles">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i[]" />
<argument index="0" name="coords" type="Vector2i" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
</description>
</method>
<method name="get_used_cells" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i[]" />
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<argument index="0" name="layer" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Improve TileMap.get_used_cells docs.
2018-08-03 18:38:31 +00:00
Returns a [Vector2] array with the positions of all cells containing a tile from the tileset (i.e. a tile index different from [code]-1[/code]).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_used_rect">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Rect2" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Sync classref with current source Also fix binding of Basis.slerp
2018-05-28 12:53:15 +00:00
Returns a rectangle enclosing the used (non-empty) tiles of the map.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<method name="is_layer_enabled" qualifiers="const">
<return type="bool" />
<argument index="0" name="layer" type="int" />
<description>
</description>
</method>
<method name="is_layer_y_sort_enabled" qualifiers="const">
<return type="bool" />
<argument index="0" name="layer" type="int" />
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="map_to_world" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2" />
<argument index="0" name="map_position" type="Vector2i" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Update TileMap to use Vector2i instead of two ints
2020-06-30 06:34:15 +00:00
Returns the local position corresponding to the given tilemap (grid-based) coordinates.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<method name="move_layer">
<return type="void" />
<argument index="0" name="arg0" type="int" />
<argument index="1" name="arg1" type="int" />
<description>
</description>
</method>
<method name="remove_layer">
<return type="void" />
<argument index="0" name="arg0" type="int" />
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="set_cell">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<argument index="0" name="layer" type="int" />
<argument index="1" name="coords" type="Vector2i" />
<argument index="2" name="source_id" type="int" default="-1" />
<argument index="3" name="atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" />
<argument index="4" name="alternative_tile" type="int" default="-1" />
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +00:00
<description>
Update TileMap to use Vector2i instead of two ints
2020-06-30 06:34:15 +00:00
Sets the tile index for the cell given by a Vector2i.
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +00:00
</description>
</method>
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<method name="set_layer_enabled">
<return type="void" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="enabled" type="bool" />
<description>
</description>
</method>
<method name="set_layer_name">
<return type="void" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="name" type="String" />
<description>
</description>
</method>
<method name="set_layer_y_sort_enabled">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<argument index="0" name="layer" type="int" />
<argument index="1" name="y_sort_enabled" type="bool" />
<description>
</description>
</method>
<method name="set_layer_y_sort_origin">
<return type="void" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="y_sort_origin" type="int" />
<description>
</description>
</method>
<method name="set_layer_z_index">
<return type="void" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="z_index" type="int" />
Defer TileMap::update_dirty_quadrants once again. This fixes #20323. #11077 is now technically re-broken, but you can now call update_dirty_quadrants as workaround.
2018-07-22 13:26:14 +00:00
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="world_to_map" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="world_position" type="Vector2" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Docs: Fix TileMap::world_to_map description
2019-01-19 14:23:49 +00:00
Returns the tilemap (grid-based) coordinates corresponding to the given local position.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="cell_quadrant_size" type="int" setter="set_quadrant_size" getter="get_quadrant_size" default="16">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 13:24:23 +00:00
The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<member name="collision_visibility_mode" type="int" setter="set_collision_visibility_mode" getter="get_collision_visibility_mode" enum="TileMap.VisibilityMode" default="0">
</member>
<member name="navigation_visibility_mode" type="int" setter="set_navigation_visibility_mode" getter="get_navigation_visibility_mode" enum="TileMap.VisibilityMode" default="0">
Restore a way to show collsion/navigation on TileMap. Also remove an unused function.
2021-05-24 10:33:22 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="tile_set" type="TileSet" setter="set_tileset" getter="get_tileset">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
The assigned [TileSet].
</member>
</members>
<signals>
Rework the TileSet resource and TileMap nodes: - Move most properties from TileMap to TileSet, - Make TileSet more flexible, supporting more feature (several collision layers, etc...), - Fusion both the TileMap and TileSet editor, - Implement TileSetSources, and thus a new way to index tiles in the TileSet, - Rework the TileSet and TileMap editors completely, - Implement an editor zoom widget (and use it in several places)
2021-05-07 13:41:39 +00:00
<signal name="changed">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Update TileMap to use Vector2i instead of two ints
2020-06-30 06:34:15 +00:00
Emitted when the [TileSet] of this TileMap changes.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
</signals>
<constants>
Restore a way to show collsion/navigation on TileMap. Also remove an unused function.
2021-05-24 10:33:22 +00:00
<constant name="VISIBILITY_MODE_DEFAULT" value="0" enum="VisibilityMode">
</constant>
<constant name="VISIBILITY_MODE_FORCE_HIDE" value="2" enum="VisibilityMode">
</constant>
<constant name="VISIBILITY_MODE_FORCE_SHOW" value="1" enum="VisibilityMode">
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constants>
</class>