Module:ItemData/doc: Difference between revisionsGive feedback
Created page with "Loads data from Data:ItemData.json" |
Updated doc with new functions explained |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
Loads data from [[Data:ItemData.json]] | Loads data from [[Data:ItemData.json]] | ||
==Usage== | |||
<pre>{{#invoke:ItemData|FUNCTION_NAME|PARAMETER1|PARAMETER2}}</pre> | |||
==Functions== | |||
*<code>get_cost|ITEM_NAME</code> | |||
**Returns the total cost including components. | |||
*<code>get_type|ITEM_NAME</code> | |||
**The ItemData.json has different names for each category: Weapon = Weapon, Vitality = Armor, Spirit = Tech. This function will return Weapon, Vitality, or Spirit | |||
*<code>is_active|ITEM_NAME</code> | |||
**returns true/false | |||
*<code>get_prop|ITEM_NAME|PROPERTY</code> | |||
**Returns the value of one of the item's properties. Check the [[Data:ItemData.json|json file]] for item properties. | |||
**Automatically appends "%" to percentage-based properties and shows scaling templates (Boon/Ss) when applicable. | |||
*<code>get_codename|ITEM_NAME</code> | |||
**Returns the item's codename in game files | |||
*<code>get_component_name|ITEM_NAME</code> | |||
**Returns the display name of the item's first component (if any) | |||
*<code>get_headcount</code> | |||
**Returns the number of items that are not disabled | |||
*<code>get_builds_into|ITEM_NAME</code> | |||
**Returns a formatted list of items that use this item as a component, rendered with ItemIcon templates (e.g., "ItemIcon templates separated by commas and 'and'") | |||
*<code>get_builds_into_count|ITEM_NAME</code> | |||
**Returns the number of items that use this item as a component | |||
*<code>get_builds_into_name|ITEM_NAME|INDEX</code> | |||
**Returns the display name of the nth item (1-indexed) that uses this item as a component | |||
==Example== | |||
To get the total cost of [[Boundless Spirit]] you'd type: | |||
<pre>{{#invoke:ItemData|get_cost|Boundless Spirit}}</pre> | |||
and it would return: | |||
<code>{{#invoke:ItemData|get_cost|Boundless Spirit}}</code> | |||
To get Boundless Spirit's Spirit Power: | |||
<pre>{{#invoke:ItemData|get_prop|Boundless Spirit|TechPower}}</pre> | |||
and it would return: | |||
<code>{{#invoke:ItemData|get_prop|Boundless Spirit|TechPower}}</code> | |||
If an item key (English name) has been provided, the item name can be replaced by: | |||
<pre>{{#var:item_key_or_en}}</pre> | |||
for example: | |||
<pre>{{#invoke:ItemData|get_prop|{{#var:item_key_or_en}}|TechPower}}</pre> | |||
To get Boundless Spirit's codename: | |||
<pre>{{#invoke:ItemData|get_codename|Boundless Spirit}}</pre> | |||
and it would return: | |||
<code>{{#invoke:ItemData|get_codename|Boundless Spirit}}</code> | |||
To find what items Debuff Reducer builds into: | |||
<pre>{{#invoke:ItemData|get_builds_into|Debuff Reducer}}</pre> | |||
and it would return: | |||
<code>{{#invoke:ItemData|get_builds_into|Debuff Reducer}}</code> | |||