Items.Filter

The Items.Filter class is used to store options to filter the global Item list. Often used in combination with Items.ApplyFilter.

Table of Contents

Properties

CheckIgnoreObject

Syntax: Items.Filter.CheckIgnoreObject
Returns: Boolean

Exclude from the search Items which are currently on the global Ignore List. ( default: False, any Item )

Enabled

Syntax: Items.Filter.Enabled
Returns: Boolean

Graphics

Syntax: Items.Filter.Graphics
Returns: Object

Hues

Syntax: Items.Filter.Hues
Returns: Object

IsContainer

Syntax: Items.Filter.IsContainer
Returns: Int32

Limit the search to the Items which are also containers. (default: -1: any Item)

IsCorpse

Syntax: Items.Filter.IsCorpse
Returns: Int32

Limit the search to the corpses on the ground. (default: -1, any Item)

IsDoor

Syntax: Items.Filter.IsDoor
Returns: Int32

Limit the search to the doors. (default: -1: any Item)

Layers

Syntax: Items.Filter.Layers
Returns: Object

Movable

Syntax: Items.Filter.Movable
Returns: Int32

Limit the search to only Movable Items. ( default: -1, any Item )

Multi

Syntax: Items.Filter.Multi
Returns: Int32

Limit the search to only Multi Items. ( default: -1, any Item )

Name

Syntax: Items.Filter.Name
Returns: String

OnGround

Syntax: Items.Filter.OnGround
Returns: Int32

Limit the search to the Items on the ground. (default: -1, any Item)

RangeMax

Syntax: Items.Filter.RangeMax
Returns: Double

Limit the search by distance, to Items which are at most RangeMax tiles away from the Player. ( default: -1, any Item )

RangeMin

Syntax: Items.Filter.RangeMin
Returns: Double

Limit the search by distance, to Items which are at least RangeMin tiles away from the Player. ( default: -1, any Item )

Serials

Syntax: Items.Filter.Serials
Returns: Object

ZRangeMax

Syntax: Items.Filter.ZRangeMax
Returns: Double

Limit the search by height, to Items which are at most ZRangeMax coordinates away from the Player. ( default: -1, any Item )

ZRangeMin

Syntax: Items.Filter.ZRangeMin
Returns: Double

Limit the search by height, to Items which are at least ZRangeMin coordinates away from the Player. ( default: -1, any Item )