Template:Item modifier compatibility/doc: Difference between revisions

From Path of Exile Wiki
Jump to navigation Jump to search
>Illviljan
mNo edit summary
No edit summary
 
(17 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{documentation subpage}}
{{Documentation subpage}}
{{lua|Module:Mod}}


This template adds a drop down table of dynamically generated data based on a [[item]].
{{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]].


==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
|-
| metadata_id
| str
| Metadata ID of the item to search for
|-
|-
| '''item''' || The [[item]] to filter the modifiers for. || {{yes}}
| 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 <code>page</code>.
|-
|-
| '''header''' || Header name, defaults to the item tags if not specified. || {{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
|-
|-
| '''item_tags''' || Overrides the tags the item has. (Not recommended) || {{no}}
| item_tags
| list[str]
| Comma-separated list of tags. This overrides the item's tags.
|-
|-
| '''extra_properties''' || Displays extra properties. || {{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 = Nailed Fist
|item_name = Bone Helmet
|header = Claws
}}
}}
</pre>
</pre>


==Known issues==
{{Documentation categories|
Due to the considerable number of modifiers that are queried and filtered the template can sometimes return an error. [[Null edit]]ing the page normally fixes it.
<!-- Categories and interwikis go here. -->
 
[[Category:Query templates]]
<includeonly>
[[de:Vorlage:Item modifiers]]
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
}}
[[Category:SMW query templates]]
</includeonly>

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"