Skip to content

Commit

Permalink
aniamted tiles docs iteration
Browse files Browse the repository at this point in the history
  • Loading branch information
Cammin committed May 6, 2024
1 parent acc0b5f commit 2baaa73
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions DocFX/documentation/Topics/topic_AnimatedTiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ Though LDtk does not support animated tiles, the importer has some support for i
- Then you can put information in to tell the importer how the tile should animate.
- You type in a keyword, followed by one or more values separated by commas.
- There should only be one keyword per line.
- All keywords are optional. If any are not used, then the default values in the table below are used. But to do any animation, `animatedSprites` is required.
![AnimatedTilesCustomDataExample](../../images/img_LDtk_TileAnimationData.png)

| Keyword | Type | Default | Description | Example |
|------------------------|---------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|
| `animatedSprites` | `int` | (empty) | The tile ID frames to use in the animation. | `animatedSprites 0,1,2,3,3,3,2,1` |
| `animationSpeed` | `float` | 1 | The animation speed.<br/>Put one number for a fixed value.<br/>Put two numbers for a random range. | `animationSpeed 2`<br/>`animationSpeed 1.5, 3` |
| `animationSpeed` | `float` | 1 | The animation speed in frames per second.<br/>Put one number for a fixed value.<br/>Put two numbers for a random range. | `animationSpeed 2`<br/>`animationSpeed 1.5, 3` |
| `animationStartTime` | `float` | 0 | The initial animation time of a tile.<br/>Put one number for a fixed value.<br/>Put two numbers for a random range. | `animationStartTime 0.5`<br/>`animationStartTime 0, 2.5` |
| `animationStartFrame` | `int` | 0 | The initial animation frame of a tile.<br/>Put one number for a fixed value.<br/>Put two numbers for a random range.<br/>This overrides `animationStartTime`. | `animationStartFrame 2`<br/>`animationStartFrame 0, 3` |

- All keywords are optional. If one is left unused, the value will be it's default displayed in the table below.and have a default value if unused, but `animatedSprites` is required to do any animation.
- The naming convention is based on Unity's [TileAnimationData](https://docs.unity3d.com/ScriptReference/Tilemaps.TileAnimationData.html) and [AnimatedTile](https://docs.unity3d.com/Packages/[email protected]/manual/AnimatedTile.html).

## Disclaimer
Expand Down
6 changes: 3 additions & 3 deletions docs/documentation/Topics/topic_AnimatedTiles.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@ <h2 id="setup">Setup</h2>
<li>Click on a tile and a text dialogue will appear, where you can add text.</li>
<li>Then you can put information in to tell the importer how the tile should animate.</li>
<li>You type in a keyword, followed by one or more values separated by commas.</li>
<li>There should only be one keyword per line.<br>
<li>There should only be one keyword per line.</li>
<li>All keywords are optional. If any are not used, then the default values in the table below are used. But to do any animation, <code>animatedSprites</code> is required.<br>
<img src="../../images/img_LDtk_TileAnimationData.png" alt="AnimatedTilesCustomDataExample"></li>
</ul>
<table>
Expand All @@ -105,7 +106,7 @@ <h2 id="setup">Setup</h2>
<td><code>animationSpeed</code></td>
<td><code>float</code></td>
<td>1</td>
<td>The animation speed.<br>Put one number for a fixed value.<br>Put two numbers for a random range.</td>
<td>The animation speed in frames per second.<br>Put one number for a fixed value.<br>Put two numbers for a random range.</td>
<td><code>animationSpeed 2</code><br><code>animationSpeed 1.5, 3</code></td>
</tr>
<tr>
Expand All @@ -125,7 +126,6 @@ <h2 id="setup">Setup</h2>
</tbody>
</table>
<ul>
<li>All keywords are optional. If one is left unused, the value will be it's default displayed in the table below.and have a default value if unused, but <code>animatedSprites</code> is required to do any animation.</li>
<li>The naming convention is based on Unity's <a href="https://docs.unity3d.com/ScriptReference/Tilemaps.TileAnimationData.html">TileAnimationData</a> and <a href="https://docs.unity3d.com/Packages/[email protected]/manual/AnimatedTile.html">AnimatedTile</a>.</li>
</ul>
<h2 id="disclaimer">Disclaimer</h2>
Expand Down
10 changes: 5 additions & 5 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@
"hash": "uJuliETfwhZEZRn9ZA7K5A=="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
Expand Down Expand Up @@ -924,7 +924,7 @@
"hash": "edcpOyJQz3rpejhPJ47tgg=="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
Expand Down Expand Up @@ -1101,7 +1101,7 @@
"output": {
".html": {
"relative_path": "documentation/Topics/topic_AnimatedTiles.html",
"hash": "e1vt+NRuLIDqMjXEFFaabQ=="
"hash": "BXLwfkZQoFCYXyJwIaC19g=="
}
},
"is_incremental": false,
Expand Down Expand Up @@ -1164,7 +1164,7 @@
"hash": "AxAat2QYEnTGCSV/a6egdg=="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
Expand Down Expand Up @@ -2301,7 +2301,7 @@
"can_incremental": true,
"incrementalPhase": "build",
"total_file_count": 77,
"skipped_file_count": 76
"skipped_file_count": 77
},
"ResourceDocumentProcessor": {
"can_incremental": false,
Expand Down

0 comments on commit 2baaa73

Please sign in to comment.