Module:ItemTooltip/doc

From Risk of Rain 2 Wiki
Jump to navigation Jump to search

This is the documentation page for Module:ItemTooltip

ItemTooltip builds tooltips of Risk of Rain 2's items.

Documentation

Package items

itemtooltip.GetRarity(frame) (function)
Gets the item rarity.
Parameter: frame Frame object w/ first argument being the item name and 2nd argument being to use simple form of rarity (default false) (table)
Returns: Item rarity name (string)
itemtooltip.GetDescription(frame, item) (function)
Gets the item description.
Parameters:
frame Frame object w/ first argument being the item name (table)
item Item database entry (table; optional)
Returns: Item description (string)
itemtooltip.GetQuote(frame, item) (function)
Gets the item flavor text quote.
Parameters:
frame Frame object w/ first argument being the item name (table)
item Item database entry (table; optional)
Returns: Item quote (string)
itemtooltip.GetTooltip(frame) (function)
Gets the item's tooltip.
Parameter: frame Frame object w/ first argument being the item name (table)
Returns: Wikitext of tooltip (string)