Item filter: Difference between revisions

From Path of Exile Wiki
Jump to navigation Jump to search
>OmegaK2
>OmegaK2
Line 12: Line 12:


==Creating a Filter==
==Creating a Filter==
The basic syntax of a script is a collection of Show and Hide blocks that each specify conditions. Anything matched by a Show block will be shown and anything matched by a Hide block will be hidden. If there are multiple conditions in a block then all of them must be matched for the block to match an item.
The blocks are matched in the order they come in the file which means that you need to have the block that hides the scrolls above before the line that shows the currency because scrolls would also match the currency block.
An empty block matches all items, which means that the Hide at the end of the file effectively hides everything that wasn't specifically shown.
===Blocks===
{| class="wikitable sortable"
! Name !! class="unsortable" | Notes
|-
| Show || If all conditions are matched, show the item and do any actions specified
|-
| Hide || If all conditions are matched, hide the item and do any actions specified
|}


===Operators===
===Operators===
Line 18: Line 34:


{|class="wikitable"
{|class="wikitable"
! Operator !! Notes
! Operator !! class="unsortable" | Notes
|-
|-
| < || Less then
| < || Less then
Line 32: Line 48:


{| class="wikitable sortable"
{| class="wikitable sortable"
! Name || Notes
! Name !! class="unsortable" | Notes
|-
|-
| ItemLevel || The level the item was generated at.
| ItemLevel || The level the item was generated at.
Line 50: Line 66:
| LinkedSockets ||The size of the largest group of linked sockets that the item has.
| LinkedSockets ||The size of the largest group of linked sockets that the item has.
|-
|-
| SocketGroup ||A group of linked sockets that contains the specified combination. For example, RRG will match any group that contains two red sockets linked with a green socket.
| SocketGroup || A group of linked sockets that contains the specified combination. For example, RRG will match any group that contains two red sockets linked with a green socket.
|}
 
===Actions===
 
{| class="wikitable sortable"
! Name !! class="unsortable" | Notes
|-
| SetBorderColor <0-255> <0-255> <0-255> || Sets the border colour of the item box in RGB values from 0-255
|-
| SetTextColor <0-255> <0-255> <0-255> || Sets the text colour of the item box in RGB values from 0-255
|-
| SetBackgroundColor <0-255> <0-255> <0-255> || Sets the colour of the item box in RGB values from 0-255
|-
| PlayAlertSound <1-9> || Plays the specified Alert Sound when dropped. Only one sound can be played at a time.
|}
|}



Revision as of 04:56, 2 May 2015

Item Filters can be used to customize how items on the ground are displayed.

Using an Existing Filter

  • Download the filter you wish to use
  • Place the filter in
   %USERPROFILE%/Documents/My Games/Path of Exile/
  • Make sure it has the correct file extension .filter
  • In game, go to Options -> UI -> Item Filter and select the filter

Creating a Filter

The basic syntax of a script is a collection of Show and Hide blocks that each specify conditions. Anything matched by a Show block will be shown and anything matched by a Hide block will be hidden. If there are multiple conditions in a block then all of them must be matched for the block to match an item.

The blocks are matched in the order they come in the file which means that you need to have the block that hides the scrolls above before the line that shows the currency because scrolls would also match the currency block.

An empty block matches all items, which means that the Hide at the end of the file effectively hides everything that wasn't specifically shown.

Blocks

Name Notes
Show If all conditions are matched, show the item and do any actions specified
Hide If all conditions are matched, hide the item and do any actions specified

Operators

The following Operators can be used with numeric contions. Note that for equal operations there is no operator required.

Operator Notes
< Less then
<= Less then or equals
> Greater then
>= Greater or equals

Conditions

Name Notes
ItemLevel The level the item was generated at.
DropLevel The level that the item starts dropping at.
Quality The amount of quality on the item.
Rarity Rarity of the item. Rarities are Normal, Magic, Rare or Unique.
Class The item class. Specifying part of a class name is allowed and will match any classes with that text in the name. So for example "One Hand" will match both "One Hand Sword" and "One Hand Axe"
BaseType The base type of the item. Specifying a part of a base type name is allowed and will match any of the base types with that text in the name.
Sockets Total number of sockets that the item has.
LinkedSockets The size of the largest group of linked sockets that the item has.
SocketGroup A group of linked sockets that contains the specified combination. For example, RRG will match any group that contains two red sockets linked with a green socket.

Actions

Name Notes
SetBorderColor <0-255> <0-255> <0-255> Sets the border colour of the item box in RGB values from 0-255
SetTextColor <0-255> <0-255> <0-255> Sets the text colour of the item box in RGB values from 0-255
SetBackgroundColor <0-255> <0-255> <0-255> Sets the colour of the item box in RGB values from 0-255
PlayAlertSound <1-9> Plays the specified Alert Sound when dropped. Only one sound can be played at a time.

Known Issues

Known issues with workaround. Use at your own risk.

Item filters not loading

Currently (beta) item filters may not load for users who use a non-ASCII userpath. As a work around you can move your documents folder to a location which does not contain non-ASCII letters. To do so:

 Go to your user folder (%USERPROFILE%) -> right click on My Documents -> properties -> path -> move... -> select a new location to move to -> apply

Version history

Version Changes
2.0.0
  • Introduced to the game.

See Also