Template:Skill/doc: Difference between revisions
>OmegaK2 |
>OmegaK2 (→Parameters: updated to reflect template changes and added associated properties) |
||
Line 18: | Line 18: | ||
! {{abbr|Opt|Optional}} | ! {{abbr|Opt|Optional}} | ||
! {{abbr|Auto|PyPoE exported?}} | ! {{abbr|Auto|PyPoE exported?}} | ||
! Property | |||
! Description | ! Description | ||
|- | |- | ||
Line 24: | Line 25: | ||
| {{yes}} | | {{yes}} | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Is skill id|Is skill id]] | |||
| The (internal) skill id of the skill | | The (internal) skill id of the skill | ||
|- | |- | ||
Line 30: | Line 32: | ||
| {{yes}} | | {{yes}} | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Is support gem]] | |||
| Whether the skill is a support gem. | | Whether the skill is a support gem. | ||
|- | |- | ||
Line 36: | Line 39: | ||
| {{yes}} | | {{yes}} | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Has support gem letter|Has support gem letter]] | |||
| The support gem letter (i.e. the small letter icon shown when skills are supported by this skill) | | The support gem letter (i.e. the small letter icon shown when skills are supported by this skill) | ||
|- | |- | ||
Line 42: | Line 46: | ||
| {{yes}} | | {{yes}} | ||
| {{yes}} | | {{yes}} | ||
| Cast time in seconds | | [[Property:Has cast time|Has cast time]] | ||
| Cast time (or animation time) in seconds | |||
Only active skills. | Only active skills. | ||
|- | |- | ||
Line 49: | Line 54: | ||
| {{yes}} | | {{yes}} | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Has description|Has description]] | |||
| The description of the active skill (i.e. what it says when you hover over it in the skill bar). | | The description of the active skill (i.e. what it says when you hover over it in the skill bar). | ||
Only active skills. | Only active skills. | ||
Line 56: | Line 62: | ||
| {{yes}} | | {{yes}} | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Has active skill name|Has active skill name]] | |||
| Name of the active skill | | Name of the active skill | ||
Only active skills. | Only active skills. | ||
Line 63: | Line 70: | ||
| {{yes}} | | {{yes}} | ||
| {{yes}} | | {{yes}} | ||
| Comma separated list of item class restrictions | | [[Property:Has item class restrictions|Has item class restrictions]] | ||
[[Property:Has no item class restrictions|Has no item class restrictions]] | |||
| Comma separated list of item class restrictions. [[Property:Has no item class restrictions|Has no item class restrictions]] will be set to true if there were no restrictions provided, otherwise the property is not set. | |||
Only active skills. | Only active skills. | ||
|- | |- | ||
Line 70: | Line 79: | ||
| {{yes}} | | {{yes}} | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Has stat text|Has stat text]] | |||
| Stat text spanning the entire progression of the skill gem | | Stat text spanning the entire progression of the skill gem | ||
|- | |- | ||
Line 76: | Line 86: | ||
| {{yes}} | | {{yes}} | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Has quality stat text|Has quality stat text]] | |||
| Stat text for the quality bonus spanning the entire progression of the skill gem | | Stat text for the quality bonus spanning the entire progression of the skill gem | ||
|- | |- | ||
Line 82: | Line 93: | ||
| {{yes}} | | {{yes}} | ||
| {{no}} | | {{no}} | ||
| [[Property:Has percentage mana cost|Has percentage mana cost]] | |||
| Whether the mana cost is a percentage (e.x. for [[Aura]]s) | | Whether the mana cost is a percentage (e.x. for [[Aura]]s) | ||
|- | |- | ||
Line 88: | Line 100: | ||
| {{yes}} | | {{yes}} | ||
| {{no}} | | {{no}} | ||
| [[Property:Has reservation mana cost|Has reservation mana cost]] | |||
| Whether the mana cost is reserved instead of being used when the skill cast (e.x. for [[Aura]]s) | | Whether the mana cost is reserved instead of being used when the skill cast (e.x. for [[Aura]]s) | ||
|- | |||
| radius | |||
| int | |||
| {{yes}} | |||
| {{no}} | |||
| [[Property:Has primary radius|Has primary radius]] | |||
| Primary radius. | |||
Also see the property page for details. | |||
|- | |||
| radius_description | |||
| str | |||
| {{yes}} | |||
| {{no}} | |||
| [[Property:Has primary radius description|Has primary radius description]] | |||
| Description to clarify what the primary radius does. | |||
Also see the property page for details. | |||
|- | |||
| radius_secondary | |||
| int | |||
| {{yes}} | |||
| {{no}} | |||
| [[Property:Has secondary radius|Has secondary radius]] | |||
| Secondary radius. | |||
Also see the property page for details. | |||
|- | |||
| radius_secondary_description | |||
| str | |||
| {{yes}} | |||
| {{no}} | |||
| [[Property:Has secondary radius description|Has secondary radius description]] | |||
| Description to clarify what the secondary radius does. | |||
Also see the property page for details. | |||
|- | |||
| radius_tertiary | |||
| int | |||
| {{yes}} | |||
| {{no}} | |||
| [[Property:Has tertiary radius|Has tertiary radius]] | |||
| Tertiary radius. | |||
Also see the property page for details. | |||
|- | |||
| radius_description | |||
| str | |||
| {{yes}} | |||
| {{no}} | |||
| [[Property:Has tertiary radius description|Has tertiary radius description]] | |||
| Description to clarify what the tertiary radius does. | |||
Also see the property page for details. | |||
|} | |} | ||
Line 106: | Line 167: | ||
! Type | ! Type | ||
! Optional | ! Optional | ||
! Property | |||
! Description | ! Description | ||
|- | |- | ||
Line 111: | Line 173: | ||
| int | | int | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Has level requirement|Has level requirement]] | |||
| The level requirement | | The level requirement | ||
|- | |- | ||
Line 116: | Line 179: | ||
| int | | int | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Has dexterity requirement|Has dexterity requirement]] | |||
| Dexterity requirement | | Dexterity requirement | ||
|- | |- | ||
Line 121: | Line 185: | ||
| int | | int | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Has strength requirement|Has strength requirement]] | |||
| Strength requirement | | Strength requirement | ||
|- | |- | ||
Line 126: | Line 191: | ||
| int | | int | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Has intelligence requirement|Has intelligence requirement]] | |||
| Intelligence requirement | | Intelligence requirement | ||
|- | |- | ||
Line 131: | Line 197: | ||
| int | | int | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Has mana multiplier|Has mana multiplier]] | |||
| Mana multiplier in percent | | Mana multiplier in percent | ||
|- | |- | ||
Line 136: | Line 203: | ||
| int | | int | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Has critical strike chance|Has critical strike chance]] | |||
| Critical strike chance in percent | | Critical strike chance in percent | ||
|- | |- | ||
Line 141: | Line 209: | ||
| int | | int | ||
| {{yes}} | | {{yes}} | ||
| Mana cost | | [[Property:Has mana cost|Has mana cost]] | ||
| Mana cost. Depending on whether has_mana_cost_percentage or has_percentage_reservation_cost are true this value is also used as percentage and/or mana reservation cost. | |||
|- | |- | ||
| <nowiki><P></nowiki>_damage_effectiveness | | <nowiki><P></nowiki>_damage_effectiveness | ||
| int | | int | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Has damage effectiveness|Has damage effectiveness]] | |||
| Damage effectiveness in percent | | Damage effectiveness in percent | ||
|- | |- | ||
Line 151: | Line 221: | ||
| int | | int | ||
| {{yes}} | | {{yes}} | ||
| Stored usages (i.e. for [[Traps]] or [[Mines]]) | | [[Property:Has stored uses|Has stored uses]] | ||
| Stored usages (i.e. for [[Traps]] or [[Mines]]). Some other skills may also store "uses" for the purposes of cooldown calculations. | |||
For vaal skills use vaal_stored_uses | For vaal skills use vaal_stored_uses | ||
|- | |- | ||
Line 157: | Line 228: | ||
| float | | float | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Has cooldown|Has cooldown]] | |||
| Cooldown in seconds | | Cooldown in seconds | ||
|- | |- | ||
Line 162: | Line 234: | ||
| int | | int | ||
| {{yes}} | | {{yes}} | ||
| Vaal souls requirement in normal difficulty | | [[Property:Has vaal souls requirement|Has vaal souls requirement]] | ||
| Vaal souls requirement in [[normal]] difficulty. [[Cruel]] and [[Merciless]] can be calculated based on this value. | |||
|- | |- | ||
| <nowiki><P></nowiki>_vaal_stored_uses | | <nowiki><P></nowiki>_vaal_stored_uses | ||
| int | | int | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Has vaal stored uses|Has vaal stored uses]] | |||
| Stored vaal usages | | Stored vaal usages | ||
For regular skill use stored_uses | For regular skill use stored_uses | ||
Line 173: | Line 247: | ||
| str | | str | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Has damage multiplier|Has damage multiplier]] | |||
| Damage multiplier of the skill in percent | | Damage multiplier of the skill in percent | ||
|- | |- | ||
Line 178: | Line 253: | ||
| str | | str | ||
| {{yes}} | | {{yes}} | ||
| Stat text spanning the entire | | [[Property:Has stat text|Has stat text]] | ||
| Stat text spanning the entire level of the skill gem | |||
|- | |- | ||
| <nowiki><P></nowiki>_quality_stat_text | | <nowiki><P></nowiki>_quality_stat_text | ||
| str | | str | ||
| {{yes}} | | {{yes}} | ||
| Stat text for the quality bonus spanning the entire | | [[Property:Has quality stat text|Has quality stat text]] | ||
| Stat text for the quality bonus spanning the entire level of the skill gem | |||
|- | |- | ||
| <nowiki><P></nowiki>_experience | | <nowiki><P></nowiki>_experience | ||
| int | | int | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Has experience requirement|Has experience requirement]] | |||
| '''Total''' amount of experience for this level. | | '''Total''' amount of experience for this level. | ||
Only for skill gems. | Only for skill gems. | ||
Line 198: | Line 276: | ||
Replace <code><nowiki><P></nowiki></code> with the appropriate parameter from above. | Replace <code><nowiki><P></nowiki></code> with the appropriate parameter from above. | ||
Please note that the stats will be placed as into the properties as multi-value. | |||
{| class="wikitable" | {| class="wikitable" | ||
Line 203: | Line 283: | ||
! Type | ! Type | ||
! Optional | ! Optional | ||
! Property | |||
! Description | ! Description | ||
|- | |- | ||
| <nowiki><P></nowiki> | | <nowiki><P></nowiki>_stat<nowiki><M></nowiki>_id | ||
| str | | str | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Has stat ids|Has stat ids]] | |||
| The internal id of the stat | | The internal id of the stat | ||
|- | |- | ||
| <nowiki><P></nowiki> | | <nowiki><P></nowiki>_stat<nowiki><M></nowiki>_value | ||
| int | | int | ||
| {{yes}} | | {{yes}} | ||
| [[Property:Has stat values|Has stat values]] | |||
| The associated value with the stat | | The associated value with the stat | ||
|- | |||
| <nowiki><P></nowiki>_quality_stat<nowiki><M></nowiki>_id | |||
| str | |||
| {{yes}} | |||
| [[Property:Has quality stat ids|Has quality stat ids]] | |||
| The internal id of the quality stat | |||
|- | |||
| <nowiki><P></nowiki>_quality_stat<nowiki><M></nowiki>_value | |||
| int | |||
| {{yes}} | |||
| [[Property:Has quality stat values|Has quality stat values]] | |||
| The associated value with the quality stat | |||
|} | |} | ||
Revision as of 23:12, 22 June 2016
This subpage provides documentation for Template:Skill.
Overview
Template to store semantic skill and skill level progression data for use in other templates or pages such as Template:Item or Template:Skill progression.
Parameters
All parameters if available should be filled in.
General Parameters
Parameter | Type | Opt | Auto | Property | Description |
---|---|---|---|---|---|
skill_id | str | ✓
|
✓
|
Is skill id | The (internal) skill id of the skill |
is_support_gem | bool | ✓
|
✓
|
Property:Is support gem | Whether the skill is a support gem. |
support_gem_letter | str | ✓
|
✓
|
Has support gem letter | The support gem letter (i.e. the small letter icon shown when skills are supported by this skill) |
cast_time | float | ✓
|
✓
|
Has cast time | Cast time (or animation time) in seconds
Only active skills. |
gem_description | str | ✓
|
✓
|
Has description | The description of the active skill (i.e. what it says when you hover over it in the skill bar).
Only active skills. |
active_skill_name | str | ✓
|
✓
|
Has active skill name | Name of the active skill
Only active skills. |
item_class_restriction | list[str] | ✓
|
✓
|
Has item class restrictions | Comma separated list of item class restrictions. Has no item class restrictions will be set to true if there were no restrictions provided, otherwise the property is not set.
Only active skills. |
stat_text | str | ✓
|
✓
|
Has stat text | Stat text spanning the entire progression of the skill gem |
quality_stat_text | str | ✓
|
✓
|
Has quality stat text | Stat text for the quality bonus spanning the entire progression of the skill gem |
has_percentage_mana_cost | bool | ✓
|
✗
|
Has percentage mana cost | Whether the mana cost is a percentage (e.x. for Auras) |
has_reservation_mana_cost | bool | ✓
|
✗
|
Has reservation mana cost | Whether the mana cost is reserved instead of being used when the skill cast (e.x. for Auras) |
radius | int | ✓
|
✗
|
Has primary radius | Primary radius.
Also see the property page for details. |
radius_description | str | ✓
|
✗
|
Has primary radius description | Description to clarify what the primary radius does.
Also see the property page for details. |
radius_secondary | int | ✓
|
✗
|
Has secondary radius | Secondary radius.
Also see the property page for details. |
radius_secondary_description | str | ✓
|
✗
|
Has secondary radius description | Description to clarify what the secondary radius does.
Also see the property page for details. |
radius_tertiary | int | ✓
|
✗
|
Has tertiary radius | Tertiary radius.
Also see the property page for details. |
radius_description | str | ✓
|
✗
|
Has tertiary radius description | Description to clarify what the tertiary radius does.
Also see the property page for details. |
Progression Parameters
These parameters can be used to two ways:
static_
- for progression parameters that are the same at all levelslevel<N>_
- for progression parameters that are variable
Replace <N>
with the number of the argument. Start numbers with 1, and don't leave gaps. The order matters and each parameter must be specified for an individual element of N.
Code support: 1 <= N <= 30
Replace <P>
With the appropriate parameter from above.
Parameter | Type | Optional | Property | Description |
---|---|---|---|---|
<P>_level_requirement | int | ✓
|
Has level requirement | The level requirement |
<P>_dexterity_requirement | int | ✓
|
Has dexterity requirement | Dexterity requirement |
<P>_strength_requirement | int | ✓
|
Has strength requirement | Strength requirement |
<P>_intelligence_requirement | int | ✓
|
Has intelligence requirement | Intelligence requirement |
<P>_mana_multiplier | int | ✓
|
Has mana multiplier | Mana multiplier in percent |
<P>_critical_strike_chance | int | ✓
|
Has critical strike chance | Critical strike chance in percent |
<P>_mana_cost | int | ✓
|
Has mana cost | Mana cost. Depending on whether has_mana_cost_percentage or has_percentage_reservation_cost are true this value is also used as percentage and/or mana reservation cost. |
<P>_damage_effectiveness | int | ✓
|
Has damage effectiveness | Damage effectiveness in percent |
<P>_stored_uses | int | ✓
|
Has stored uses | Stored usages (i.e. for Traps or Mines). Some other skills may also store "uses" for the purposes of cooldown calculations.
For vaal skills use vaal_stored_uses |
<P>_cooldown | float | ✓
|
Has cooldown | Cooldown in seconds |
<P>_vaal_souls_requirement | int | ✓
|
Has vaal souls requirement | Vaal souls requirement in normal difficulty. Cruel and Merciless can be calculated based on this value. |
<P>_vaal_stored_uses | int | ✓
|
Has vaal stored uses | Stored vaal usages
For regular skill use stored_uses |
<P>_damage_mutliplier | str | ✓
|
Has damage multiplier | Damage multiplier of the skill in percent |
<P>_stat_text | str | ✓
|
Has stat text | Stat text spanning the entire level of the skill gem |
<P>_quality_stat_text | str | ✓
|
Has quality stat text | Stat text for the quality bonus spanning the entire level of the skill gem |
<P>_experience | int | ✓
|
Has experience requirement | Total amount of experience for this level.
Only for skill gems. |
Progression stats
Replace <M>
with the number of the argument. Start numbers with 1, and don't leave gaps. The order matters and each parameter must be specified for an individual element of M.
Code support: 1 <= M <= 8
Replace <P>
with the appropriate parameter from above.
Please note that the stats will be placed as into the properties as multi-value.
Parameter | Type | Optional | Property | Description |
---|---|---|---|---|
<P>_stat<M>_id | str | ✓
|
Has stat ids | The internal id of the stat |
<P>_stat<M>_value | int | ✓
|
Has stat values | The associated value with the stat |
<P>_quality_stat<M>_id | str | ✓
|
Has quality stat ids | The internal id of the quality stat |
<P>_quality_stat<M>_value | int | ✓
|
Has quality stat values | The associated value with the quality stat |
Example of valid stat parameters:
static_stat1_id= static_stat1_value= static_stat2_id= static_stat2_value= static_quality_stat1_id= static_quality_stat1_value= level1_stat1_id= level1_stat1_value= level1_quality_stat1_id= level1_quality_stat1_value= level2_stat1_id= level2_stat1_value= level2_stat2_id= level2_stat2_value=
See also