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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

727 lines
32 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" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 13:18:53 +00:00
<class name="TileSet" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
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>
Tile library for tilemaps.
</brief_description>
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
A TileSet is a library of tiles for a [TileMap]. A TileSet handles a list of [TileSetSource], each of them storing a set of tiles.
Tiles can either be from a [TileSetAtlasSource], that render tiles out of a texture with support for physics, navigation, etc... or from a [TileSetScenesCollectionSource] which exposes scene-based tiles.
Tiles are referenced by using three IDs: their source ID, their atlas coordinates ID and their alternative tile ID.
A TileSet can be configured so that its tiles expose more or less properties. To do so, the TileSet resources uses property layers, that you can add or remove depending on your needs.
Fixed various typos across the docs (cherry picked from commit 8106d33d0f13825b4459898ca20282ba5b543897)
2023-05-01 22:09:49 +00:00
For example, adding a physics layer allows giving collision shapes to your tiles. Each layer having dedicated properties (physics layer and mask), you may add several TileSet physics layers for each type of collision you need.
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
See the functions to add new layers for more information.
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>
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 09:43:07 +00:00
<link title="Using Tilemaps">$DOCS_URL/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_custom_data_layer">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="to_position" type="int" default="-1" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Adds a custom data layer to the TileSet at the given position [param to_position] in the array. If [param to_position] is -1, adds it at the end of the array.
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Custom data layers allow assigning custom properties to atlas tiles.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
<method name="add_navigation_layer">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="to_position" type="int" default="-1" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Adds a navigation layer to the TileSet at the given position [param to_position] in the array. If [param to_position] is -1, adds it at the end of the array.
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Navigation layers allow assigning a navigable area to atlas tiles.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
<method name="add_occlusion_layer">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="to_position" type="int" default="-1" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Adds an occlusion layer to the TileSet at the given position [param to_position] in the array. If [param to_position] is -1, adds it at the end of the array.
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Occlusion layers allow assigning occlusion polygons to atlas tiles.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
Implement TileMap patterns palette
2021-09-29 15:48:27 +00:00
<method name="add_pattern">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="pattern" type="TileMapPattern" />
<param index="1" name="index" type="int" default="-1" />
Implement TileMap patterns palette
2021-09-29 15:48:27 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Adds a [TileMapPattern] to be stored in the TileSet resource. If provided, insert it at the given [param index].
Implement TileMap patterns palette
2021-09-29 15:48:27 +00:00
</description>
</method>
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<method name="add_physics_layer">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="to_position" type="int" default="-1" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Adds a physics layer to the TileSet at the given position [param to_position] in the array. If [param to_position] is -1, adds it at the end of the array.
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Physics layers allow assigning collision polygons to atlas tiles.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +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="add_source">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="source" type="TileSetSource" />
<param index="1" name="atlas_source_id_override" type="int" default="-1" />
doc: Sync classref with current source
2017-11-24 08:16:27 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Adds a [TileSetSource] to the TileSet. If [param atlas_source_id_override] is not -1, also set its source ID. Otherwise, a unique identifier is automatically generated.
Fix various typos in the classref (cherry picked from commit 766807506c4f40bca1fafd16ac467a33694f6269)
2023-04-18 11:53:47 +00:00
The function returns the added source ID or -1 if the source could not be added.
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 16:20:49 +00:00
</description>
</method>
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<method name="add_terrain">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="terrain_set" type="int" />
<param index="1" name="to_position" type="int" default="-1" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Adds a new terrain to the given terrain set [param terrain_set] at the given position [param to_position] in the array. If [param to_position] is -1, adds it at the end of the array.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
<method name="add_terrain_set">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="to_position" type="int" default="-1" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Adds a new terrain set at the given position [param to_position] in the array. If [param to_position] is -1, adds it at the end of the array.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<method name="cleanup_invalid_tile_proxies">
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" />
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Clears tile proxies pointing to invalid tiles.
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
</description>
</method>
<method name="clear_tile_proxies">
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" />
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Clears all tile proxies.
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
</description>
</method>
<method name="get_alternative_level_tile_proxy">
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="Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="source_from" type="int" />
<param index="1" name="coords_from" type="Vector2i" />
<param index="2" name="alternative_from" type="int" />
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns the alternative-level proxy for the given identifiers. The returned array contains the three proxie's target identifiers (source ID, atlas coords ID and alternative tile ID).
If the TileSet has no proxy for the given identifiers, returns an empty Array.
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
</description>
</method>
<method name="get_coords_level_tile_proxy">
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="Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="source_from" type="int" />
<param index="1" name="coords_from" type="Vector2i" />
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<description>
Fix `get_coords_level_tile_proxy` description
2022-04-15 00:12:57 +00:00
Returns the coordinate-level proxy for the given identifiers. The returned array contains the two target identifiers of the proxy (source ID and atlas coordinates ID).
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
If the TileSet has no proxy for the given identifiers, returns an empty Array.
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
</description>
</method>
expose TileMap methods related to the name of custom data layers
2022-07-24 23:09:03 +00:00
<method name="get_custom_data_layer_by_name" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_name" type="String" />
expose TileMap methods related to the name of custom data layers
2022-07-24 23:09:03 +00:00
<description>
Returns the index of the custom data layer identified by the given name.
</description>
</method>
<method name="get_custom_data_layer_name" qualifiers="const">
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
expose TileMap methods related to the name of custom data layers
2022-07-24 23:09:03 +00:00
<description>
Returns the name of the custom data layer identified by the given index.
</description>
</method>
<method name="get_custom_data_layer_type" qualifiers="const">
<return type="int" enum="Variant.Type" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
expose TileMap methods related to the name of custom data layers
2022-07-24 23:09:03 +00:00
<description>
Returns the type of the custom data layer identified by the given index.
</description>
</method>
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<method name="get_custom_data_layers_count" qualifiers="const">
<return type="int" />
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns the custom data layers count.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
Add TileSet helper functions to set/get navigation layer values Adds helper functions to TileSet to set / get navigation layers bitmask values.
2023-01-27 00:30:27 +00:00
<method name="get_navigation_layer_layer_value" qualifiers="const">
<return type="bool" />
<param index="0" name="layer_index" type="int" />
<param index="1" name="layer_number" type="int" />
<description>
Returns whether or not the specified navigation layer of the TileSet navigation data layer identified by the given [param layer_index] is enabled, given a navigation_layers [param layer_number] between 1 and 32.
</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_navigation_layer_layers" 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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 16:20:49 +00:00
<description>
Fix typos and inconsistencies in classref (cherry picked from commit 57d4272984fc0dd4c668503ead82a9dd01020bfd)
2023-03-16 05:56:09 +00:00
Returns the navigation layers (as in the Navigation server) of the given TileSet navigation layer.
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 16:20:49 +00:00
</description>
</method>
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<method name="get_navigation_layers_count" qualifiers="const">
<return type="int" />
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns the navigation layers count.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +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_next_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" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 16:20:49 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns a new unused source ID. This generated ID is the same that a call to [code]add_source[/code] would return.
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 16:20:49 +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_occlusion_layer_light_mask" 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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 16:20:49 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns the light mask of the occlusion layer.
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 16:20:49 +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_occlusion_layer_sdf_collision" 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="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
DocData: Fix return type listed as "var" instead of "Variant"
2018-08-31 20:38:28 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns if the occluders from this layer use [code]sdf_collision[/code].
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 16:20:49 +00:00
</description>
</method>
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<method name="get_occlusion_layers_count" qualifiers="const">
<return type="int" />
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns the occlusion layers count.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
Implement TileMap patterns palette
2021-09-29 15:48:27 +00:00
<method name="get_pattern">
<return type="TileMapPattern" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="index" type="int" default="-1" />
Implement TileMap patterns palette
2021-09-29 15:48:27 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the [TileMapPattern] at the given [param index].
Implement TileMap patterns palette
2021-09-29 15:48:27 +00:00
</description>
</method>
<method name="get_patterns_count">
<return type="int" />
<description>
Returns the number of [TileMapPattern] this tile set handles.
</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_physics_layer_collision_layer" 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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 16:20:49 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns the collision layer (as in the physics server) bodies on the given TileSet's physics layer are in.
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 16:20:49 +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_physics_layer_collision_mask" 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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 16:20:49 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns the collision mask of bodies on the given TileSet's physics layer.
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 16:20:49 +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_physics_layer_physics_material" 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="PhysicsMaterial" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 16:20:49 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns the physics material of bodies on the given TileSet's physics layer.
DocData: Fix return type listed as "var" instead of "Variant"
2018-08-31 20:38:28 +00:00
</description>
</method>
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<method name="get_physics_layers_count" qualifiers="const">
<return type="int" />
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns the physics layers count.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +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_source" 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="TileSetSource" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="source_id" 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>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the [TileSetSource] with ID [param source_id].
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>
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_source_count" 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" />
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>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns the number of [TileSetSource] in this 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
</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_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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="index" 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>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the source ID for source with index [param index].
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 atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<method name="get_source_level_tile_proxy">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="source_from" type="int" />
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns the source-level proxy for the given source identifier.
If the TileSet has no proxy for the given identifier, returns -1.
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +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_terrain_color" 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="Color" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="terrain_set" type="int" />
<param index="1" name="terrain_index" 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>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns a terrain's color.
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>
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_terrain_name" 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="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="terrain_set" type="int" />
<param index="1" name="terrain_index" 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>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns a terrain's name.
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>
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_terrain_set_mode" 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" enum="TileSet.TerrainMode" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="terrain_set" 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>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns a terrain set mode.
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="get_terrain_sets_count" qualifiers="const">
<return type="int" />
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns the terrain sets count.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +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_terrains_count" 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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="terrain_set" type="int" />
doc: Sync classref with current source
2018-08-29 20:25:11 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns the number of terrains in the given terrain set.
doc: Sync classref with current source
2018-08-29 20:25:11 +00:00
</description>
</method>
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<method name="has_alternative_level_tile_proxy">
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="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="source_from" type="int" />
<param index="1" name="coords_from" type="Vector2i" />
<param index="2" name="alternative_from" type="int" />
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<description>
More class reference fixes Mostly typos. Also renamed the remaining "Vulkan Clustered" to "Forward+".
2023-02-24 02:42:07 +00:00
Returns if there is an alternative-level proxy for the given identifiers.
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
</description>
</method>
<method name="has_coords_level_tile_proxy">
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="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="source_from" type="int" />
<param index="1" name="coords_from" type="Vector2i" />
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns if there is a coodinates-level proxy for the given identifiers.
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +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="has_source" 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="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="source_id" type="int" />
doc: Sync classref with current source
2018-04-10 08:12:42 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns if this TileSet has a source for the given source ID.
doc: Sync classref with current source
2018-04-10 08:12:42 +00:00
</description>
</method>
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<method name="has_source_level_tile_proxy">
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="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="source_from" type="int" />
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns if there is a source-level proxy for the given source ID.
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
</description>
</method>
<method name="map_tile_proxy" 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="Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="source_from" type="int" />
<param index="1" name="coords_from" type="Vector2i" />
<param index="2" name="alternative_from" type="int" />
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
According to the configured proxies, maps the provided indentifiers to a new set of identifiers. The source ID, atlas coordinates ID and alternative tile ID are returned as a 3 elements Array.
This function first look for matching alternative-level proxies, then coordinates-level proxies, then source-level proxies.
If no proxy corresponding to provided identifiers are found, returns the same values the ones used as arguments.
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
</description>
</method>
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<method name="move_custom_data_layer">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
<param index="1" name="to_position" type="int" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Moves the custom data layer at index [param layer_index] to the given position [param to_position] in the array. Also updates the atlas tiles accordingly.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
<method name="move_navigation_layer">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
<param index="1" name="to_position" type="int" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Moves the navigation layer at index [param layer_index] to the given position [param to_position] in the array. Also updates the atlas tiles accordingly.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
<method name="move_occlusion_layer">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
<param index="1" name="to_position" type="int" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Moves the occlusion layer at index [param layer_index] to the given position [param to_position] in the array. Also updates the atlas tiles accordingly.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
<method name="move_physics_layer">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
<param index="1" name="to_position" type="int" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Moves the physics layer at index [param layer_index] to the given position [param to_position] in the array. Also updates the atlas tiles accordingly.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
<method name="move_terrain">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="terrain_set" type="int" />
<param index="1" name="terrain_index" type="int" />
<param index="2" name="to_position" type="int" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Moves the terrain at index [param terrain_index] for terrain set [param terrain_set] to the given position [param to_position] in the array. Also updates the atlas tiles accordingly.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
<method name="move_terrain_set">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="terrain_set" type="int" />
<param index="1" name="to_position" type="int" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Moves the terrain set at index [param terrain_set] to the given position [param to_position] in the array. Also updates the atlas tiles accordingly.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<method name="remove_alternative_level_tile_proxy">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="source_from" type="int" />
<param index="1" name="coords_from" type="Vector2i" />
<param index="2" name="alternative_from" type="int" />
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Removes an alternative-level proxy for the given identifiers.
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
</description>
</method>
<method name="remove_coords_level_tile_proxy">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="source_from" type="int" />
<param index="1" name="coords_from" type="Vector2i" />
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Removes a coordinates-level proxy for the given identifiers.
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
</description>
</method>
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<method name="remove_custom_data_layer">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Removes the custom data layer at index [param layer_index]. Also updates the atlas tiles accordingly.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
<method name="remove_navigation_layer">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Removes the navigation layer at index [param layer_index]. Also updates the atlas tiles accordingly.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
<method name="remove_occlusion_layer">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Removes the occlusion layer at index [param layer_index]. Also updates the atlas tiles accordingly.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
Implement TileMap patterns palette
2021-09-29 15:48:27 +00:00
<method name="remove_pattern">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="index" type="int" />
Implement TileMap patterns palette
2021-09-29 15:48:27 +00:00
<description>
Remove the [TileMapPattern] at the given index.
</description>
</method>
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<method name="remove_physics_layer">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Removes the physics layer at index [param layer_index]. Also updates the atlas tiles accordingly.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +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="remove_source">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="source_id" 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>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Removes the source with the given source ID.
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 atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<method name="remove_source_level_tile_proxy">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="source_from" type="int" />
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Removes a source-level tile proxy.
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
</description>
</method>
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<method name="remove_terrain">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="terrain_set" type="int" />
<param index="1" name="terrain_index" type="int" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Removes the terrain at index [param terrain_index] in the given terrain set [param terrain_set]. Also updates the atlas tiles accordingly.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
<method name="remove_terrain_set">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="terrain_set" type="int" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Removes the terrain set at index [param terrain_set]. Also updates the atlas tiles accordingly.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<method name="set_alternative_level_tile_proxy">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="source_from" type="int" />
<param index="1" name="coords_from" type="Vector2i" />
<param index="2" name="alternative_from" type="int" />
<param index="3" name="source_to" type="int" />
<param index="4" name="coords_to" type="Vector2i" />
<param index="5" name="alternative_to" type="int" />
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Create an alternative-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers.
This can be used to replace a tile in all TileMaps using this TileSet, as TileMap nodes will find and use the proxy's target tile when one is available.
Proxied tiles can be automatically replaced in TileMap nodes using the editor.
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
</description>
</method>
<method name="set_coords_level_tile_proxy">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="p_source_from" type="int" />
<param index="1" name="coords_from" type="Vector2i" />
<param index="2" name="source_to" type="int" />
<param index="3" name="coords_to" type="Vector2i" />
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Creates a coordinates-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers. The alternative tile ID is kept the same when using coordinates-level proxies.
This can be used to replace a tile in all TileMaps using this TileSet, as TileMap nodes will find and use the proxy's target tile when one is available.
Proxied tiles can be automatically replaced in TileMap nodes using the editor.
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
</description>
</method>
expose TileMap methods related to the name of custom data layers
2022-07-24 23:09:03 +00:00
<method name="set_custom_data_layer_name">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
<param index="1" name="layer_name" type="String" />
expose TileMap methods related to the name of custom data layers
2022-07-24 23:09:03 +00:00
<description>
Sets the name of the custom data layer identified by the given index. Names are identifiers of the layer therefore if the name is already taken it will fail and raise an error.
</description>
</method>
<method name="set_custom_data_layer_type">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
<param index="1" name="layer_type" type="int" enum="Variant.Type" />
expose TileMap methods related to the name of custom data layers
2022-07-24 23:09:03 +00:00
<description>
Sets the type of the custom data layer identified by the given index.
</description>
</method>
Add TileSet helper functions to set/get navigation layer values Adds helper functions to TileSet to set / get navigation layers bitmask values.
2023-01-27 00:30:27 +00:00
<method name="set_navigation_layer_layer_value">
<return type="void" />
<param index="0" name="layer_index" type="int" />
<param index="1" name="layer_number" type="int" />
<param index="2" name="value" type="bool" />
<description>
Based on [param value], enables or disables the specified navigation layer of the TileSet navigation data layer identified by the given [param layer_index], given a navigation_layers [param layer_number] between 1 and 32.
</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="set_navigation_layer_layers">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
<param index="1" name="layers" 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>
Fix typos and inconsistencies in classref (cherry picked from commit 57d4272984fc0dd4c668503ead82a9dd01020bfd)
2023-03-16 05:56:09 +00:00
Sets the navigation layers (as in the navigation server) for navigation regions in the given TileSet navigation layer.
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>
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="set_occlusion_layer_light_mask">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
<param index="1" name="light_mask" 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>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Sets the occlusion layer (as in the rendering server) for occluders in the given TileSet occlusion layer.
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>
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="set_occlusion_layer_sdf_collision">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
<param index="1" name="sdf_collision" 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>
Fix typos and inconsistencies in classref (cherry picked from commit 57d4272984fc0dd4c668503ead82a9dd01020bfd)
2023-03-16 05:56:09 +00:00
Enables or disables SDF collision for occluders in the given TileSet occlusion layer.
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>
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="set_physics_layer_collision_layer">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
<param index="1" 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>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Sets the physics layer (as in the physics server) for bodies in the given TileSet physics layer.
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>
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="set_physics_layer_collision_mask">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
<param index="1" name="mask" type="int" />
doc: Sync classref with current source
2018-08-29 20:25:11 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Sets the physics layer (as in the physics server) for bodies in the given TileSet physics layer.
doc: Sync classref with current source
2018-08-29 20:25:11 +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="set_physics_layer_physics_material">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_index" type="int" />
<param index="1" name="physics_material" type="PhysicsMaterial" />
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>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Sets the physics material for bodies in the given TileSet physics layer.
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>
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="set_source_id">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="source_id" type="int" />
<param index="1" name="new_source_id" type="int" />
doc: Sync classref with current source
2019-01-26 21:21:53 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Changes a source's ID.
doc: Sync classref with current source
2019-01-26 21:21:53 +00:00
</description>
</method>
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<method name="set_source_level_tile_proxy">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="source_from" type="int" />
<param index="1" name="source_to" type="int" />
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +00:00
<description>
Fix various typos in the classref (cherry picked from commit 766807506c4f40bca1fafd16ac467a33694f6269)
2023-04-18 11:53:47 +00:00
Creates a source-level proxy for the given source ID. A proxy will map set of tile identifiers to another set of identifiers. Both the atlas coordinates ID and the alternative tile ID are kept the same when using source-level proxies.
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
This can be used to replace a source in all TileMaps using this TileSet, as TileMap nodes will find and use the proxy's target source when one is available.
Proxied tiles can be automatically replaced in TileMap nodes using the editor.
Implement atlas merging and tile proxies
2021-07-06 12:43:03 +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="set_terrain_color">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="terrain_set" type="int" />
<param index="1" name="terrain_index" type="int" />
<param index="2" name="color" type="Color" />
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>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Sets a terrain's color. This color is used for identifying the different terrains in the TileSet editor.
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>
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="set_terrain_name">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="terrain_set" type="int" />
<param index="1" name="terrain_index" type="int" />
<param index="2" name="name" type="String" />
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>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Sets a terrain's name.
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>
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="set_terrain_set_mode">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="terrain_set" type="int" />
<param index="1" name="mode" type="int" enum="TileSet.TerrainMode" />
doc: Sync classref with current source
2018-04-10 08:12:42 +00:00
<description>
Convert en_GB spelling to en_US with codespell
2023-01-21 11:25:29 +00:00
Sets a terrain mode. Each mode determines which bits of a tile shape is used to match the neighboring tiles' terrains.
doc: Sync classref with current source
2018-04-10 08:12:42 +00:00
</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
</methods>
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
<members>
<member name="tile_layout" type="int" setter="set_tile_layout" getter="get_tile_layout" enum="TileSet.TileLayout" default="0">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), changes the way tiles are indexed in the TileMap grid.
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
</member>
<member name="tile_offset_axis" type="int" setter="set_tile_offset_axis" getter="get_tile_offset_axis" enum="TileSet.TileOffsetAxis" default="0">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), determines the offset axis.
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
</member>
<member name="tile_shape" type="int" setter="set_tile_shape" getter="get_tile_shape" enum="TileSet.TileShape" default="0">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
The tile shape.
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
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="tile_size" type="Vector2i" setter="set_tile_size" getter="get_tile_size" default="Vector2i(16, 16)">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
The tile size, in pixels. For all tile shapes, this size corresponds to the encompassing rectangle of the tile shape. This is thus the minimal cell size required in an atlas.
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
</member>
<member name="uv_clipping" type="bool" setter="set_uv_clipping" getter="is_uv_clipping" default="false">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Enables/Disable uv clipping when rendering the tiles.
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
</member>
</members>
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>
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
<constant name="TILE_SHAPE_SQUARE" value="0" enum="TileShape">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Rectangular tile shape.
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
</constant>
<constant name="TILE_SHAPE_ISOMETRIC" value="1" enum="TileShape">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Diamond tile shape (for isometric look).
Warn if isometric TileMap is not Y-sorted
2022-10-07 20:27:31 +00:00
[b]Note:[/b] Isometric [TileSet] works best if [TileMap] and all its layers have Y-sort enabled.
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
</constant>
<constant name="TILE_SHAPE_HALF_OFFSET_SQUARE" value="2" enum="TileShape">
Fix various typos Found via ` codespell -q 3 -S ./thirdparty,*.po,./DONORS.md -L ackward,ang,ans,ba,beng,cas,childs,childrens,dof,doubleclick,expct,fave,findn,gird,hist,inout,leapyear,lod,nd,numer,ois,ony,paket,seeked,sinc,switchs,te,uint,varn` Update editor/import/resource_importer_layered_texture.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update doc/classes/TileSetScenesCollectionSource.xml Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/gui/graph_edit.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/resources/animation.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/resources/animation.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/resources/animation.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/gui/rich_text_label.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Revert previously committed change
2022-01-02 06:03:58 +00:00
Rectangular tile shape with one row/column out of two offset by half a tile.
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
</constant>
<constant name="TILE_SHAPE_HEXAGON" value="3" enum="TileShape">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Hexagonal tile shape.
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
</constant>
<constant name="TILE_LAYOUT_STACKED" value="0" enum="TileLayout">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Tile coordinates layout where both axis stay consistent with their respective local horizontal and vertical axis.
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
</constant>
<constant name="TILE_LAYOUT_STACKED_OFFSET" value="1" enum="TileLayout">
Fix typo in `TILE_LAYOUT_STACKED_OFFSET` description
2022-04-15 00:07:02 +00:00
Same as [constant TILE_LAYOUT_STACKED], but the first half-offset is negative instead of positive.
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
</constant>
<constant name="TILE_LAYOUT_STAIRS_RIGHT" value="2" enum="TileLayout">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Tile coordinates layout where the horizontal axis stay horizontal, and the vertical one goes down-right.
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
</constant>
<constant name="TILE_LAYOUT_STAIRS_DOWN" value="3" enum="TileLayout">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Tile coordinates layout where the vertical axis stay vertical, and the horizontal one goes down-right.
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
</constant>
<constant name="TILE_LAYOUT_DIAMOND_RIGHT" value="4" enum="TileLayout">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Tile coordinates layout where the horizontal axis goes up-right, and the vertical one goes down-right.
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
</constant>
<constant name="TILE_LAYOUT_DIAMOND_DOWN" value="5" enum="TileLayout">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Tile coordinates layout where the horizontal axis goes down-right, and the vertical one goes down-left.
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
</constant>
<constant name="TILE_OFFSET_AXIS_HORIZONTAL" value="0" enum="TileOffsetAxis">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Horizontal half-offset.
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
</constant>
<constant name="TILE_OFFSET_AXIS_VERTICAL" value="1" enum="TileOffsetAxis">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Vertical half-offset.
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
</constant>
Fix TileSet::CellNeighbor enum binding Having the TileSet:: prefix has some unintended consequences in the bindings, in particular in the extension API dump.
2021-07-06 13:46:18 +00:00
<constant name="CELL_NEIGHBOR_RIGHT_SIDE" value="0" enum="CellNeighbor">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Neighbor on the right side.
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
</constant>
Fix TileSet::CellNeighbor enum binding Having the TileSet:: prefix has some unintended consequences in the bindings, in particular in the extension API dump.
2021-07-06 13:46:18 +00:00
<constant name="CELL_NEIGHBOR_RIGHT_CORNER" value="1" enum="CellNeighbor">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Neighbor in the right corner.
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
</constant>
Fix TileSet::CellNeighbor enum binding Having the TileSet:: prefix has some unintended consequences in the bindings, in particular in the extension API dump.
2021-07-06 13:46:18 +00:00
<constant name="CELL_NEIGHBOR_BOTTOM_RIGHT_SIDE" value="2" enum="CellNeighbor">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Neighbor on the bottom right side.
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
</constant>
Fix TileSet::CellNeighbor enum binding Having the TileSet:: prefix has some unintended consequences in the bindings, in particular in the extension API dump.
2021-07-06 13:46:18 +00:00
<constant name="CELL_NEIGHBOR_BOTTOM_RIGHT_CORNER" value="3" enum="CellNeighbor">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Neighbor in the bottom right corner.
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
</constant>
Fix TileSet::CellNeighbor enum binding Having the TileSet:: prefix has some unintended consequences in the bindings, in particular in the extension API dump.
2021-07-06 13:46:18 +00:00
<constant name="CELL_NEIGHBOR_BOTTOM_SIDE" value="4" enum="CellNeighbor">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Neighbor on the bottom side.
doc: Sync classref with current source
2017-11-24 08:16:27 +00:00
</constant>
Fix TileSet::CellNeighbor enum binding Having the TileSet:: prefix has some unintended consequences in the bindings, in particular in the extension API dump.
2021-07-06 13:46:18 +00:00
<constant name="CELL_NEIGHBOR_BOTTOM_CORNER" value="5" enum="CellNeighbor">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Neighbor in the bottom corner.
Sync classref with current source Also fix binding of Basis.slerp
2018-05-28 12:53:15 +00:00
</constant>
Fix TileSet::CellNeighbor enum binding Having the TileSet:: prefix has some unintended consequences in the bindings, in particular in the extension API dump.
2021-07-06 13:46:18 +00:00
<constant name="CELL_NEIGHBOR_BOTTOM_LEFT_SIDE" value="6" enum="CellNeighbor">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Neighbor on the bottom left side.
doc: Sync classref with current source
2017-11-24 08:16:27 +00:00
</constant>
Fix TileSet::CellNeighbor enum binding Having the TileSet:: prefix has some unintended consequences in the bindings, in particular in the extension API dump.
2021-07-06 13:46:18 +00:00
<constant name="CELL_NEIGHBOR_BOTTOM_LEFT_CORNER" value="7" enum="CellNeighbor">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Neighbor in the bottom left corner.
doc: Sync classref with current source
2017-11-24 08:16:27 +00:00
</constant>
Fix TileSet::CellNeighbor enum binding Having the TileSet:: prefix has some unintended consequences in the bindings, in particular in the extension API dump.
2021-07-06 13:46:18 +00:00
<constant name="CELL_NEIGHBOR_LEFT_SIDE" value="8" enum="CellNeighbor">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Neighbor on the left side.
doc: Sync classref with current source
2017-11-24 08:16:27 +00:00
</constant>
Fix TileSet::CellNeighbor enum binding Having the TileSet:: prefix has some unintended consequences in the bindings, in particular in the extension API dump.
2021-07-06 13:46:18 +00:00
<constant name="CELL_NEIGHBOR_LEFT_CORNER" value="9" enum="CellNeighbor">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Neighbor in the left corner.
doc: Sync classref with current source
2017-11-24 08:16:27 +00:00
</constant>
Fix TileSet::CellNeighbor enum binding Having the TileSet:: prefix has some unintended consequences in the bindings, in particular in the extension API dump.
2021-07-06 13:46:18 +00:00
<constant name="CELL_NEIGHBOR_TOP_LEFT_SIDE" value="10" enum="CellNeighbor">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Neighbor on the top left side.
doc: Sync classref with current source
2017-11-24 08:16:27 +00:00
</constant>
Fix TileSet::CellNeighbor enum binding Having the TileSet:: prefix has some unintended consequences in the bindings, in particular in the extension API dump.
2021-07-06 13:46:18 +00:00
<constant name="CELL_NEIGHBOR_TOP_LEFT_CORNER" value="11" enum="CellNeighbor">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Neighbor in the top left corner.
doc: Sync classref with current source Fix a few typos.
2020-01-28 09:58:48 +00:00
</constant>
Fix TileSet::CellNeighbor enum binding Having the TileSet:: prefix has some unintended consequences in the bindings, in particular in the extension API dump.
2021-07-06 13:46:18 +00:00
<constant name="CELL_NEIGHBOR_TOP_SIDE" value="12" enum="CellNeighbor">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Neighbor on the top side.
doc: Sync classref with current source
2017-11-24 08:16:27 +00:00
</constant>
Fix TileSet::CellNeighbor enum binding Having the TileSet:: prefix has some unintended consequences in the bindings, in particular in the extension API dump.
2021-07-06 13:46:18 +00:00
<constant name="CELL_NEIGHBOR_TOP_CORNER" value="13" enum="CellNeighbor">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Neighbor in the top corner.
doc: Sync classref with current source
2017-11-24 08:16:27 +00:00
</constant>
Fix TileSet::CellNeighbor enum binding Having the TileSet:: prefix has some unintended consequences in the bindings, in particular in the extension API dump.
2021-07-06 13:46:18 +00:00
<constant name="CELL_NEIGHBOR_TOP_RIGHT_SIDE" value="14" enum="CellNeighbor">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Neighbor on the top right side.
doc: Sync classref with current source
2017-11-24 08:16:27 +00:00
</constant>
Fix TileSet::CellNeighbor enum binding Having the TileSet:: prefix has some unintended consequences in the bindings, in particular in the extension API dump.
2021-07-06 13:46:18 +00:00
<constant name="CELL_NEIGHBOR_TOP_RIGHT_CORNER" value="15" enum="CellNeighbor">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Neighbor in the top right corner.
doc: Sync classref with current source
2017-11-24 08:16:27 +00:00
</constant>
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
<constant name="TERRAIN_MODE_MATCH_CORNERS_AND_SIDES" value="0" enum="TerrainMode">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Requires both corners and side to match with neighboring tiles' terrains.
doc: Sync classref with current source
2018-04-10 08:12:42 +00:00
</constant>
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
<constant name="TERRAIN_MODE_MATCH_CORNERS" value="1" enum="TerrainMode">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Requires corners to match with neighboring tiles' terrains.
doc: Sync classref with current source
2018-04-10 08:12:42 +00:00
</constant>
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
<constant name="TERRAIN_MODE_MATCH_SIDES" value="2" enum="TerrainMode">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Requires sides to match with neighboring tiles' terrains.
doc: Sync classref with current source
2018-04-10 08:12:42 +00:00
</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>