Template:Passive skill/doc: Difference between revisions

From Path of Exile 2 Wiki
Jump to navigation Jump to search
(Undo revision 1153591 by Wires77 (talk))
No edit summary
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}


{{High-risk|5500+}}
{{Lua|Module:Passive skill}}
{{Lua|Module:Passive skill}}
__TOC__
__TOC__
Line 40: Line 41:
|-
|-
| '''int_id'''  
| '''int_id'''  
| integer (unique)
| int (unique)
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
Line 63: Line 64:


This is used for linking to articles; if left empty, the name will be used instead.
This is used for linking to articles; if left empty, the name will be used instead.
| {{n/a}}
|-
| '''is_in_game'''
| bool
| {{no}}
| {{no}}
| passive_skills.is_in_game
| Whether the passive skill is in game.
| true
|-
| '''frame'''
| str
| {{yes}}
| {{no}}
| passive_skills.frame
| Frame for override. ''Not implemented yet.''
| {{n/a}}
| {{n/a}}
|-  
|-  
Line 70: Line 87:
| {{no}}
| {{no}}
| passive_skills.flavour_text
| passive_skills.flavour_text
| Flavour text of the passive skill
| Flavour text of the passive skill.
| {{n/a}}
| {{n/a}}
|-  
|-  
Line 78: Line 95:
| {{no}}
| {{no}}
| passive_skills.reminder_text
| passive_skills.reminder_text
| Reminder text for the stat description (hints in grey text explaining what the stats mean)
| Reminder text for the stat description. (hints in grey text explaining what the stats mean)
| {{n/a}}
| {{n/a}}
|-
| '''buff_id'''
| str
| {{yes}}
| {{no}}
| passive_skills.buff_id
| Id of the buff granted by the passive skill if any
| {{n/a}}
|-
| '''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'''
| '''icon'''
Line 105: Line 106:
| {{n/a}}
| {{n/a}}
|-
|-
| '''ascendancy_class'''
| '''is_icon_only'''
| string
| bool
| {{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'''
| bool
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| passive_skills.ascendancy_class
| passive_skills.is_jewel socket
| Name of the ascendancy class which can allocate this passive. Should be empty for regular passives.
| Whether this passive skill is a [[Jewel]] socket.
| {{n/a}}
| false
|-
|-
| '''is_keystone'''
| '''is_keystone'''
| boolean
| bool
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| passive_skills.is_keystone
| passive_skills.is_keystone
| Whether this passive skill is a keystone
| Whether this passive skill is a keystone.
| false
| false
|-
|-
| '''is_notable'''
| '''is_notable'''
| boolean
| bool
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| passive_skills.is_notable
| passive_skills.is_notable
| Whether this passive skill is a notable
| Whether this passive skill is a notable.
| false
|-
| '''is_attribute'''
| bool
| {{yes}}
| {{no}}
| passive_skills.is_attribute
| Whether this passive skill is an attribute node.
| false
|-
| '''is_free'''
| bool
| {{yes}}
| {{no}}
| passive_skills.is_free
| Whether this passive skill is free to allocate.
| false
| false
|-
|-
| '''is_multiple_choice_option'''
| '''is_multiple_choice_option'''
| boolean
| bool
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| passive_skills.is_multiple_choice_option
| 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)
| 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
| false
|-
|-
| '''is_multiple_choice'''
| '''is_multiple_choice'''
| boolean
| bool
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| passive_skills.is_multiple_choice
| 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)
| Whether this passive skill is a multiple choice. (e.x. the passive node in the ascendant tree where you select from multiple classes is a multiple choice passive)
| false
| false
|-
|-
| '''is_icon_only'''
| '''is_starting_node'''
| boolean
| bool
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| passive_skills.is_icon_only
| passive_skills.is_starting_node
| Whether this passive skill is a just an icon (e.x. used for the icons in the middle of circles)
| Whether this node is a starting location for a tree.
| false
| false
|-
|-
| '''is_jewel_socket'''
| '''ascendancy_class'''
| boolean
| str
| {{yes}}
| {{no}}
| passive_skills.ascendancy_class
| Name of the ascendancy class which can allocate this passive. Should be empty for regular passives.
| {{n/a}}
|-
| '''is_atlas_passive'''
| bool
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| passive_skills.is_jewel socket
| passive_skills.is_atlas_passive
| Whether this passive skill is a [[Jewel]] socket
| Whether this node is a atlas passive.
| false
| false
|-
|-
| '''is_ascendancy_starting_node'''
| '''atlas_sub_tree'''
| boolean
| str
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| passive_skills.is_ascendancy_starting_node
| passive_skills.atlas_sub_tree
| Whether this node is a starting location for an [[ascendancy class]] tree
| Sub tree in the atlas.
| false
| {{n/a}}
|-
| '''buff_id'''
| str
| {{yes}}
| {{no}}
| passive_skills.buff_id
| Id of the buff granted by the passive skill if any.
| {{n/a}}
|-
| '''skill_points'''
| int
| {{yes}}
| {{no}}
| passive_skills.skill_points
| How many skill points the passive grants upon allocation.
| 0
|-
| '''weapon_set_points'''
| int
| {{yes}}
| {{no}}
| passive_skills.weapon_set_points
| How many weapon set points the passive grants upon allocation.
| 0
|-
|-
| '''stat_text'''
| '''stat_text'''
| string
| str
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| passive_skills.stat_text
| passive_skills.stat_text
| Complete stat description from the stats of this passive skill
| Complete stat description from the stats of this passive skill.
| {{n/a}}
|-
| '''stat_text_raw'''
| str
| {{yes}}
| {{no}}
| passive_skills.stat_text_raw
| Same as stat_text but with trimmed wikilinks.
| {{n/a}}
|-
| '''stat_text_raw'''
| str
| {{yes}}
| {{no}}
| passive_skills.stat_text_raw
| Same as stat_text but with trimmed wikilinks.
| {{n/a}}
|-
| '''connections'''
| list of str
| {{yes}}
| {{no}}
| passive_skills.connections
| Which other passives are connected to this passive.
| {{n/a}}
| {{n/a}}
|}
|}
Line 202: Line 283:
|}
|}


==Cargo tables==
==Cargo==
Cargo table declarations:
{| class="wikitable"
{|class="wikitable"
! Table !! Declared by !! Attached by !! Data
! Name
|-
! Declaration
| [[Special:CargoTables/passive_skills|passive_skills]]
|-  
| {{tl|Passive skill/cargo/passive skills/declare}}
| passive_skills
| {{tl|Passive skill/cargo/passive skills/attach}}
| {{tlx|Passive skill/cargo/passive_skills}}
| rowspan="2" | Pages in [[:Category:Passive skill data]]
|-  
|-
| passive_skill_stats
| [[Special:CargoTables/passive_skill_stats|passive_skill_stats]]
| {{tlx|Passive skill/cargo/passive_skill_stats}}
| {{tl|Passive skill/cargo/passive skill stats/declare}}
| {{tl|Passive skill/cargo/passive skill stats/attach}}
|}
|}


Line 219: Line 301:
[[Category:Data templates]]
[[Category:Data templates]]
[[Category:Passive templates]]
[[Category:Passive templates]]
{{Sister|poewiki}}
}}
}}

Latest revision as of 17:52, 21 December 2025

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 int (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.

—
is_in_game bool No No passive_skills.is_in_game Whether the passive skill is in game. true
frame str Yes No passive_skills.frame Frame for override. Not implemented yet. —
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) —
icon wikipage Yes No passive_skills.icon —
is_icon_only bool 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 bool Yes No passive_skills.is_jewel socket Whether this passive skill is a Jewel socket. false
is_keystone bool Yes No passive_skills.is_keystone Whether this passive skill is a keystone. false
is_notable bool Yes No passive_skills.is_notable Whether this passive skill is a notable. false
is_attribute bool Yes No passive_skills.is_attribute Whether this passive skill is an attribute node. false
is_free bool Yes No passive_skills.is_free Whether this passive skill is free to allocate. false
is_multiple_choice_option bool 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_multiple_choice bool Yes No passive_skills.is_multiple_choice Whether this passive skill is a multiple choice. (e.x. the passive node in the ascendant tree where you select from multiple classes is a multiple choice passive) false
is_starting_node bool Yes No passive_skills.is_starting_node Whether this node is a starting location for a tree. false
ascendancy_class str Yes No passive_skills.ascendancy_class Name of the ascendancy class which can allocate this passive. Should be empty for regular passives. —
is_atlas_passive bool Yes No passive_skills.is_atlas_passive Whether this node is a atlas passive. false
atlas_sub_tree str Yes No passive_skills.atlas_sub_tree Sub tree in the atlas. —
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. 0
weapon_set_points int Yes No passive_skills.weapon_set_points How many weapon set points the passive grants upon allocation. 0
stat_text str Yes No passive_skills.stat_text Complete stat description from the stats of this passive skill. —
stat_text_raw str Yes No passive_skills.stat_text_raw Same as stat_text but with trimmed wikilinks. —
stat_text_raw str Yes No passive_skills.stat_text_raw Same as stat_text but with trimmed wikilinks. —
connections list of str Yes No passive_skills.connections Which other passives are connected to this passive. —

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}}


Retrieved from "https://www.poe2wiki.net/index.php?title=Template:Passive_skill/doc&oldid=110148"