Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Item

an Item in Path of Exile

Hierarchy

  • Item

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

  • new Item(builder: Builder): Item

  • Use Item#build

    Parameters

    • builder: Builder

    Returns Item

Properties

affixes

affixes: ItemAffixes

baseitem

baseitem: BaseItemTypeProps

id

id: string

implicits

implicits: Implicits

meta_data

meta_data: MetaData

name

name: Name & Component<Item, NameBuilder>

properties

properties: Properties & Component<Item, any>

props

props: ItemProps

rarity

rarity: Rarity<Item> & Component<Item, RarityBuilder>

requirements

requirements: Requirements & Component<Item, RequirementsBuilder>

sockets

sockets: Sockets<Item> & Component<Item, SocketsBuilder>

spawnweight

spawnweight: number

Accessors

mods

  • get mods(): Mod[]

  • Returns Mod[]

Methods

addMod

  • addMod(other: Mod): this

  • decides where to add the mod (explicit, implicit) throws if it could not decide where to put it

    Parameters

    Returns this

any

  • any(): boolean

  • Returns boolean

asArray

  • asArray(): Mod[]

  • Returns Mod[]

asElderItem

  • asElderItem(): this

  • returns an item that can have elder mods

    this does not remove existing shaper mods

    Returns this

asShaperItem

  • asShaperItem(): this

  • returns an item that can have shaper mods

    this does not remove existing elder mods

    Returns this

builder

  • builder(): Builder

  • Returns Builder

computeValue

  • augments a given {value} with the local stats

    Parameters

    • value: number
    • classification: string[]

    Returns AugmentableValue

corrupt

  • corrupt(): this

  • sets the corrupted property on the item or throws if it is already corrupted

    Returns this

getTags

  • getTags(): Tag[]

  • returns tags of item + tags from mods

    Returns Tag[]

hasMod

  • hasMod(other: Mod): boolean

  • Parameters

    Returns boolean

hasModGroup

  • hasModGroup(other: Mod): boolean

  • Parameters

    Returns boolean

hasRoomFor

  • hasRoomFor(other: Mod): boolean

  • Parameters

    Returns boolean

inDomainOf

  • inDomainOf(mod_domain: number): boolean

  • Parameters

    • mod_domain: number

    Returns boolean

indexOfModWithId

  • indexOfModWithId(id: string): number

  • Parameters

    • id: string

    Returns number

isElderItem

  • isElderItem(): boolean

  • Returns boolean

isSHaperItem

  • isSHaperItem(): boolean

  • Returns boolean

level

  • level(): number

  • Returns number

maxModsOfType

  • maxModsOfType(other: Mod): number

  • Parameters

    Returns number

mirror

  • mirror(): this

  • sets the mirror property on the item or throws if it is already mirrored

    Returns this

removeAllImplicits

  • removeAllImplicits(): this

  • Returns this

removeAllMods

  • removeAllMods(): this

  • removes explicits

    Returns this

removeAtlasModifier

  • removeAtlasModifier(): this

  • Returns this

removeMod

  • removeMod(other: Mod): this

  • removed this mod either from implicit or explicit

    if that mod fiths into neither category it throws

    Parameters

    Returns this

setProperty

  • setProperty(prop: keyof ItemProps, value: any): this

  • Parameters

    Returns this

stats

  • stats(): {}

  • merge of implicit and explicit stats

    Returns {}

    • [key: string]: Stat

withMutations

  • withMutations(mutate: (builder: Builder) => Builder): this

  • Parameters

    • mutate: (builder: Builder) => Builder
        • (builder: Builder): Builder

        • Parameters

          • builder: Builder

          Returns Builder

    Returns this

Static build

  • creates a new item from the baseitem

    Parameters

    Returns Item

Static buildMetaData

Static fromBuilder

  • fromBuilder(builder: Builder): Item

  • Parameters

    • builder: Builder

    Returns Item

Generated using TypeDoc