Template:IconSAP/doc

From Super Auto Pets Wiki
Jump to navigation Jump to search

An all-in-one template for displaying content for Pets, Food, and more. By default, the template displays a link to the icon and adds the icon in front of it.

The naming convention for icons is: {{Name}}_Icon.png. Images should be taken from the game's files, 2x outline thickness, and pets should be facing the right side.

Usage

All parameters are optional except for first unnamed parameter.

first unnamed parameter

Default icon display name, link target, and image file name.

mode = image/text/reverse

Toggle for only displaying the icon's image, or the icon's text, or swapping the icon to be displayed after the text.

nolink
nolink = yes

Toggle for the link to be activated. If set, the template text will be plain text.

name

Overrides link display text. Commonly used for adding suffixes to the link text.

image

Overrides icon image. When used, file type must be included (ex. image=Chili.png)

size

Overrides image size. By default this value is set to 25x25px. When used, units must be included (ex. size=x50px)

Examples

Result Code Notes
Puppy {{IconSAP|Puppy}} Basic usage.
{{IconSAP|Experience|mode=image}} Only display image, text will not show.
Shark {{IconSAP|Shark|mode=text}} Only display text, image will not show.
Weak {{IconSAP|Weak|mode=reverse}} Display the icon after the text.
Witch Broom {{IconSAP|Witch Broom|nolink=yes}} Deactivate link.
Melon Armor {{IconSAP|Melon|name=Melon Armor}} Custom link display text.
Crow {{IconSAP|Crow|image=TopHat.png}} Custom image.
Chocolate {{IconSAP|Chocolate|size=x75px}} Custom size.
Pig {{IconSAP|Pig|image=Bacon.png|size=50px}} Custom image and size.