Module:ItemTooltip/doc

Module:ItemTooltip

This module displays styled item tooltip panels for wiki pages.

Basic Usage

{{#invoke:ItemTooltip|display
|name=Item Name
|rarity=common
|damage=10
|weight=5
}}

Parameters

Parameter	Required	Description
name	Yes	The item's display name (also used for sprite)
rarity	No	common, uncommon, rare, epic, or legendary (default: common)
type	No	Item type shown in brackets, e.g., "Dagger", "Large Weapons"
description	No	Flavor text (shown in green/jade color)
float	No	"right" or "left" (default: right)
spriteSize	No	Sprite size in pixels (default: 64)

Stats

Parameter	Bonus Parameter	Description
damage	damageBonus	Damage value
armor	armorBonus	Armor value
defense	defenseBonus	Defense value
range	rangeBonus	Range value
attackspeed	attackspeedBonus	Attack speed (negative values show in red)
movespeed	movespeedBonus	Movement speed
hpRegen	hpRegenBonus	HP regeneration
mpRegen	mpRegenBonus	MP regeneration
size	-	Size value (e.g., "8/10")
weight	-	Weight in oz (just the number)

Special Properties

Parameter	Description
special	Special effect text (shown in blue), e.g., "Fills you for 340 seconds"
action	Action hint, e.g., "right-click to eat"
category	Additional category, e.g., "Special Foods"

Rarity Colors

Rarity	Color	Example
common	Silver	Template:Color
uncommon	Mint/Green	Template:Color
rare	Sky Blue	Template:Color
epic	Pink	Template:Color
legendary	Gold	Template:Color

Rarity Shortcuts

You can use shortcut functions instead of specifying rarity:

{{#invoke:ItemTooltip|common|name=Basic Sword|...}}
{{#invoke:ItemTooltip|uncommon|name=Silver Dagger|...}}
{{#invoke:ItemTooltip|rare|name=Crossbow|...}}
{{#invoke:ItemTooltip|epic|name=Battle Axe|...}}
{{#invoke:ItemTooltip|legendary|name=Excalibur|...}}

Examples

Common Food Item

{{#invoke:ItemTooltip|display
|name=Blueberry Muffin
|rarity=common
|damage=2
|movespeed=1
|hpRegen=12
|mpRegen=8
|weight=10.5
|special=Fills you for 340 seconds
|action=right-click to eat
|category=Special Foods
}}

Weapon with Bonus Stats

{{#invoke:ItemTooltip|display
|name=Broadsword
|rarity=common
|range=2
|damage=27
|damageBonus=4
|attackspeed=-3
|defense=5
|size=8/10
|weight=75
|type=Large Weapons
}}

Uncommon Weapon

{{#invoke:ItemTooltip|uncommon
|name=Silver Dagger
|type=Dagger
|description=For rituals.
|damage=4
|attackspeed=3
|size=2/10
|weight=5.6
}}

Rare Weapon

{{#invoke:ItemTooltip|rare
|name=Crossbow
|type=Crossbow
|range=61
|damage=4
|attackspeed=-3
|defense=2
|size=9/10
|weight=22.4
}}

Epic Weapon

{{#invoke:ItemTooltip|epic
|name=Battle Axe
|type=Large Axe
|description=A nhordic axe.
|range=4
|damage=44
|attackspeed=-1
|defense=4
|size=8/10
|weight=45
}}

Legendary Tool

{{#invoke:ItemTooltip|legendary
|name=Shovel
|type=Tools
|description=Used to open holes.
|damage=11
|defense=5
|size=6/10
|weight=13
}}

Stat Colors

• Positive stats: Template:Color (green)
• Negative stats: Template:Color (red)
• Bonus stats: Template:Color (blue)

Float Position

By default, tooltips float to the right. Use float=left to position on the left side:

{{#invoke:ItemTooltip|display
|name=Item Name
|float=left
|...
}}