Template:Passive skill/doc

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

This subpage provides documentation for Template:Passive skill.

This template is used on 5500+ pages.

To avoid major disruption and server load, do not make unnecessary edits to this template. Test changes to this template first using its /sandbox and /testcases subpages or your user space. All of the changes can then be applied to this template in a single edit.

Consider discussing changes on the talk page or on Discord before implementing them.

Lua logo

This template uses the following modules:

The Passive skill template is used to submit passive data to the cargo data base. It should only be used from the Passive Skill: name space.

Overview

The template will do the following:

  • add cargo data to the page
  • create a basic infobox showing the data stored

PyPoE export

PyPoE can be used to export this data from the game to the wiki. pypoe_exporter wiki passive is responsible for handling the export.

Example for exporting by id: pypoe_exporter wiki passive id --wiki --wiki-user <username> --wiki-password <bot_password> <id_of_the_mod1> [id_of_the_mod2] [...] [id_of_the_mod3]

Parameters

General

Parameter Type PyPoE
Export
Required Field Description Default
id str (unique) Yes Yes passive_skills.id Internal Id of the passive skill.
int_id integer (unique) Yes Yes passive_skills.int_id Internal Id of the passive skill.
name str Yes No passive_skills.name Name of the passive as shown in game.
main_page str No No passive_skills.main_page Name of the main article for this passive skill in the wiki.

This is used for linking to articles; if left empty, the name will be used instead.

flavour_text str Yes No passive_skills.flavour_text Flavour text of the passive skill
reminder_text str Yes No passive_skills.reminder_text Reminder text for the stat description (hints in grey text explaining what the stats mean)
buff_id str Yes No passive_skills.buff_id Id of the buff granted by the passive skill if any
skill_points int Yes No passive_skills.skill_points How many skill points the passive grants upon allocation (used for certain scion ascendancy passives for example) 0
icon wikipage Yes No passive_skills.icon
is_keystone boolean Yes No passive_skills.is_keystone Whether this passive skill is a keystone false
is_notable boolean Yes No passive_skills.is_notable Whether this passive skill is a notable false
is_attribute boolean Yes No Whether this passive skill is an attribute node false
is_multiple_choice boolean Yes No passive_skills.is_multiple_choice Whether this passive skill is a multiple choice option (e.x. the passive node in the ascendant tree where you select from multiple classes is a multiple choice passive) false
is_multiple_choice_option boolean Yes No passive_skills.is_multiple_choice_option Whether this passive skill is a multiple choice option (e.x. the 3 individual ascendancy class nodes for each character class in the ascendant tree are multiple choice options) false
is_icon_only boolean Yes No passive_skills.is_icon_only Whether this passive skill is a just an icon (e.x. used for the icons in the middle of circles) false
is_jewel_socket boolean Yes No passive_skills.is_jewel socket Whether this passive skill is a Jewel socket false
is_free boolean Yes No Whether this passive skill is free to allocate false
ascendancy_class string Yes No passive_skills.ascendancy_class Name of the ascendancy class which can allocate this passive. Should be empty for regular passives.
is_ascendancy_starting_node boolean Yes No passive_skills.is_ascendancy_starting_node Whether this node is a starting location for an ascendancy class tree false
is_atlas_passive boolean Yes No Whether this node is a atlas passive false
atlas_sub_tree str Yes No Sub tree in the atlas
is_atlas_sub_tree_starting_node boolean Yes No Whether this node is a starting location for an atlas sub tree false
grantes_skill str Yes No Id of granted skill
stat_text string Yes No passive_skills.stat_text Complete stat description from the stats of this passive skill

Multiple arguments

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.

Stats

All values here are exported by PyPoE. For each set of stats, all parameters are required.

Parameter Type Field Description
stat<N>_id str passive_skill_stats.id Internal id of the stat
stat<N>_value int passive_skill_stats.value Value of the stat

Cargo

Table Declared by Attached by Data
passive_skills {{Passive skill/cargo/passive skills/declare}} {{Passive skill/cargo/passive skills/attach}} Pages in Category:Passive skill data
passive_skill_stats {{Passive skill/cargo/passive skill stats/declare}} {{Passive skill/cargo/passive skill stats/attach}}