Jump to content

Template:Infobox Tool/doc

From Community Wiki | Soulbound: Online
This is the documentation subpage for Template:Infobox Tool. It holds usage notes, parameters and examples, and is transcluded onto the template page itself. Edit the documentation here; edit the template's code on the template page.

Infobox for tools — pickaxes, gloves, fishing rods, hacking tools, hoes and spiles. Gear uses {{Infobox Gear}} . Parameter names are the game's own database keys.

Usage

{{Infobox Tool
| name = Steel Pickaxe
| id = tool_t2_mining_001
| image = Steel Pickaxe icon.png
| tool_type = Pickaxe
| activity = Mining
| tier = 2
| rarity = 2
| base_power = 3
| crit_chance = 10
| skill = Mining
| skill_level = 10
| value = 8
| tradeable = Yes
| examine = Swings true and lets you mine Iron Outcrops.
}}

Rules that are easy to get wrong

  • Tools are craft-only. They never drop from dungeons and never roll bonus stats, so a tool page has no Possible rolls section and this template has no rolls, legendary or craftable parameter. Typing one does nothing.
  • Tools do not use the gear stat parameters. A tool has base_power and crit_chance and nothing else. power, attack_speed and the rest are ignored here.
  • tier is required — it is what the template uses to say which gathering nodes the tool works, and a blank tier stamps Category:Pages missing data

.

  • Capitalise activity exactlyMining, Foraging, Fishing, Hacking, Farming. The value is used as a link and built into the category name, so a lower-case value creates a broken duplicate category.
  • skill is rendered as a link, and skill_level shows ? if you leave it blank — fill it in or leave both out.
  • Tool icons are 32×32 PNGs (gear icons are 16×16), named <Page title> icon.png.

Categories it applies

Automatic, in article space only: Category:Tools , Tools - activity, Tier N Items, and Category:Craftable Items

— that last one unconditionally, because every tool is crafted. Plus Category:Pages needing an image
when image is blank and Category:Pages missing data
when name or tier is.

For the page around the infobox, see Wiki:Item page guide.

Infobox for gathering tools. Craft-only: no roll or legendary parameters.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename

no description

Stringrequired
Item IDid

no description

Stringsuggested
Icon fileimage

"<Page title> icon.png" — tool icons are 32×32

Filesuggested
Image alt textalt

no description

Stringoptional
Tool typetool_type

Pickaxe, Gloves, Fishing Rod, Hacking Tool, Hoe, Spile

Stringrequired
Activityactivity

Mining, Foraging, Fishing, Hacking, Farming — capitalise exactly, it is copied into the category name

Stringrequired
Tool tiertier

1–6; gates which nodes the tool can work

Numberrequired
Rarity numberrarity

0–5

Numberoptional
Base Powerbase_power

no description

Numberoptional
Crit Chance %crit_chance

no description

Numberoptional
Required skillskill

Rendered as a link

Stringoptional
Required skill levelskill_level

Shows ? if omitted while skill is set

Numberoptional
Sell value (gold)value

no description

Numberoptional
Tradeabletradeable

no description

Stringoptional
Examine / flavour textexamine

no description

Stringoptional