Interface IGetBestItemsOptions

Includes all protected items by default

Hierarchy

Properties

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

Methods

filter sort

Properties

action

action: ActionType

actionWith

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

excludeProtectedItems

excludeProtectedItems: true | GetItemProtectedItemExclusion

True to exclude protected items

filterConsumable

filterConsumable: true

filterGroup

filterGroup: ItemTypeGroup

filterQuality

filterQuality: ArrayOr<Quality>

Optional filterText

filterText?: string

Only get items matching this text

filterType

filterType: ItemType

Optional ignoreItem

ignoreItem?: default

Item will be ignored

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.

includeSubContainers

includeSubContainers: true

Include sub containers in the search

targetCreature

targetCreature: default

Methods

filter

  • Parameters

    Returns any

sort

Settings

Member Visibility

Theme

Generated using TypeDoc