Template:Item/doc: Difference between revisions
>OmegaK2 No edit summary |
>OmegaK2 No edit summary |
||
Line 3: | Line 3: | ||
{{lua|Module:Item2}} | {{lua|Module:Item2}} | ||
{{ambox|type=speedy|text=This template is under development should | {{ambox|type=speedy|text=This template is under development should only be used for skill gems at this point. Please refer to [[Module:Item]] for the time being}} | ||
Semantic Mediawiki version of the item template. | Semantic Mediawiki version of the item template. | ||
Line 9: | Line 9: | ||
==Overview== | ==Overview== | ||
This template should be used for all items on the wiki and it will take of setting semantic properties, creating an infobox as well as setting categories. | |||
'''It is meant for usage on permanent pages, do not use it on user pages'''. | |||
Currently the template is safe to use for the following item classes: | |||
* Active Skill Gems | |||
* Support Skill Gems | |||
==Parameters== | ==Parameters== | ||
Line 25: | Line 28: | ||
|- | |- | ||
| class | | class | ||
| | | str | ||
| {{yes}} | | {{yes}} | ||
| | | A valid [[item class]] | ||
|- | |- | ||
| rarity | | rarity | ||
| | | str | ||
| {{yes}} | | {{yes}} | ||
| | | [[rarity]] of the item, one of: | ||
* Normal | |||
* Magic | |||
* Rare | |||
* Unique | |||
|- | |- | ||
| name | | name | ||
| | | str | ||
| {{yes}} | | {{yes}} | ||
| | | Name of the item | ||
|- | |- | ||
| size_x | | size_x | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | x-size in inventory units, i.e. the width | ||
|- | |- | ||
| size_y | | size_y | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | y-size in inventory units, i.e. the width | ||
|- | |- | ||
| drop_level | | drop_level | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | At which level the item starts dropping at (may differ from required_level) | ||
|- | |- | ||
| required_level | | required_level | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | Which level is required to use the item (may differ from drop_level) | ||
|- | |- | ||
| required_dexterity | | required_dexterity | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | The [[dexterity]] requirement of the item if any | ||
|- | |- | ||
| required_intelligence | | required_intelligence | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | The [[intelligence]] requirement of the item if any | ||
|- | |- | ||
| required_strength | | required_strength | ||
| | | int | ||
| {{no}} | |||
| The [[strength]] requirement of the item if any | |||
|- | |||
| flavour_text | |||
| str | |||
| {{no}} | | {{no}} | ||
| | | Flavour text if any (i.e. for unique items, vaal fragments, divination cards, etc) | ||
|- | |- | ||
| | | help_text | ||
| | | str | ||
| {{no}} | | {{no}} | ||
| | | Help text if any | ||
For some item classes such as gems a default string is inserted if this value is missing. | |||
|- | |- | ||
| | | tags | ||
| | | list[str] | ||
| {{no}} | | {{no}} | ||
| | | List of internal tags | ||
|- | |- | ||
| | | metadata_id | ||
| | | str | ||
| {{no}} | | {{no}} | ||
| | | Internal metadata id of the item | ||
|} | |} | ||
Line 107: | Line 120: | ||
|- | |- | ||
| flask_duration | | flask_duration | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | How long the flask lasts | ||
|- | |- | ||
| charges_max | | charges_max | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | Maximum number of charges the flask holds | ||
|- | |- | ||
| charges_per_use | | charges_per_use | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | Charges consumed when the flask is used | ||
|} | |} | ||
Line 135: | Line 148: | ||
|- | |- | ||
| critical_strike_chance | | critical_strike_chance | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | Base critical strike chance of the weapon | ||
|- | |- | ||
| attack_speed | | attack_speed | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | Base attack speed of the weapon | ||
|- | |- | ||
| damage_min | | damage_min | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | Minimum base physical damage of the weapon | ||
|- | |- | ||
| damage_max | | damage_max | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | Maximum base physical damage of the weapon | ||
|- | |- | ||
| range | | range | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | Range in game units of the weapon | ||
|} | |} | ||
Line 173: | Line 186: | ||
|- | |- | ||
| armour | | armour | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | [[Armour]] of the armour | ||
|- | |- | ||
| energy_shield | | energy_shield | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | [[Energy Shield]] of the armour | ||
|- | |- | ||
| evasion | | evasion | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | [[Evasion Rating]] of the armour | ||
|} | |} | ||
Line 201: | Line 214: | ||
|- | |- | ||
| gem_tags | | gem_tags | ||
| | | list[str] | ||
| {{no}} | | {{no}} | ||
| | | List of gem tags. | ||
The gem tags will be matched against a list of verified tags. | |||
|- | |- | ||
| dexterity_percent | | dexterity_percent | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | [[Dexterity]] portion of the gem stat distribution. | ||
For pure gems, this is usually 100 for the primary attribute and 0 for the other attribute. | |||
For hybrid gems, this is usually 60 for the primary attribute, 40 for the secondary attribute, and 0 for the remaining attribute. | |||
|- | |- | ||
| strength_percent | | strength_percent | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | [[Strength]] portion of the gem stat distribution. | ||
|- | |- | ||
| intelligence_percent | | intelligence_percent | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | [[Intelligence]] portion of the gem stat distribution. | ||
|} | |} | ||
Line 234: | Line 250: | ||
|- | |- | ||
| stack_size | | stack_size | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | Maximum stack size of the item | ||
|} | |} | ||
Line 253: | Line 269: | ||
Hybrid Flasks | Hybrid Flasks | ||
| flask_life | | flask_life | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | How much [[Life]] the flask recovers | ||
|- | |- | ||
| Mana Flasks | | Mana Flasks | ||
Hybrid Flasks | Hybrid Flasks | ||
| flask_mana | | flask_mana | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | How much [[Mana]] the flask recovers | ||
<!-- | |||
|- | |- | ||
| Active Skill Gems | | Active Skill Gems | ||
Line 275: | Line 292: | ||
| {{no}} | | {{no}} | ||
| | | | ||
--> | |||
|- | |- | ||
| Shields | | Shields | ||
| block | | block | ||
| | | int | ||
| {{no}} | | {{no}} | ||
| | | The base chance to block on shields | ||
|} | |} | ||
Revision as of 17:37, 5 April 2016
This subpage provides documentation for Template:Item.
Semantic Mediawiki version of the item template.
Overview
This template should be used for all items on the wiki and it will take of setting semantic properties, creating an infobox as well as setting categories.
It is meant for usage on permanent pages, do not use it on user pages.
Currently the template is safe to use for the following item classes:
- Active Skill Gems
- Support Skill Gems
Parameters
Base
Parameter | Value | Required | Description |
---|---|---|---|
class | str | A valid item class | |
rarity | str | rarity of the item, one of:
| |
name | str | Name of the item | |
size_x | int | x-size in inventory units, i.e. the width | |
size_y | int | y-size in inventory units, i.e. the width | |
drop_level | int | At which level the item starts dropping at (may differ from required_level) | |
required_level | int | Which level is required to use the item (may differ from drop_level) | |
required_dexterity | int | The dexterity requirement of the item if any | |
required_intelligence | int | The intelligence requirement of the item if any | |
required_strength | int | The strength requirement of the item if any | |
flavour_text | str | Flavour text if any (i.e. for unique items, vaal fragments, divination cards, etc) | |
help_text | str | Help text if any
For some item classes such as gems a default string is inserted if this value is missing. | |
tags | list[str] | List of internal tags | |
metadata_id | str | Internal metadata id of the item |
Class groups
Parameters that apply to various groups of item classes.
Flasks
Eligible item classes:
Life Flasks, Mana Flasks, Hybrid Flasks, Utility Flasks, Critical Utility Flasks
Parameter | Value | Required | Description |
---|---|---|---|
flask_duration | int | How long the flask lasts | |
charges_max | int | Maximum number of charges the flask holds | |
charges_per_use | int | Charges consumed when the flask is used |
Weapons
Eligible item classes:
'Claws', 'Daggers', 'Wands', 'One Hand Swords', 'Thrusting One Hand Swords', 'One Hand Axes', 'One Hand Maces', 'Bows', 'Staves', 'Two Hand Swords', 'Two Hand Axes', 'Two Hand Maces', 'Sceptres'
Parameter | Value | Required | Description |
---|---|---|---|
critical_strike_chance | int | Base critical strike chance of the weapon | |
attack_speed | int | Base attack speed of the weapon | |
damage_min | int | Minimum base physical damage of the weapon | |
damage_max | int | Maximum base physical damage of the weapon | |
range | int | Range in game units of the weapon |
Armour
Eligible item classes:
'Gloves', 'Boots', 'Body Armours', 'Helmets', 'Shields'
Parameter | Value | Required | Description |
---|---|---|---|
armour | int | Armour of the armour | |
energy_shield | int | Energy Shield of the armour | |
evasion | int | Evasion Rating of the armour |
Gems
Eligible item classes:
'Active Skill Gems', 'Support Skill Gems'
Parameter | Value | Required | Description |
---|---|---|---|
gem_tags | list[str] | List of gem tags.
The gem tags will be matched against a list of verified tags. | |
dexterity_percent | int | Dexterity portion of the gem stat distribution.
For pure gems, this is usually 100 for the primary attribute and 0 for the other attribute. For hybrid gems, this is usually 60 for the primary attribute, 40 for the secondary attribute, and 0 for the remaining attribute. | |
strength_percent | int | Strength portion of the gem stat distribution. | |
intelligence_percent | int | Intelligence portion of the gem stat distribution. |
Stackables
Eligible item classes:
'Currency', 'Stackable Currency', 'Hideout Doodads', 'Microtransactions', 'Divination Card'
Parameter | Value | Required | Description |
---|---|---|---|
stack_size | int | Maximum stack size of the item |
Item class
Parameters specific to item classes
Class | Parameter | Value | Required | Description |
---|---|---|---|---|
Life Flasks
Hybrid Flasks |
flask_life | int | How much Life the flask recovers | |
Mana Flasks
Hybrid Flasks |
flask_mana | int | How much Mana the flask recovers | |
Shields | block | int | The base chance to block on shields |