Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IItem

Hierarchy

Implemented by

Index

Properties

Optional book

book: BookType

Optional containedWithin

containedWithin: IContainer

Optional decay

decay: number

Optional disassembly

disassembly: IItemArray

Optional equippedPid

equippedPid: number

id

id: number

Optional legendary

legendary: IItemLegendary

Optional maxDur

maxDur: number

Optional minDur

minDur: number

Optional order

order: number

Optional ownerIdentifier

ownerIdentifier: string

Optional quality

quality: ItemQuality

Optional quickSlot

quickSlot: number

Optional renamed

renamed: string

Optional tatteredMap

tatteredMap: TatteredMap

type

type: ItemType

weight

weight: number

Methods

acquireNotify

  • acquireNotify(player: IPlayer): void
  • Parameters

    Returns void

changeInto

  • changeInto(itemType: ItemType, disableNotify?: boolean): void
  • Parameters

    • itemType: ItemType
    • Optional disableNotify: boolean

    Returns void

clearQuickSlot

  • clearQuickSlot(): void
  • Returns void

damage

  • damage(source: string, modifier?: number): void
  • Parameters

    • source: string
    • Optional modifier: number

    Returns void

description

dropInLava

  • dropInLava(player: IPlayer, x?: number, y?: number): void
  • Parameters

    • player: IPlayer
    • Optional x: number
    • Optional y: number

    Returns void

dropInWater

  • dropInWater(player: IPlayer, x?: number, y?: number): void
  • Parameters

    • player: IPlayer
    • Optional x: number
    • Optional y: number

    Returns void

getDecayMax

  • getDecayMax(): number
  • Returns number

getDisassemblyWeight

  • getDisassemblyWeight(): number
  • Returns number

getEquipSlot

  • Returns EquipType | undefined

getLocation

  • getLocation(): IPointZ | undefined
  • Returns IPointZ | undefined

getOnUseBonus

  • getOnUseBonus(): number
  • Returns number

getStokeFireValue

  • getStokeFireValue(): number | undefined
  • Returns number | undefined

getTotalWeight

  • getTotalWeight(): number
  • Returns number

initializeMap

  • initializeMap(): void
  • Returns void

isDamaged

  • isDamaged(): boolean
  • Returns boolean

isDecayed

  • isDecayed(): boolean
  • Returns boolean

isEquipped

  • isEquipped(): boolean
  • Returns boolean

isValid

  • isValid(): boolean
  • Returns boolean

placeOnTile

  • placeOnTile(x: number, y: number, z: number, force: boolean, skipMessage?: boolean): boolean
  • Parameters

    • x: number
    • y: number
    • z: number
    • force: boolean
    • Optional skipMessage: boolean

    Returns boolean

returns

  • returns(): boolean
  • Returns boolean

setQuality

  • Parameters

    Returns void

setQuickSlot

  • setQuickSlot(player: IPlayer, quickSlot: number | undefined): void
  • Parameters

    • player: IPlayer
    • quickSlot: number | undefined

    Returns void

shouldBeProtected

  • shouldBeProtected(): boolean
  • Returns boolean

spawnCreatureOnItem

  • spawnCreatureOnItem(creatureType: CreatureType | undefined, forceAberrant?: boolean): ICreature | undefined
  • Parameters

    • creatureType: CreatureType | undefined
    • Optional forceAberrant: boolean

    Returns ICreature | undefined

spawnOnBreak

  • Returns ICreature | undefined

spawnOnDecay

  • Returns ICreature | undefined

verifyAndFixItem

  • verifyAndFixItem(): void
  • Returns void

Generated using TypeDoc