Template:SchematicSprite

From Minecraft Wiki
Jump to: navigation, search
[view | edit | history | purge]Documentation
Lua logo.svg

This template uses Module:Schematic, a script written in Lua.

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.

Sprite sheet for SchematicSprite

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 &#124; for the pipe character: |, or &#61; 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|&rarr;}} displaying an HTML character entity reference
{{SchematicSprite|Q&#x305;}} 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

SchematicSprites can also appear in the flow of text, like this: .

List of identifiers

A sprite identifier is a string of characters that specify which sprite to display.

Identifiers use the following syntax:

  1. A case-sensitive abbreviation of the name of the block, usually two or three letters long. Many blocks also have IDs that are the full name of the block.
  2. A hyphen (-) if the ID has any modifiers.
  3. $ indicates a side view sprite.
  4. Directions are indicated by n (north), s (south), e (east), w (west), u (up), and d (down). Directions are relative to the schematic, not necessarily the Minecraft world.
  5. A number is used for some blocks with multiple states. (e.g. repeaters, composters)
  6. ! usually indicates a powered/activated component.

Basic identifiers

Redstone identifiers

See also

Minecraft
Minecraft (legacy)
Minecraft Dungeons
Other
[view | edit | history | purge]The above documentation is transcluded from Template:SchematicSprite/doc.