Template:Item modifier compatibility/doc: Difference between revisions

From Path of Exile Wiki
Jump to navigation Jump to search
m (Vinifera7 moved page Template:Item modifiers/doc to Template:Item modifier compatibility/doc without leaving a redirect)
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}


{{Lua|Module:Modifier table}}
{{Lua|Module:Modifier compatibility}}


This template adds a drop down table from data tables. The data is queried from cargo tables that lists the spawnable named mods with conditions based on [[item]] [[modifier|tags]], its [[modifier|mod domain]] and [[modifier|generation type]].
This template adds a drop down table from data tables. The data is queried from cargo tables that lists the spawnable named mods with conditions based on [[item]] [[modifier|tags]], its [[modifier|mod domain]] and [[modifier|generation type]].


==Parameters==
==Parameters==
===Item selection===
One of these is required. Do not specify more than one.
{| class="wikitable"
{| class="wikitable"
! Parameter !! Description !! Required
! Parameter
! Value
! Description
|-
|-
| '''item''' || The [[item]] to filter the modifiers for. || {{yes}}
| metadata_id
| str
| Metadata ID of the item to search for
|-
|-
| '''header''' || Header name, defaults to the item tags if not specified. || {{no}}
| page
| str
| Name of the wiki page on which the item data resides
|-
|-
| '''item_tags''' || Overrides the tags the item has. Delimiter: ", "  (Not recommended) || {{no}}
| item_name
| str
| Name of the item to search for. The search query will also extend to aliases of the item (e.g., legacy names).
 
The search may fail if there are multiple items with the given name. In that case, use a different item selection parameter, such as <code>page</code>.
|-
|-
| '''extra_item_tags''' || Adds additional item tags. Delimiter: ", " || {{no}}
| item_name_exact
| str
| Exact name of the item to search for.
 
The search may fail if there are multiple items with the given name. In that case, use a different item selection parameter, such as <code>page</code>.
|}
 
===Optional parameters===
{| class="wikitable"
! Parameter
! Value
! Description
|-
|-
| '''extra_fields''' || Displays extra fields. || {{no}}
| item_tags
| list[str]
| Comma-separated list of tags. This overrides the item's tags.
|-
|-
| '''spawn_chance''' || Displays the spawn chance based on the specific modifier spawn weight and the total number of mods in that [[generation type]]. || {{no}}
| extra_item_tags
| list[str]
| Comma-separated list of tags to append to the item's tags.
|}
|}


==Example==
==Example==
<pre>
<pre>
{{Item modifiers
{{Item modifier compatibility
|item = Bone Helmet
|item_name = Bone Helmet
|header = Helmet
}}
}}
</pre>
</pre>
{{Item modifiers
|item = Bone Helmet
|header = Helmet
}}


{{Documentation categories|
{{Documentation categories|

Latest revision as of 14:08, 11 October 2023

This subpage provides documentation for Template:Item modifier compatibility.

Lua logo

This template uses the following modules:

This template adds a drop down table from data tables. The data is queried from cargo tables that lists the spawnable named mods with conditions based on item tags, its mod domain and generation type.

Parameters

Item selection

One of these is required. Do not specify more than one.

Parameter Value Description
metadata_id str Metadata ID of the item to search for
page str Name of the wiki page on which the item data resides
item_name str Name of the item to search for. The search query will also extend to aliases of the item (e.g., legacy names).

The search may fail if there are multiple items with the given name. In that case, use a different item selection parameter, such as page.

item_name_exact str Exact name of the item to search for.

The search may fail if there are multiple items with the given name. In that case, use a different item selection parameter, such as page.

Optional parameters

Parameter Value Description
item_tags list[str] Comma-separated list of tags. This overrides the item's tags.
extra_item_tags list[str] Comma-separated list of tags to append to the item's tags.

Example

{{Item modifier compatibility
|item_name = Bone Helmet
}}


Retrieved from "https://www.poewiki.net/index.php?title=Template:Item_modifier_compatibility/doc&oldid=1389322"