Template:Skill/doc: Difference between revisions

From Path of Exile Wiki
Jump to navigation Jump to search
>OmegaK2
>OmegaK2
Line 18: Line 18:
! {{abbr|Opt|Optional}}  
! {{abbr|Opt|Optional}}  
! {{abbr|Auto|PyPoE exported?}}
! {{abbr|Auto|PyPoE exported?}}
! Property
! Table & field
! Description
! Description
|-
|-
Line 25: Line 25:
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| [[Property:Is skill id|Is skill id]]
| skill.skill_id
| The (internal) skill id of the skill
| The (internal) skill id of the skill
|-
| is_support_gem
| bool
| {{yes}}
| {{yes}}
| [[Property:Is support gem|Is support gem]]
| Whether the skill is a support gem.
|-
| support_gem_letter
| str
| {{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)
|-
|-
| cast_time
| cast_time
Line 46: Line 32:
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| [[Property:Has cast time|Has cast time]]
| skill.cast_time
| Cast time (or animation time) in seconds
| Cast time (or animation time) in seconds
Only active skills.
Only active skills.
Line 54: Line 40:
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| [[Property:Has description|Has description]]
| skill.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 62: Line 48:
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| [[Property:Has active skill name|Has active skill name]]
| skill.active_skill_name
| Name of the active skill
| Name of the active skill
Only active skills.
Only active skills.
Line 70: Line 56:
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| [[Property:Has item class restrictions|Has item class restrictions]]
| skill.item_class_restriction
[[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.
| 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 79: Line 64:
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| [[Property:Has projectile speed|Has projectile speed]]
| skill.projectile_speed
| Speed of the projectile(s) fired by the skill
| Speed of the projectile(s) fired by the skill
|-
|-
Line 86: Line 71:
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| [[Property:Has stat text|Has stat text]]
| skill.stat_text
| Stat text spanning the entire progression of the skill gem
| Stat text spanning the entire progression of the skill gem
|-
|-
Line 93: Line 78:
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| [[Property:Has quality stat text|Has quality stat text]]
| skill.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 100: Line 85:
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| [[Property:Has percentage mana cost|Has percentage mana cost]]
| skill.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 107: Line 92:
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| [[Property:Has reservation mana cost|Has reservation mana cost]]
| skill.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)
|-
|-
Line 114: Line 99:
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| [[Property:Has primary radius|Has primary radius]]
| skill.radius
| Primary radius.  
| Primary radius.  
Also see the property page for details.
Also see the property page for details.
Line 122: Line 107:
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| [[Property:Has primary radius description|Has primary radius description]]
| skill.radius_description
| Description to clarify what the primary radius does.  
| Description to clarify what the primary radius does.  
Also see the property page for details.
Also see the property page for details.
Line 130: Line 115:
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| [[Property:Has secondary radius|Has secondary radius]]
| skill.radius_secondary
| Secondary radius.  
| Secondary radius.  
Also see the property page for details.
Also see the property page for details.
Line 138: Line 123:
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| [[Property:Has secondary radius description|Has secondary radius description]]
| skill.radius_secondary_description
| Description to clarify what the secondary radius does.  
| Description to clarify what the secondary radius does.  
Also see the property page for details.
Also see the property page for details.
Line 146: Line 131:
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| [[Property:Has tertiary radius|Has tertiary radius]]
| skill.radius_tertiary
| Tertiary radius.  
| Tertiary radius.  
Also see the property page for details.
Also see the property page for details.
Line 154: Line 139:
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| [[Property:Has tertiary radius description|Has tertiary radius description]]
| skill.radius_tertiary_description
| Description to clarify what the tertiary radius does.  
| Description to clarify what the tertiary radius does.  
Also see the property page for details.
Also see the property page for details.

Revision as of 20:05, 10 February 2018

This subpage provides documentation for Template:Skill.

Lua logo

This template uses the following modules:

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 Table & field Description
skill_id str
skill.skill_id The (internal) skill id of the skill
cast_time float
skill.cast_time Cast time (or animation time) in seconds

Only active skills.

gem_description str
skill.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
skill.active_skill_name Name of the active skill

Only active skills.

item_class_restriction list[str]
skill.item_class_restriction 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.

projectile_speed int
skill.projectile_speed Speed of the projectile(s) fired by the skill
stat_text str
skill.stat_text Stat text spanning the entire progression of the skill gem
quality_stat_text str
skill.quality_stat_text Stat text for the quality bonus spanning the entire progression of the skill gem
has_percentage_mana_cost bool
skill.has_percentage_mana_cost Whether the mana cost is a percentage (e.x. for Auras)
has_reservation_mana_cost bool
skill.has_reservation_mana_cost Whether the mana cost is reserved instead of being used when the skill cast (e.x. for Auras)
radius int
skill.radius Primary radius.

Also see the property page for details.

radius_description str
skill.radius_description Description to clarify what the primary radius does.

Also see the property page for details.

radius_secondary int
skill.radius_secondary Secondary radius.

Also see the property page for details.

radius_secondary_description str
skill.radius_secondary_description Description to clarify what the secondary radius does.

Also see the property page for details.

radius_tertiary int
skill.radius_tertiary Tertiary radius.

Also see the property page for details.

radius_description str
skill.radius_tertiary_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 levels
  • level<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