Interface IItemFinderOptions

Hierarchy

Properties

action? actionWith? excludeProtectedItems? fallback? filterConsumable? filterGroup? filterQuality? filterText? filterType? ignoreItem? includeProtectedItemsThatWillNotBreak? includeSubContainers? targetCreature?

Methods

filter? postFilter? replace? sort?

Properties

Optional action

action?: ActionType

Optional actionWith

actionWith?: default | (() => undefined | default)

Optional excludeProtectedItems

excludeProtectedItems?: true | GetItemProtectedItemExclusion

True to exclude protected items

Optional fallback

fallback?: default

Optional filterConsumable

filterConsumable?: true

Optional filterGroup

filterGroup?: ItemTypeGroup

Optional filterQuality

filterQuality?: ArrayOr<Quality>

Optional filterText

filterText?: string

Only get items matching this text

Optional filterType

filterType?: ItemType

Optional ignoreItem

ignoreItem?: default

Item will be ignored

Optional includeProtectedItemsThatWillNotBreak

includeProtectedItemsThatWillNotBreak?: true | ActionType

True to only include protected items if they pass an item.willBreakOnDamage() check. excludeProtectedItems must be set to true for this to work.

Optional includeSubContainers

includeSubContainers?: true

Include sub containers in the search

Optional targetCreature

targetCreature?: default

Methods

Optional filter

  • Parameters

    Returns any

Optional postFilter

  • Parameters

    Returns boolean

Optional replace

  • A replacement for the actual "best" results. Not cached. When undefined, uses the actual results.

    Returns undefined | default[]

Optional sort

Settings

Member Visibility

Theme

Generated using TypeDoc