Editing Module:ItemTooltip/doc

== Module:ItemTooltip ==

This module displays styled item tooltip panels for wiki pages.

=== Basic Usage ===

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

=== Parameters ===

{| class="wikitable"
|-
! 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 ===

{| class="wikitable"
|-
! Parameter !! Bonus Parameter !! Description
|-
| damage || damageBonus || Damage 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 ===

{| class="wikitable"
|-
! 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 ===

{| class="wikitable"
|-
! Rarity !! Color !! Example
|-
| common || Silver || {{color|silver|Common item.}}
|-
| uncommon || Mint/Green || {{color|#98ff98|Uncommon item.}}
|-
| rare || Sky Blue || {{color|#87ceeb|Rare item.}}
|-
| epic || Pink || {{color|#ff69b4|Epic item.}}
|-
| legendary || Gold || {{color|#ffd700|Legendary item.}}
|}

=== Rarity Shortcuts ===

You can use shortcut functions instead of specifying rarity:

<pre>
{{#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|...}}
</pre>

=== Examples ===

==== Common Food Item ====

<pre>
{{#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
}}
</pre>

==== Weapon with Bonus Stats ====

<pre>
{{#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
}}
</pre>

==== Uncommon Weapon ====

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

==== Rare Weapon ====

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

==== Epic Weapon ====

<pre>
{{#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
}}
</pre>

==== Legendary Tool ====

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

=== Stat Colors ===

* Positive stats: {{color|#9edc60|+10}} (green)
* Negative stats: {{color|#ff6b6b|-3}} (red)
* Bonus stats: {{color|#9bddff|+4}} (blue)

=== Float Position ===

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

<pre>
{{#invoke:ItemTooltip|display
|name=Item Name
|float=left
|...
}}
</pre>

[[Category:Modules]]
[[Category:Item Templates]]