Template:Sprite/doc: Difference between revisions
Jump to navigation
Jump to search
m (Fixed typo, changed "sprite" to "sprite templates") |
m (Added Edega's sprite template to the list) |
||
| Line 5: | Line 5: | ||
* [[Template:Sprite/Ian]] | * [[Template:Sprite/Ian]] | ||
* [[Template:Sprite/Paige]] | * [[Template:Sprite/Paige]] | ||
* [[Template:Sprite/Edega]] | |||
* [[Template:Sprite/Janitor]] | * [[Template:Sprite/Janitor]] | ||
* [[Template:Sprite/Logan]] | * [[Template:Sprite/Logan]] | ||
Revision as of 14:40, 13 June 2023
Sprite is a template which draws a single sprite from a spritesheet.
If a sprite is drawn for a one-off thing, you can use this template directly. Otherwise, it's better to create a separate template for the character, to reduce boilerplate. A list of character-specific sprite templates can be found here:
- Template:Sprite/Ian
- Template:Sprite/Paige
- Template:Sprite/Edega
- Template:Sprite/Janitor
- Template:Sprite/Logan
- Template:Sprite/Hailey
- Template:Sprite/Cole
- Template:Sprite/Nicole
- Template:Sprite/NicoleB
Arguments
| Argument | Required? | Description |
|---|---|---|
| ratio | No | A scale factor to apply to the sprite. 1 = leave as is. |
| sheetWidth | Yes | The width of the source spritesheet, in pixels. |
| sheetHeight | Yes | The height of the source spritesheet, in pixels. |
| noOfRows | Yes | Number of rows in the spritesheet |
| noOfColumns | Yes | Number of columns in the spritesheet |
| offsetX | No | If sprites are not centered in each "cell" of the spritesheet, you can use this value to adjust. Otherwise, leave at 0. |
| offsetY | No | If sprites are not centered in each "cell" of the spritesheet, you can use this value to adjust. Otherwise, leave at 0. |
| row | Yes | The index of the row to display. This is 1-indexed, so 1 is the first row. |
| col | Yes | The index of the col to display. This is also 1-indexed. |
| image | Yes | The image to use as the spritesheet. e.g. File:IanSpriteS.png
|
Examples
- I am some text after the sprite
