asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/TileSet.xml

599 lines
22 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 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Update classref headers with 3.4 version
2021-04-26 13:14:51 +02:00
<class name="TileSet" inherits="Resource" version="3.4">
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 22:42:36 +02:00
<brief_description>
Tile library for tilemaps.
</brief_description>
<description>
A TileSet is a library of tiles for a [TileMap]. It contains a list of tiles, each consisting of a sprite and optional collision shapes.
Tiles are referenced by a unique integer ID.
</description>
<tutorials>
doc: Point URLs to 3.4 version of the online docs
2021-08-12 16:58:38 +02:00
<link title="Using Tilemaps">https://docs.godotengine.org/en/3.4/tutorials/2d/using_tilemaps.html</link>
Link to demos from within the class reference (cherry picked from commit 439be614f4706705331669a58ce03f14c34ca52f)
2020-10-01 10:34:47 +02: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 22:42:36 +02:00
</tutorials>
<methods>
doc: Sync classref with current source
2019-06-01 12:34:29 +02:00
<method name="_forward_atlas_subtile_selection" qualifiers="virtual">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Vector2" />
<argument index="0" name="atlastile_id" type="int" />
<argument index="1" name="tilemap" type="Object" />
<argument index="2" name="tile_location" type="Vector2" />
doc: Sync classref with current source
2019-06-01 12:34:29 +02:00
<description>
</description>
</method>
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
<method name="_forward_subtile_selection" qualifiers="virtual">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Vector2" />
<argument index="0" name="autotile_id" type="int" />
<argument index="1" name="bitmask" type="int" />
<argument index="2" name="tilemap" type="Object" />
<argument index="3" name="tile_location" type="Vector2" />
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
<description>
</description>
</method>
<method name="_is_tile_bound" qualifiers="virtual">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="drawn_id" type="int" />
<argument index="1" name="neighbor_id" type="int" />
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
<description>
Add description to TileSet.is_tile_bound() method (cherry picked from commit 00398abf77d464a65f4424b1e6bfda5fdffbe228)
2020-06-09 20:30:05 +02:00
Determines when the auto-tiler should consider two different auto-tile IDs to be bound together.
[b]Note:[/b] [code]neighbor_id[/code] will be [code]-1[/code] ([constant TileMap.INVALID_CELL]) when checking a tile against an empty neighbor tile.
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
</description>
</method>
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
<method name="autotile_clear_bitmask_map">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Clears all bitmask information of the autotile.
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
</description>
</method>
<method name="autotile_get_bitmask">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="id" type="int" />
<argument index="1" name="coord" type="Vector2" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
<description>
Returns the bitmask of the subtile from an autotile given its coordinates.
doc: Fix scoped hyperlinks to same-class enums/methods The class name does not need to be specified when it is the current class.
2019-06-27 11:44:37 +02:00
The value is the sum of the values in [enum AutotileBindings] present in the subtile (e.g. a value of 5 means the bitmask has bindings in both the top left and top right).
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
</description>
</method>
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
<method name="autotile_get_bitmask_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" enum="TileSet.BitmaskMode" />
<argument index="0" name="id" type="int" />
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
<description>
doc: Fix scoped hyperlinks to same-class enums/methods The class name does not need to be specified when it is the current class.
2019-06-27 11:44:37 +02:00
Returns the [enum BitmaskMode] of the autotile.
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
</description>
</method>
<method name="autotile_get_icon_coordinate" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Vector2" />
<argument index="0" name="id" type="int" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
<description>
Returns the subtile that's being used as an icon in an atlas/autotile given its coordinates.
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
The subtile defined as the icon will be used as a fallback when the atlas/autotile's bitmask information is incomplete. It will also be used to represent it in the TileSet editor.
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
</description>
</method>
<method name="autotile_get_light_occluder" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="OccluderPolygon2D" />
<argument index="0" name="id" type="int" />
<argument index="1" name="coord" type="Vector2" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
<description>
Returns the light occluder of the subtile from an atlas/autotile given its coordinates.
</description>
</method>
<method name="autotile_get_navigation_polygon" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="NavigationPolygon" />
<argument index="0" name="id" type="int" />
<argument index="1" name="coord" type="Vector2" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
<description>
Returns the navigation polygon of the subtile from an atlas/autotile given its coordinates.
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
</description>
</method>
DocData: Fix return type listed as "var" instead of "Variant"
2018-08-31 22:38:28 +02:00
<method name="autotile_get_size" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Vector2" />
<argument index="0" name="id" type="int" />
DocData: Fix return type listed as "var" instead of "Variant"
2018-08-31 22:38:28 +02:00
<description>
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
Returns the size of the subtiles in an atlas/autotile.
</description>
</method>
<method name="autotile_get_spacing" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="id" type="int" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
<description>
Returns the spacing between subtiles of the atlas/autotile.
</description>
</method>
<method name="autotile_get_subtile_priority">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="id" type="int" />
<argument index="1" name="coord" type="Vector2" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
<description>
Returns the priority of the subtile from an autotile given its coordinates.
When more than one subtile has the same bitmask value, one of them will be picked randomly for drawing. Its priority will define how often it will be picked.
</description>
</method>
<method name="autotile_get_z_index">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="id" type="int" />
<argument index="1" name="coord" type="Vector2" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
<description>
Returns the drawing index of the subtile from an atlas/autotile given its coordinates.
</description>
</method>
<method name="autotile_set_bitmask">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="bitmask" type="Vector2" />
<argument index="2" name="flag" type="int" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
<description>
Sets the bitmask of the subtile from an autotile given its coordinates.
doc: Fix scoped hyperlinks to same-class enums/methods The class name does not need to be specified when it is the current class.
2019-06-27 11:44:37 +02:00
The value is the sum of the values in [enum AutotileBindings] present in the subtile (e.g. a value of 5 means the bitmask has bindings in both the top left and top right).
DocData: Fix return type listed as "var" instead of "Variant"
2018-08-31 22:38:28 +02:00
</description>
</method>
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
<method name="autotile_set_bitmask_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="mode" type="int" enum="TileSet.BitmaskMode" />
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
<description>
doc: Fix scoped hyperlinks to same-class enums/methods The class name does not need to be specified when it is the current class.
2019-06-27 11:44:37 +02:00
Sets the [enum BitmaskMode] of the autotile.
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
</description>
</method>
<method name="autotile_set_icon_coordinate">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="coord" type="Vector2" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
<description>
Sets the subtile that will be used as an icon in an atlas/autotile given its coordinates.
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
The subtile defined as the icon will be used as a fallback when the atlas/autotile's bitmask information is incomplete. It will also be used to represent it in the TileSet editor.
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
</description>
</method>
<method name="autotile_set_light_occluder">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="light_occluder" type="OccluderPolygon2D" />
<argument index="2" name="coord" type="Vector2" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
<description>
Sets the light occluder of the subtile from an atlas/autotile given its coordinates.
</description>
</method>
<method name="autotile_set_navigation_polygon">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="navigation_polygon" type="NavigationPolygon" />
<argument index="2" name="coord" type="Vector2" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
<description>
Sets the navigation polygon of the subtile from an atlas/autotile given its coordinates.
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
</description>
</method>
DocData: Fix return type listed as "var" instead of "Variant"
2018-08-31 22:38:28 +02:00
<method name="autotile_set_size">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="size" type="Vector2" />
DocData: Fix return type listed as "var" instead of "Variant"
2018-08-31 22:38:28 +02:00
<description>
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
Sets the size of the subtiles in an atlas/autotile.
</description>
</method>
<method name="autotile_set_spacing">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="spacing" type="int" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
<description>
Sets the spacing between subtiles of the atlas/autotile.
</description>
</method>
<method name="autotile_set_subtile_priority">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="coord" type="Vector2" />
<argument index="2" name="priority" type="int" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
<description>
Sets the priority of the subtile from an autotile given its coordinates.
When more than one subtile has the same bitmask value, one of them will be picked randomly for drawing. Its priority will define how often it will be picked.
</description>
</method>
<method name="autotile_set_z_index">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="coord" type="Vector2" />
<argument index="2" name="z_index" type="int" />
Add undo-redo to the TileSet editor, and other improvements
2018-12-19 17:20:49 +01:00
<description>
Sets the drawing index of the subtile from an atlas/autotile given its coordinates.
DocData: Fix return type listed as "var" instead of "Variant"
2018-08-31 22:38:28 +02: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 22:42:36 +02:00
<method name="clear">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Clears all tiles.
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 22:42:36 +02:00
</description>
</method>
<method name="create_tile">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="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 22:42:36 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Creates a new tile with the given 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 22:42:36 +02:00
</description>
</method>
<method name="find_tile_by_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" 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 22:42:36 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Returns the first tile matching the given 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 22:42:36 +02:00
</description>
</method>
<method name="get_last_unused_tile_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02: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 22:42:36 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Returns the ID following the last currently used ID, useful when creating a new tile.
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 22:42:36 +02:00
</description>
</method>
<method name="get_tiles_ids" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Array" />
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 22:42:36 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Returns an array of all currently used tile IDs.
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 22:42:36 +02:00
</description>
</method>
<method name="remove_tile">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="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 22:42:36 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Removes the given tile 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 22:42:36 +02:00
</description>
</method>
<method name="tile_add_shape">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="shape" type="Shape2D" />
<argument index="2" name="shape_transform" type="Transform2D" />
<argument index="3" name="one_way" type="bool" default="false" />
<argument index="4" name="autotile_coord" type="Vector2" default="Vector2( 0, 0 )" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Adds a shape to the tile.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_get_light_occluder" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="OccluderPolygon2D" />
<argument index="0" name="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 22:42:36 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Returns the tile's light occluder.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_get_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="ShaderMaterial" />
<argument index="0" name="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 22:42:36 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Returns the tile's material.
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 22:42:36 +02:00
</description>
</method>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<method name="tile_get_modulate" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Color" />
<argument index="0" name="id" type="int" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Returns the tile's modulation color.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02: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 22:42:36 +02:00
<method name="tile_get_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="String" />
<argument index="0" name="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 22:42:36 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Returns the tile'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 22:42:36 +02:00
</description>
</method>
<method name="tile_get_navigation_polygon" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="NavigationPolygon" />
<argument index="0" name="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 22:42:36 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Returns the navigation polygon of the tile.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_get_navigation_polygon_offset" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Vector2" />
<argument index="0" name="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 22:42:36 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Returns the offset of the tile's navigation polygon.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_get_normal_map" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Texture" />
<argument index="0" name="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 22:42:36 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Returns the tile's normal map texture.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_get_occluder_offset" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Vector2" />
<argument index="0" name="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 22:42:36 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Returns the offset of the tile's light occluder.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_get_region" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Rect2" />
<argument index="0" name="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 22:42:36 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Returns the tile sub-region in the texture.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_get_shape" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Shape2D" />
<argument index="0" name="id" type="int" />
<argument index="1" name="shape_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 22:42:36 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Returns a tile's given shape.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_get_shape_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="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 22:42:36 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Returns the number of shapes assigned to a tile.
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 22:42:36 +02:00
</description>
</method>
doc: Sync classref with current source
2018-08-29 22:25:11 +02:00
<method name="tile_get_shape_offset" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Vector2" />
<argument index="0" name="id" type="int" />
<argument index="1" name="shape_id" type="int" />
doc: Sync classref with current source
2018-08-29 22:25:11 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Returns the offset of a tile's shape.
doc: Sync classref with current source
2018-08-29 22:25:11 +02: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 22:42:36 +02:00
<method name="tile_get_shape_one_way" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="id" type="int" />
<argument index="1" name="shape_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 22:42:36 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Returns the one-way collision value of a tile's shape.
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 22:42:36 +02:00
</description>
</method>
doc: Sync classref with current source
2019-01-26 22:21:53 +01:00
<method name="tile_get_shape_one_way_margin" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="float" />
<argument index="0" name="id" type="int" />
<argument index="1" name="shape_id" type="int" />
doc: Sync classref with current source
2019-01-26 22:21:53 +01:00
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="tile_get_shape_transform" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Transform2D" />
<argument index="0" name="id" type="int" />
<argument index="1" name="shape_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 22:42:36 +02:00
<description>
Fixed a typo, sahpe to shape.
2018-10-13 08:20:45 +02:00
Returns the [Transform2D] of a tile's shape.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_get_shapes" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Array" />
<argument index="0" name="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 22:42:36 +02:00
<description>
Document an example dictionary returned by `TileSet.tile_get_shapes()` (cherry picked from commit 60bb80505f538e320e8c81a5af286347e83757a1)
2020-07-16 09:40:51 +02:00
Returns an array of dictionaries describing the tile's shapes.
[b]Dictionary structure in the array returned by this method:[/b]
[codeblock]
{
"autotile_coord": Vector2,
"one_way": bool,
"one_way_margin": int,
"shape": CollisionShape2D,
"shape_transform": Transform2D,
}
[/codeblock]
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 22:42:36 +02:00
</description>
</method>
<method name="tile_get_texture" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Texture" />
<argument index="0" name="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 22:42:36 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Returns the tile's texture.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_get_texture_offset" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Vector2" />
<argument index="0" name="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 22:42:36 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Returns the texture offset of the tile.
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 22:42:36 +02:00
</description>
</method>
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
<method name="tile_get_tile_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" enum="TileSet.TileMode" />
<argument index="0" name="id" type="int" />
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
<description>
doc: Fix scoped hyperlinks to same-class enums/methods The class name does not need to be specified when it is the current class.
2019-06-27 11:44:37 +02:00
Returns the tile's [enum TileMode].
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
</description>
</method>
Sync classref with current source
2018-05-12 09:38:00 +02:00
<method name="tile_get_z_index" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="id" type="int" />
Sync classref with current source
2018-05-12 09:38:00 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Returns the tile's Z index (drawing layer).
Sync classref with current source
2018-05-12 09:38:00 +02: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 22:42:36 +02:00
<method name="tile_set_light_occluder">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="light_occluder" type="OccluderPolygon2D" />
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 22:42:36 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Sets a light occluder for the tile.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_set_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="material" type="ShaderMaterial" />
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 22:42:36 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Sets the tile's material.
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 22:42:36 +02:00
</description>
</method>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<method name="tile_set_modulate">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="color" type="Color" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Sets the tile's modulation color.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02: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 22:42:36 +02:00
<method name="tile_set_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" 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 22:42:36 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Sets the tile'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 22:42:36 +02:00
</description>
</method>
<method name="tile_set_navigation_polygon">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="navigation_polygon" type="NavigationPolygon" />
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 22:42:36 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Sets the tile's navigation polygon.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_set_navigation_polygon_offset">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="navigation_polygon_offset" type="Vector2" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Sets an offset for the tile's navigation polygon.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_set_normal_map">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="normal_map" type="Texture" />
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 22:42:36 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Sets the tile's normal map texture.
Document the expected normal map coordinate system where relevant (cherry picked from commit d8808fba854395cafc64fb474b8067d5fa5f5e43)
2020-05-04 22:18:05 +02:00
[b]Note:[/b] Godot expects the normal map to use X+, Y-, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_set_occluder_offset">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="occluder_offset" type="Vector2" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Sets an offset for the tile's light occluder.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_set_region">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="region" type="Rect2" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Sets the tile's sub-region in the texture. This is common in texture atlases.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_set_shape">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="shape_id" type="int" />
<argument index="2" name="shape" type="Shape2D" />
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 22:42:36 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Sets a shape for the tile, enabling collision.
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 22:42:36 +02:00
</description>
</method>
doc: Sync classref with current source
2018-08-29 22:25:11 +02:00
<method name="tile_set_shape_offset">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="shape_id" type="int" />
<argument index="2" name="shape_offset" type="Vector2" />
doc: Sync classref with current source
2018-08-29 22:25:11 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Sets the offset of a tile's shape.
doc: Sync classref with current source
2018-08-29 22:25:11 +02: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 22:42:36 +02:00
<method name="tile_set_shape_one_way">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="shape_id" type="int" />
<argument index="2" name="one_way" 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 22:42:36 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Enables one-way collision on a tile's shape.
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 22:42:36 +02:00
</description>
</method>
doc: Sync classref with current source
2019-01-26 22:21:53 +01:00
<method name="tile_set_shape_one_way_margin">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="shape_id" type="int" />
<argument index="2" name="one_way" type="float" />
doc: Sync classref with current source
2019-01-26 22:21:53 +01:00
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="tile_set_shape_transform">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="shape_id" type="int" />
<argument index="2" name="shape_transform" type="Transform2D" />
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 22:42:36 +02:00
<description>
[DOCS] Update VisibilityEnabler* and TileSet doc
2018-10-02 00:20:18 +02:00
Sets a [Transform2D] on a tile's shape.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_set_shapes">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="shapes" type="Array" />
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 22:42:36 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Sets an array of shapes for the tile, enabling collision.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_set_texture">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="texture" type="Texture" />
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 22:42:36 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Sets the tile's texture.
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 22:42:36 +02:00
</description>
</method>
<method name="tile_set_texture_offset">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="texture_offset" type="Vector2" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Sets the tile's texture offset.
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 22:42:36 +02:00
</description>
</method>
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
<method name="tile_set_tile_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="tilemode" type="int" enum="TileSet.TileMode" />
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
<description>
doc: Fix scoped hyperlinks to same-class enums/methods The class name does not need to be specified when it is the current class.
2019-06-27 11:44:37 +02:00
Sets the tile's [enum TileMode].
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
</description>
</method>
Sync classref with current source
2018-05-12 09:38:00 +02:00
<method name="tile_set_z_index">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="z_index" type="int" />
Sync classref with current source
2018-05-12 09:38:00 +02:00
<description>
[DOCS] Many class ref updates
2018-08-19 06:29:12 +02:00
Sets the tile's drawing index.
Sync classref with current source
2018-05-12 09:38:00 +02: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 22:42:36 +02:00
</methods>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="BITMASK_2X2" value="0" enum="BitmaskMode">
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
</constant>
Sync classref with current source Also fix binding of Basis.slerp
2018-05-28 14:53:15 +02:00
<constant name="BITMASK_3X3_MINIMAL" value="1" enum="BitmaskMode">
</constant>
<constant name="BITMASK_3X3" value="2" enum="BitmaskMode">
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="BIND_TOPLEFT" value="1" enum="AutotileBindings">
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="BIND_TOP" value="2" enum="AutotileBindings">
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="BIND_TOPRIGHT" value="4" enum="AutotileBindings">
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="BIND_LEFT" value="8" enum="AutotileBindings">
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
</constant>
doc: Sync classref with current source Fix a few typos.
2020-01-28 10:58:48 +01:00
<constant name="BIND_CENTER" value="16" enum="AutotileBindings">
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="BIND_RIGHT" value="32" enum="AutotileBindings">
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="BIND_BOTTOMLEFT" value="64" enum="AutotileBindings">
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="BIND_BOTTOM" value="128" enum="AutotileBindings">
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="BIND_BOTTOMRIGHT" value="256" enum="AutotileBindings">
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
</constant>
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
<constant name="SINGLE_TILE" value="0" enum="TileMode">
</constant>
<constant name="AUTO_TILE" value="1" enum="TileMode">
</constant>
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
<constant name="ATLAS_TILE" value="2" enum="TileMode">
doc: Sync classref with current source
2018-04-10 10:12:42 +02: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 22:42:36 +02:00
</constants>
</class>
Reference in a new issue Copy permalink