summaryrefslogtreecommitdiffstats
path: root/doc/classes/TileSetAtlasSource.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2022-11-01 15:29:38 +0100
committerRémi Verschelde <rverschelde@gmail.com>2022-11-02 19:01:18 +0100
commitf7c611ab71d292d64a6d4db8db8e36aaf0e2330b (patch)
tree2521af5ba64af64c9f5c667b419ff66fc1324f60 /doc/classes/TileSetAtlasSource.xml
parent39cece382d1c0f9f89eaa469a93497c50b516686 (diff)
downloadredot-engine-f7c611ab71d292d64a6d4db8db8e36aaf0e2330b.tar.gz
Style: Misc docs and comment style and language fixes
- Removed empty paragraphs in XML. - Consistently use bold style for "Example:", on a new line. - Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`). - Fix invalid usage of backticks for inline code in BBCode. - Fix some American/British English spelling inconsistencies. - Other minor fixes spotted along the way, including typo fixes with codespell. - Don't specify `@GlobalScope` for `enum` and `constant`.
Diffstat (limited to 'doc/classes/TileSetAtlasSource.xml')
-rw-r--r--doc/classes/TileSetAtlasSource.xml2
1 files changed, 0 insertions, 2 deletions
diff --git a/doc/classes/TileSetAtlasSource.xml b/doc/classes/TileSetAtlasSource.xml
index df469cd030..5efc1da6f9 100644
--- a/doc/classes/TileSetAtlasSource.xml
+++ b/doc/classes/TileSetAtlasSource.xml
@@ -6,9 +6,7 @@
<description>
An atlas is a grid of tiles laid out on a texture. Each tile in the grid must be exposed using [method create_tile]. Those tiles are then indexed using their coordinates in the grid.
Each tile can also have a size in the grid coordinates, making it more or less cells in the atlas.
-
Alternatives version of a tile can be created using [method create_alternative_tile], which are then indexed using an alternative ID. The main tile (the one in the grid), is accessed with an alternative ID equal to 0.
-
Each tile alternate has a set of properties that is defined by the source's [TileSet] layers. Those properties are stored in a TileData object that can be accessed and modified using [method get_tile_data].
As TileData properties are stored directly in the TileSetAtlasSource resource, their properties might also be set using [code]TileSetAtlasSource.set("&lt;coords_x&gt;:&lt;coords_y&gt;/&lt;alternative_id&gt;/&lt;tile_data_property&gt;")[/code].
</description>