Editing Template:ItemData/docGive feedback

This template allows you to display item stats automatically using the game files. It pulls data directly from [[Data:ItemData.json]].

== ⚡ Quick Start ==
# Go to [[Data:ItemData.json]] and find the item you want.
# Use the template with the item's name and the property you need.

'''Basic Example:'''
<code><nowiki>{{ItemData|Divine Barrier|BulletResist}}</nowiki></code> → {{ItemData|Divine Barrier|BulletResist}}

== 📖 Template Functions ==
The template has different modes depending on what information you need.

=== Getting Properties (Default) ===
This is the most common use case. Just provide the item name and the property you want.

'''Syntax:'''
<code><nowiki>{{ItemData|Item Name|PropertyName}}</nowiki></code>

'''Examples:'''
* <code><nowiki>{{ItemData|Divine Barrier|CombatBarrier}}</nowiki></code> → {{ItemData|Divine Barrier|CombatBarrier}}
* <code><nowiki>{{ItemData|Healing Rite|AbilityCooldown}}</nowiki></code> → {{ItemData|Healing Rite|AbilityCooldown}}
* <code><nowiki>{{ItemData|Rapid Rounds|BonusFireRate}}</nowiki></code> → {{ItemData|Rapid Rounds|BonusFireRate}}

'''Note:''' Properties that represent percentages (like <code>BulletResist</code> or <code>BonusFireRate</code>) automatically have a % sign added.

=== Getting Cost ===
Shows the cost of an item in souls (automatically formatted with commas).

'''Syntax:'''
<code><nowiki>{{ItemData|cost|Item Name}}</nowiki></code>

'''Example:'''
* <code><nowiki>{{ItemData|cost|Divine Barrier}}</nowiki></code> → {{ItemData|cost|Divine Barrier}}

=== Getting Type/Category ===
Shows whether an item is Weapon, Vitality, or Spirit.

'''Syntax:'''
<code><nowiki>{{ItemData|type|Item Name}}</nowiki></code>

'''Example:'''
* <code><nowiki>{{ItemData|type|Divine Barrier}}</nowiki></code> → {{ItemData|type|Divine Barrier}}
* <code><nowiki>{{ItemData|type|Divine Barrier|raw=true}}</nowiki></code> → {{ItemData|type|Divine Barrier|raw=true}} ''(English version)''

=== Checking if Active ===
Returns true if the item has an active ability, false if it's passive.

'''Syntax:'''
<code><nowiki>{{ItemData|active|Item Name}}</nowiki></code>

'''Example:'''
* <code><nowiki>{{ItemData|active|Divine Barrier}}</nowiki></code> → {{ItemData|active|Divine Barrier}}

=== Getting Component Name ===
Shows the name of the item's component (if it has one).

'''Syntax:'''
<code><nowiki>{{ItemData|component|Item Name}}</nowiki></code>

'''Example:'''
* <code><nowiki>{{ItemData|component|Titanic Magazine}}</nowiki></code> → {{ItemData|component|Titanic Magazine}}

=== Getting Codename ===
Returns the internal JSON key for an item (useful for advanced template work).

'''Syntax:'''
<code><nowiki>{{ItemData|codename|Item Name}}</nowiki></code>

'''Example:'''
* <code><nowiki>{{ItemData|codename|Divine Barrier}}</nowiki></code> → {{ItemData|codename|Divine Barrier}}

== ❌ Common Errors ==
* <span style="color:red;">Item Not Found.</span>
*: The item name is spelled incorrectly or doesn't exist in the data. Make sure to use the exact display name (e.g., "Divine Barrier" not "divine barrier").
* Template returns nothing
*: The property doesn't exist for that item, or the property name is spelled incorrectly. Check [[Data:ItemData.json]] to see available properties.

<templatedata>
{
	"description": "Displays item stats and information from game files. Use Data:ItemData.json to find available properties.",
	"params": {
		"1": {
			"label": "Function or Item Name",
			"description": "Either a function name (cost, type, active, component, codename) OR the item's display name when getting properties.",
			"type": "string",
			"required": true,
			"example": "Divine Barrier",
			"suggestedvalues": ["cost", "type", "active", "component", "codename"]
		},
		"2": {
			"label": "Item Name or Property",
			"description": "The item's display name (if param 1 is a function) OR the property name to retrieve (if param 1 is an item).",
			"type": "string",
			"required": false,
			"example": "BulletResist"
		},
		"raw": {
			"label": "Raw output",
			"description": "Only for 'type' function. Set to 'true' to get English language output instead of localized.",
			"type": "boolean",
			"required": false,
			"default": "false"
		}
	},
	"format": "inline"
}
</templatedata>

<includeonly>
[[Category:Templates]]
</includeonly><noinclude>
[[Category:Template documentation]]
</noinclude>