Main article: Template:SchematicSprite/ids-basic
Template:SchematicSprite/doc
This template displays a block sprite built from File:SchematicSprite.png.
Usage
SchematicSprite can take one named parameter and any number of unnamed parameters:
{{SchematicSprite|size=<size>|sprite1|sprite2|…}}
The size parameter may be added to specify the width and height of the sprite in pixels. Its value should be a simple number with no units added (e.g., size=16). If omitted, size defaults to 32.
A sprite parameter identifies the sprite to be displayed from the sprite sheet on the right.
If the sprite parameter is not recognized as a valid sprite identifier, it is simply displayed as center-aligned text within the sprite's bounding box. Overflow text is not displayed, so this is primarily intended to be used to display one or two characters in a schematic (such as input and output locations, feature markers to be referenced in text, or numbers representing light levels or distance). HTML character entity references may be needed for some characters, such as | for the pipe character: |, or = for an equals sign.
When multiple sprite parameters are defined, the resulting sprites or text are stacked on top of each other, from bottom to top in the order they were defined.
Examples
| Empty parameters | ||
|---|---|---|
{{SchematicSprite}}
|
omitting the sprite parameter produces a blank sprite (i.e., air) | |
{{SchematicSprite|}}
|
a defined but empty sprite parameter also produces a blank sprite | |
| Characters | ||
| A | {{SchematicSprite|A}}
|
displaying a single character |
| A | {{SchematicSprite|size=16|A}}
|
text scales to sprite size (size=16) |
| → | {{SchematicSprite|→}}
|
displaying an HTML character entity reference |
| Q̅ | {{SchematicSprite|Q̅}}
|
using an HTML character entity reference to combine a character with a diacritical mark |
| 15 | {{SchematicSprite|15}}
|
two characters usually fit… |
| MM | {{SchematicSprite|MM}}
|
…but some do not — text that doesn't fit aligns to the left edge and overflows to the right |
| Sprite identifiers | ||
{{SchematicSprite|grass block}}
|
displaying a sprite predefined by a sprite identifier | |
| Stacked sprites | ||
{{SchematicSprite|SB+rd-!}}
|
redstone dust on block of gold | |
A |
{{SchematicSprite|size=24|SB+A}}
|
text on block of gold |
A |
{{SchematicSprite|obsidian+A}}
|
text has a blurred white shadow behind it, to help it show up against dark backgrounds |
| Error testing (section not transcluded) | ||
| " | {{SchematicSprite|"}}
|
okay |
| & | {{SchematicSprite|&}}
|
okay |
| ' | {{SchematicSprite|'}}
|
okay |
| < | {{SchematicSprite|<}}
|
okay |
| > | {{SchematicSprite|>}}
|
okay |
| = | {{SchematicSprite|=}}
|
substitution required for equals sign (used to create a named parameter) |
| | | {{SchematicSprite||}}
|
substitution required for vertical line (used to delimit parameters) |
SchematicSprites can also appear in the flow of text, like this:
.
List of identifiers
An identifier is a string of characters that specify which sprite to display.
See also
- {{Sprite}}
- {{BiomeSprite}}
- {{BlockSprite}}
- {{CommentSprite}}
- {{EffectSprite}}
- {{EntitySprite}}
- {{EnvSprite}}
- {{ItemSprite}}
- {{SchematicSprite}}
- Module:Sprite
This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.
