Editing Template:Sprite/doc

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.

== Arguments ==

{| class="wikitable"
|+ Caption text
|-
! 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. Use full MediaWiki notation, e.g. <code><nowiki>[[File:IanSpriteS|alt=alt text]]</nowiki></code>
|}