imported>Outrowed: improve doc; deprecate pixel-image

2026-02-27T18:01:52Z

improve doc; deprecate pixel-image

New page

{{documentation header}}
{{Uses TemplateStyles|Template:Mob icon/styles.css}}
This template generates a mob container that displays their name and face/icon. It's primarily used in {{slink|Mob}} page with {{t|Mob icon list}}, which is used to contain multiple mob icons inside.

== Usage ==
* {{p|1|''<mob name>''}} – the mob's name shown under the icon.
* {{p|image|''<path>''}} – the mob's face image for the icon. When unspecified, it uses <code>File:''<mob name>'' face.png</code> as the image file.
** For legacy purpose, if <code>File:''<mob name>''Face.png</code> exists, it uses that instead of the current format. For newer mob face images, please use (or move to) <code>File:''<mob name>'' face.png</code> format.
* {{p|image-size|''<size>''}} – the image's size. Its value is directly used for the image tag itself, making it equivalent to [[mw:Help:Images#Size_and_frame|Wikitext image size]]. The max width for the image is 120px hard-coded in CSS.
* {{p|class|''<image class>''}} – specifies class for the image. There are several useful image classes you can use:
** <code>drop-shadow-light</code> which adds a light drop shadow behind the image, making it stand out and more visible.
** <code>pixel-image</code> removes anti aliasing for small resolution pixelated image.

* {{p|link|''<page>''}} – the page title where the user directs to when the mob icon is clicked. Defaults to the mob's name as the page title. When <code>link=none</code> is specified, it disables the link.
* {{p|externallink|''<external page>''}} – the external page which a new tab opens for. Overrides {{p|link}}'s functionality.
* {{p|postfix|''<postfix>''}} – text content inserted after the mob's name. This is useful for inserting references, notes, etc.
* {{p|image-element|''<image code>''}} – inserts custom image element code using Wikitext syntax. This is useful for using animated images via {{t|Animate}}, or other custom image tags.
* {{p|text-nowrap|1}} – forces the mob's name to unwrap. For partial unwrapping, use {{t|Nowrap}}.

== Examples ==

A basic example using the template to produce Allay mob icon:

<syntaxhighlight lang=wikitext>
{{Mob icon|Allay}}
</syntaxhighlight>

{{Produces|{{Mob icon|Allay}}}}

When the mob's name is specified, it gets the image from "''File:<mob name> face.png''", for example with [[Iron Golem]]:

<syntaxhighlight lang=wikitext>
{{Mob icon|Iron Golem}}

</syntaxhighlight>

{{Produces|{{Mob icon|Iron Golem}}}}

By default, the mob icon links to an article with the same name, but you can specify the link manually with {{p|link}}:

<syntaxhighlight lang=wikitext>
{{Mob icon|Monster|link=Monster (entity)|image=HumanFace.png}}
</syntaxhighlight>

{{Produces|{{Mob icon|Monster|link=Monster (entity)|image=HumanFace.png}}}}

Note the {{p|link}} parameter does not work with external link, for that, you'd need to use {{p|externallink}}:

<syntaxhighlight lang=wikitext>
{{Mob icon|Alpaca|externallink=https://en.wikipedia.org/wiki/Alpaca|image=AlpacaFace.png}}
</syntaxhighlight>

Alternatively, you can use <code><nowiki>{{fullurl:...}}</nowiki></code> parser to get the full URL from a wiki link:

<syntaxhighlight lang=wikitext>
{{Mob icon|Alpaca|externallink={{fullurl:w:Alpaca}}|image=AlpacaFace.png}}

</syntaxhighlight>

{{Produces|{{Mob icon|Alpaca|externallink={{fullurl:wikipedia:Alpaca}}|image=AlpacaFace.png}}}}

If you don't want to use link, you can omit it intentionally by specifying {{p|link|none}}. Additionally, the {{p|image}} parameter also specifies a custom image:

<syntaxhighlight lang=wikitext>
{{Mob icon|Raccoon|link=none|image=RacoonFace.png}}
</syntaxhighlight>

{{Produces|{{Mob icon|Raccoon|link=none|image=RacoonFace.png}}}}

You can add custom HTML classes to the image. For example, here's one with {{cd|drop-shadow-light}}, which adds light drop shadow behind the image:

<syntaxhighlight lang=wikitext>
{{Mob icon|Firefly|link=Story Mode:Firefly|image=Firefly.png|class=drop-shadow-light}}
</syntaxhighlight>

{{Produces|{{Mob icon|Firefly|link=Story Mode:Firefly|image=Firefly.png|class=drop-shadow-light}}}}

You can add a postfix text with {{p|postfix}}, which is useful for adding extraneous information:

<syntaxhighlight lang=wikitext>
{{Mob icon|Pufferfish|postfix=<br>(defensive)}}
</syntaxhighlight>

{{Produces|{{Mob icon|Pufferfish|postfix=<br>(defensive)}}}}

The {{p|postfix}} is also useful for adding body notes (or references):

<syntaxhighlight lang=wikitext>
{{Mob icon|Pigman|postfix={{note|An unimplemented mob.}}}}
</syntaxhighlight>

{{Produces|{{Mob icon|Pigman|postfix={{note|An unimplemented mob.}}}}
<references group="note"/>}}

You can specify a custom image element (i.e., custom {{xtag|img}} tag), usually produced from templates, such as {{t|animate}} (which animates individual image files into a single image):

<syntaxhighlight lang=wikitext>
{{Mob icon|Mob|link=Mob (entity)|image-element={{animate|HumanFace.png;RanaFace.png;SteveFace.png;BlackSteveFace.png;BeastBoyFace.png|link=Mob (entity)}}}}
</syntaxhighlight>

{{Produces|{{Mob icon|Mob|link=Mob (entity)|image-element={{animate|HumanFace.png;RanaFace.png;SteveFace.png;BlackSteveFace.png;BeastBoyFace.png|link=Mob (entity)}}}}}}

== TemplateData ==
<templatedata>
{
"params": {
"1": {
"description": "Specifies the mob's name.",
"type": "string"
},
"image-size": {
"description": "Specifies custom image size. Equivalent to Wikitext image size syntax.",
"type": "string"
},
"image-element": {
"description": "Specifies custom image element. Can be any wikitext.",
"type": "unbalanced-wikitext"
},
"image": {
"description": "Specifies the image's file.",
"type": "wiki-file-name"
},
"pixel-image": {
"description": "Specifies if the image uses \"pixel-image\" class or not. Doesn't work when using custom image element.",
"type": "boolean",
"default": "1"
},
"class": {
"description": "Adds additional classes to the image.",
"type": "string"
},
"link": {
"description": "Specifies the mob's link. Putting \"none\" disables linking.",
"type": "string"
},
"text-nowrap": {
"description": "Specifies if the text for the mob's name should wrap or not.",
"type": "boolean",
"default": "0"
},
"postfix": {
"description": "Specifies a text after the mob's name. Useful for adding a reference, note, or custom text.",
"type": "string"
}
},
"description": "A template for generating a mob icon with their name and icon.",
"format": "inline",
"paramOrder": [
"1",
"postfix",
"link",
"image",
"image-size",
"pixel-image",
"class",
"image-element",
"text-nowrap"
]
}
</templatedata>

<includeonly>{{sandbox other||

[[es:Plantilla:MuestraEntidad]]
[[ja:テンプレート:Mob icon]]
[[pt:Predefinição:Ícone de criatura]]
[[ru:Шаблон:Иконка моба]]
[[uk:Шаблон:Зображення моба]]
[[zh:Template:Mob icon]]
}}</includeonly>
<noinclude>

[[es:Plantilla:MuestraEntidad/doc]]
[[pt:Predefinição:Ícone de criatura/doc]]
[[ru:Шаблон:Иконка моба/док]]
[[uk:Шаблон:Зображення моба/док]]
[[zh:Template:Mob icon/doc]]
</noinclude>

Template:MC/Mob icon/doc - Revision history

imported>Outrowed: improve doc; deprecate pixel-image