Classes

Mobile

The Mobile class represents a mobile entity in the ClassicUO web client, such as players, NPCs, or creatures. Each mobile entity has attributes such as health, position and stat attributes. Mobile

Extends

• Entity

Extended by

• Player

Properties

_tag

_tag: 'Mobile';

---

direction

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
  }
}

Inherited from

Entity.direction

---

equippedItems

equippedItems: object;

The currently equipped items of the mobile (humanoid/players)

Member	Type
arms	Item
beard	Item
bracelet	Item
cloak	Item
earrings	Item
face	Item
gloves	Item
hair	Item
helmet	Item
legs	Item
mount	Item
necklace	Item
oneHanded	Item
pants	Item
ring	Item
robe	Item
shirt	Item
shoes	Item
skirt	Item
talisman	Item
torso	Item
tunic	Item
twoHanded	Item
waist	Item

---

graphic

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

Inherited from

Entity.graphic

---

hits

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);
}

Inherited from

Entity.hits

---

hue

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);
}

Inherited from

Entity.hue

---

inWarMode

inWarMode: boolean;

Whether the mobile is currently in War Mode (humanoid)

---

isDead

isDead: boolean;

Whether the mobile is dead

---

isFemale

isFemale: boolean;

Whether the mobile is female, or otherwise male.

---

isHidden

isHidden: boolean;

Inherited from

Entity.isHidden

---

isParalyzed

isParalyzed: boolean;

Whether the mobile is currently paralyzed.

---

isPoisoned

isPoisoned: boolean;

Whether the mobile is poisoned (green hued)

---

isYellowHits

isYellowHits: boolean;

Whether the mobiles status is yellow (i.e. Invulnerable)

---

mana

mana: number;

The mobiles current mana. For the player it returns the real value, for other mobiles it is a scale of 1 to 100

---

maxHits

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);
}

Inherited from

Entity.maxHits

---

maxMana

maxMana: number;

The mobiles maximum mana. For the player it returns the real value, for other mobiles it is a scale of 1 to 100

---

maxStamina

maxStamina: number;

The mobiles maximum stamina. For the player it returns the real value, for other mobiles it is a scale of 1 to 100

---

name

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);
}

Inherited from

Entity.name

---

notoriety

notoriety: Notorieties;

The mobiles Notoriety, i.e. Innocent, Gray, etc.

---

serial

serial: number;

Inherited from

Entity.serial

---

stamina

stamina: number;

The mobiles current stamina. For the player it returns the real value, for other mobiles it is a scale of 1 to 100

---

x

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);

Inherited from

Entity.x

---

y

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);

Inherited from

Entity.y

---

z

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);

Inherited from

Entity.z