#Class: Item

Item.Item

#Hierarchy

• Entity

  ↳ Item

#Accessors

#serial

• get serial(): number

#Returns

number

#Inherited from

Entity.serial

#graphic

• get graphic(): number

Gets the graphic id of the entity. Returns 0 if entity is no longer on screen.

Example

console.log(player.graphic); // e.g. 400

#Returns

number

#Inherited from

Entity.graphic

#x

• get x(): number

Gets the current X coordinate of the entity. Returns 0 if entity is no longer on screen.

Example

const entity = client.findObject(player); // Replace with any other entity serial
console.log(entity.x)

#Returns

number

#Inherited from

Entity.x

#y

• get y(): number

Gets the current Y coordinate of the entity. Returns 0 if entity is no longer on screen.

Example

const entity = client.findObject(player);
console.log(entity.y)

#Returns

number

#Inherited from

Entity.y

#z

• get z(): number

Gets the current Z coordinate of the entity. Returns 0 if entity is no longer on screen.

Example

const entity = client.findObject(player);
console.log(entity.z)

#Returns

number

#Inherited from

Entity.z

#name

• get name(): string

Gets the name of the entity. Returns an empty string if not known to the client yet.

Example

const entity = client.findObject(player.equippedItems.robe);
if(entity) {
 console.log(entity.name);
}

#Returns

string

#Inherited from

Entity.name

#hue

• get hue(): number

Gets the hue/color of the entity. Returns 0 if entity is no longer on screen.

Example

const entity = client.findObject(player.equippedItems.robe);
if(entity) {
 console.log(entity.name);
}

#Returns

number

#Inherited from

Entity.hue

#hits

• get hits(): number

Gets the hits of the entity. Returns 0 if the client does not know (e.g. item.hits) or the entity is no longer on screen.

Example

const entity = client.findObject(0x991);
if(entity) {
 console.log(entity.hits);
}

#Returns

number

#Inherited from

Entity.hits

#maxHits

• get maxHits(): number

Gets the maxHits of the entity. Returns 0 if the client does not know (e.g. item.maxHits) or the entity is no longer on screen.

Example

const entity = client.findObject(0x991);
if(entity) {
 console.log(entity.maxHits);
}

#Returns

number

#Inherited from

Entity.maxHits

#direction

• get direction(): number

Gets the direction of the entity as a number, if it has one. Returns 0 if the client does not know (e.g. item.maxHits) or the entity is no longer on screen.

Compare using the Directions enum.

Example

const entity = client.findObject(0x991);
if(entity) {
  if(entity.direction === Directions.North) {
    console.log(`${entity.name} is facing North`);
  }
  else {
    console.log(Directions[entity.direction]); // Prints the directions name, e.g. East
  }
}

#Returns

number

#Inherited from

Entity.direction

#isHidden

• get isHidden(): boolean

#Returns

boolean

#Inherited from

Entity.isHidden

#container

• get container(): number

Get the item's parent container

Example

const item = client.findType(axeType);
if (item.container > 0) {
   client.sysMsg("the item is into a container");
}

#Returns

number

#amount

• get amount(): number

Get the item's amount

Example

const item = client.findObject(0x40001234);
if (item.amount > 5) {
   client.sysMsg("amount of ${item.amount}");
}

#Returns

number

#layer

• get layer(): Layers

Get the item's layer if any

Example

const robe = client.findItemOnLayer(player, Layers.Robe);
console.log(robe.layer);

#Returns

Layers

#contents

• get contents(): undefined | Item[]

Get the item's contents

Example

const itemList = player.backpack.contents;
for (const item of itemlist) {
  if (item.contents.length > 0)
    console.log("this item is a backpack's sub-container!");
}

#Returns

undefined | Item[]

#Methods

#serialFrom

▸ Static serialFrom(value): number

#Parameters

#Returns

number

#Inherited from

Entity.serialFrom