Template:Skill/sandbox

From Path of Exile 2 Wiki
Jump to navigation Jump to search

This is the template sandbox page for Template:Skill (diff).

Template documentation[view] [edit] [history] [purge]


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

Only active skills.

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

Only active skills.

item_class_id_restriction list[str] Yes Yes skill.item_class_id_restriction

skill.item_class_restriction

Comma separated list of item class restrictions. Please note that the class ID and not the localized version must be used; the localized version is available as skill.item_class_restriction field once set.

Only active skills.

projectile_speed int Yes ✓* skill.projectile_speed Speed of the projectile(s) fired by the skill
stat_text str Yes Yes skill.stat_text Stat text spanning the entire progression of the skill gem
radius int Yes No skill.radius Primary radius.
radius_description str Yes No skill.radius_description Description to clarify what the primary radius does.
radius_secondary int Yes No skill.radius_secondary Secondary radius.
radius_secondary_description str Yes No skill.radius_secondary_description Description to clarify what the secondary radius does.
radius_tertiary int Yes No skill.radius_tertiary Tertiary radius.
radius_description str Yes No skill.radius_tertiary_description Description to clarify what the tertiary radius does.
skill_screenshot str Yes No skill.skill_screenshot Name of the skill to use for the skill screenshot instead of the value of active_skill_name.

Specifying this parameter will also force the skill screenshot to appear, even if the file does not exist.

Should not be specified unless the active skill name is ambiguous

skill_screenshot_file str Yes No skill.skill_screenshot Full name of the file (excluding File:) of the screenshot for this skill.

Specifying this parameter will also force the skill screenshot to appear, even if the file does not exist.

Should not be specified unless the active skill name is ambiguous

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 level the arguments are. Start numbers with 1, and don't leave gaps. In addition, for each enabled level level<N> = True has to be set.

Replace <P> With the appropriate parameter from above.

Parameter Type Optional PyPoE Field Description
<P>_level_requirement int Yes Yes skill_levels.level_requirement The level requirement
<P>_dexterity_requirement int Yes Yes skill_levels.dexterity_requirement Dexterity requirement
<P>_strength_requirement int Yes Yes skill_levels.strength_requirement Strength requirement
<P>_intelligence_requirement int Yes Yes skill_levels.intelligence_requirement Intelligence requirement
<P>_mana_multiplier int Yes Yes skill_levels.mana_multiplier Mana multiplier in percent
<P>_attack_time float Yes Yes skill_levels.attack_time Attack time in seconds. Used for attack skills that don't use a weapon or unarmed.
<P>_critical_strike_chance int Yes Yes skill_levels.critical_strike_chance Critical strike chance in percent
<P>_damage_effectiveness int Yes Yes skill_levels.damage_effectiveness Damage effectiveness in percent
<P>_stored_uses int Yes Yes skill_levels.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 Yes Yes skill_levels.cooldown Cooldown in seconds
<P>_vaal_souls_requirement int Yes Yes skill_levels.vaal_souls_requirement Base Vaal souls requirement (without increases from Act 5 or Act 10)
<P>_vaal_stored_uses int Yes Yes skill_levels.vaal_stored_uses Stored vaal usages

For regular skill use stored_uses

<P>_vaal_soul_gain_prevention_time float Yes Yes skill_levels.vaal_soul_gain_prevention_time Time in seconds in which you can't gain vaal souls after using the skill
<P>_damage_mutliplier str Yes Yes skill_levels.damage_multiplier Damage multiplier of the skill in percent
<P>_attack_speed_multiplier str Yes Yes skill_levels.attack_speed_multiplier Multiplier to the attack speed.

Default: 100

<P>_stat_text str Yes Yes skill_levels.stat_text Stat text spanning the entire level of the skill gem
<P>_quality_stat_text str Yes Yes skill_levels.quality_stat_text Stat text for the quality bonus spanning the entire level of the skill gem
<P>_experience int Yes Yes skill_levels.experience Total amount of experience for this level.

Only for skill gems.

Costs and reservations

Skill costs and reservations are defined using the parameters described in this section. All are optional.

Costs and reservations are defined similarly to progression parameters. Replace <P> with one of the following:

  • static_ – for costs and reservations that are the same at all levels
  • level<N>_ – for costs and reservations that vary by skill level. Replace <N> with the skill level number, starting with 1.
Parameter Type PyPoE Field Description
static_cost_types List of strings Yes skill_levels.cost_types A comma-separated list of strings containing the cost types used by the skill.

Any combination of the following cost types can be used:

  • Mana
  • Life
  • ES
  • Rage
  • ManaPercent
  • LifePercent
<P>_cost_amounts List of integers Yes skill_levels.cost_amounts A comma-separated list of integers containing the cost amounts corresponding to the cost types defined by static_cost_types. The order of the cost amounts must match the order of the cost types. Each list should also have the same number of elements.
<P>_mana_reservation_flat integer Yes skill_levels.mana_reservation_flat The flat amount of mana reserved by the skill.
<P>_mana_reservation_percent integer Yes skill_levels.mana_reservation_percent The percentage amount of mana reserved by the skill.
<P>_life_reservation_flat integer Yes skill_levels.life_reservation_flat The flat amount of life reserved by the skill.
<P>_life_reservation_percent integer Yes skill_levels.life_reservation_percent The percentage amount of life reserved by the skill.

The following parameters would be used for a skill that both costs and reserves a flat amount of mana, varying by level. Only the first two levels are shown.

|static_cost_types = Mana
|level1_cost_amounts = 6
|level1_mana_reservation_flat = 6
|level2_cost_amounts = 7
|level2_mana_reservation_flat = 7

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 Yes skill_stats_per_level.id

skill_stats_per_level.is_quality_stat=0

The internal id of the stat
<P>_stat<M>_value int Yes skill_stats_per_level.value

skill_stats_per_level.is_quality_stat=0

The associated value with the stat
<P>_quality_stat<M>_id str Yes skill_stats_per_level.id

skill_stats_per_level.is_quality_stat=1

The internal id of the quality stat
<P>_quality_stat<M>_value int Yes skill_stats_per_level.value

skill_stats_per_level.is_quality_stat=1

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=

Categories

Pages that transclude {{skill}} are added to Category:Skill data automatically.

Pages that use any parameters marked as deprecated are added to Category:Pages using deprecated parameters for skill data.

Cargo table declarations

See also