Item Filtering: Difference between revisions

For other out-of-game customization options, see '''[[Customization]]'''.

 

Item filters (often called lootfilters) are text files which contain rules for describing how items should be displayed in-game. The default filter only has a few simple rules for adding descriptions to some items (map orbs and stackable gems/runes), and otherwise displays all items the same as they would be in vanilla.

 

<!-- End of "Filters" category -->

 

Filters contain rules for how items should be displayed in-game. Each rule has '''''Input''''' and '''''Output''''' and follows this basic format:

 

<code>ItemDisplay[]: %NAME%</code> <span style="color:gray;">''displays all items with their default appearances''</span>

 

Conditions describe which item(s) the rule should apply to.

 

<code>ItemDisplay[MAG !ID HELM !(BAR OR DRU OR ELT)]:</code> <span style="color:gray;">''hides magic unidentified helms that are not barbarian helms, druid pelts, or elite''</span>

 

A rule's output (text and keywords in the second part of the rule) describe how the matching item(s) should be displayed.

 

<!-- End of "Filter Syntax" category -->

 

[[File:filter_strictness_default.png|thumb|Default Filter Strictness Levels]]

Filter levels can be selected from the in-game settings menu and will change which rules/notifications are enabled based on the FILTLVL/TIER codes used in the filter. By default, there are two levels: "Standard" and "Show All Items". The "Standard" level is the normal filter behavior that would be seen without any filter level changes, whereas "Show All Items" will just prevent any items from being filtered out (hidden).

<!-- End of "Filter Strictness" category -->

 

=== Output Keywords ===

==== Colors ====

<code>ItemDisplay[wss]: %RED%Worldstone Shard</code> <span class="d2-red">''Worldstone Shard''</span>

 

{| class="wikitable"

! Code !! Output !! Details

|}

 

[[File:MapNotificationColors.png|thumb|Minimap Icon Colors]]

These keywords add the item to the notification list and create a minimap icon for it.

All notification keywords seem to bypass the normal rule-handling procedure. Normally, the rules are processed top-to-bottom and this process halts when a matching rule (without '''%CONTINUE%''') is found. Notification keywords, however, can apply even after the process has halted. This may be [[Bugs|unintended behavior]].

 

{| class="wikitable"

! Code !! Details

<!-- End of "Output Keywords" category -->

 

==== Mutable Codes ====

Contrary to most "immutable" codes which refer to static item properties, these conditions depend on where and how the item is being viewed. Some value conditions such as [[Item_Filtering#Info_Codes|CLVL and DIFF]] are also "mutable" in this way.

<code>ItemDisplay[key ASSASSIN]:</code> <span style="color:gray;">''hides keys when playing as an Assassin''</span>

 

Both '''SHOP''' and '''EQUIPPED''' behave as expected in most scenarios, but they each have a [[Bugs|bug]] associated with them. Most notably, '''EQUIPPED''' incorrectly applies to items that begin the game within the multiplayer shared stash.

 

==== Item Group Codes ====

===== General Groups =====

</ul></div>

 

{| class="wikitable"

! Code !! Code !! Group !! Details

|}

 

{| class="wikitable"

! Code !! Code !! Group !! Details

The '''1H''' code is currently [[Bugs|bugged]] and doesn't include Hand Axe.

 

{| class="wikitable"

! Code !! Code !! Group

|}

 

===== Armor =====

{| class="wikitable"

|}

 

{| class="wikitable"

! Code !! Item (Normal)

===== Other Items ===== <!--T:104-->

 

{| class="wikitable"

! Code !! Item

|}

 

Also see [[Item_Filtering#Info_Codes|GEMLEVEL and GEMTYPE]]

{| class="wikitable"

|}

 

Also see [[Item_Filtering#Info_Codes|RUNE]]

 

|}

 

<div><ul style="margin-left:0px;">

<li style="display:inline-table; margin-left:0px; margin-right:8px;">

* Unique quest items (not essences/tokens or uber keys/organs) cannot be sold so they have no price

 

<div><ul style="margin-left:0px;">

<li style="display:inline-table; margin-left:0px; margin-right:8px;">

</ul></div>

 

<div><ul style="margin-left:0px;">

<li style="display:inline-table; margin-left:0px; margin-right:8px;">

<!-- End of "Boolean Conditions" category -->

 

==== Info Codes ====

{| class="wikitable"

There is currently a [[Bugs|bug]] with hiding stacked gems/runes - if the lootfilter attempts to hide them, they'll usually be loaded regardless and appear with an empty name.

 

{| class="wikitable"

! Code !! Description !! Item Appearance !! Details

<code>ItemDisplay[NMAG !ELT FRW>-20]:</code> <span style="color:gray;">''hides regular non-elite medium/heavy armors''</span>

 

The relevant number for each code is shown as N. In many cases, if N is absent, it is either 0 or 1. For codes that refer to attributes which are based on character level, N is often a multiple of Y (+Y per Character Level) such as 8Y for STAT214 or 2Y for STAT224.

 

Some numbered attribute codes (shown in <span style="color:gray;">gray</span>) refer to the same attributes as [[Item_Filtering#Named_Attribute_Codes|named attribute codes]] or other named codes, which can be used instead for better readability.

<div><ul style="margin-left:0px;">

<li style="display:inline-table; margin-left:0px; margin-right:8px;">

{| class="wikitable"

! Code !! Item Appearance

<li style="display:inline-table; margin-left:0px; margin-right:8px;">

 

{| class="wikitable"

! Code !! Item Appearance

<li style="display:inline-table; margin-left:0px; margin-right:0px;">

 

{| class="wikitable"

! Code !! Item Appearance

|}

 

===== Group Skills =====

Also see [[Item_Filtering#Elements|STAT362-STAT366]] (Cold, Fire, Lightning, Poison, Magic)

<ul></div>

 

In addition to these "SK" codes, there are equivalent "CHSK" codes for skill charges and "OS" codes for oskills. For example, '''CHSK54''' refers to skill charges for Teleport. "CHSK" codes for curse charges use separate 'proc' versions of those skills: '''CHSK445''' for Life Tap and '''CHSK447''' for Lower Resist.

 

* Skills with gray codes do not appear on items as pointmods/staffmods under normal circumstances.

 

<div><ul style="margin-left:0px;">

<li style="display:inline-table; margin-left:0px; margin-right:8px;">

{| class="wikitable"

|-

<li style="display:inline-table; margin-left:0px; margin-right:8px;">

 

{| class="wikitable"

|-

<li style="display:inline-table; margin-left:0px; margin-right:8px;">

 

{| class="wikitable"

|-

<ul></div>

 

Certain value conditions (MAPID, PREFIX, SUFFIX, STAT360) are slightly different than most others, referring to distinct zone/affix/corruption IDs instead of the value for attributes or other item stats with value ranges. Some other value conditions such as [[Item_Filtering#Info_Codes|GEMLEVEL, GEMTYPE, RUNE, or DIFF]] behave in a similar fashion, but their IDs aren't listed in this section due to having relatively few possible values.

 

MAPID refers to the [[Zones|zone]] (or [[Maps|map]]) the character is currently in. When using a portal, the zone ID [[Bugs|won't update immediately]] so any items within a screen length of the portal will be displayed as if the character was still in the previous zone. If the character walks a couple screen lengths away and returns, the ID will be updated and those items will be displayed as expected.

 

<ul></div>

 

SUFFIX refers to the suffixes items have whereas PREFIX refers to the prefixes they have. They're similar to the [[Item_Filtering#Numbered_Attribute_Codes|numbered attribute codes]], but refer to affixes rather than affix attributes.

 

|}

 

[[Item_Filtering#General|STAT360]] refers to which corruption items have.