Template:Sprite/doc: Difference between revisions
Jump to navigation
Jump to search
Auburnsummer (talk | contribs) No edit summary |
m (Added MD characters' sprites to the list) |
||
| (19 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
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. | 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/Farmer]] | |||
* [[Template:Sprite/Samurai]] | |||
* [[Template:Sprite/Edega]] | |||
* [[Template:Sprite/Janitor]] | |||
* [[Template:Sprite/Logan]] | |||
* [[Template:Sprite/Hailey]] | |||
* [[Template:Sprite/Insomniac]] | |||
* [[Template:Sprite/Cole]] | |||
* [[Template:Sprite/Nicole]] | |||
* [[Template:Sprite/NicoleB]] | |||
* [[Template:Sprite/RichardHugh]] | |||
* [[Template:Sprite/MrsStevenson]] | |||
* [[Template:Sprite/MrStevenson]] | |||
* [[Template:Sprite/Miner]] | |||
* [[Template:Sprite/Lucia]] | |||
* [[Template:Sprite/Rin]] | |||
* [[Template:Sprite/Buro]] | |||
* [[Template:Sprite/Marija]] | |||
== Arguments == | == Arguments == | ||
| Line 33: | Line 53: | ||
== Examples == | == Examples == | ||
{{Sprite | * {{Sprite | ||
|ratio=1.5 | |ratio=1.5 | ||
|sheetWidth=160 | |sheetWidth=160 | ||
|sheetHeight=333 | |sheetHeight=333 | ||
|noOfRows= | |noOfRows=9 | ||
|noOfColumns= | |noOfColumns=5 | ||
|offsetY=2 | |offsetY=2 | ||
|row=2 | |row=2 | ||
|col=3 | |col=3 | ||
|image=File:IanSpriteS.png | |image=File:IanSpriteS.png | ||
}} | |outline=blue | ||
}}I am some text after the sprite | |||
Latest revision as of 12:57, 26 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/Farmer
- Template:Sprite/Samurai
- Template:Sprite/Edega
- Template:Sprite/Janitor
- Template:Sprite/Logan
- Template:Sprite/Hailey
- Template:Sprite/Insomniac
- Template:Sprite/Cole
- Template:Sprite/Nicole
- Template:Sprite/NicoleB
- Template:Sprite/RichardHugh
- Template:Sprite/MrsStevenson
- Template:Sprite/MrStevenson
- Template:Sprite/Miner
- Template:Sprite/Lucia
- Template:Sprite/Rin
- Template:Sprite/Buro
- Template:Sprite/Marija
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
