#Class: Entity
Entity.Entity
#Hierarchy
-
↳
Entity
#Accessors
#serial
• get
serial(): number
#Returns
number
#Inherited from
GameObject.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
#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
#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
#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
#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
#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
#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
#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
#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
#isHidden
• get
isHidden(): boolean
#Returns
boolean
#Methods
#serialFrom
▸ Static
serialFrom(value
): number
#Parameters
Name | Type |
---|---|
value |
any |
#Returns
number
#Inherited from
GameObject.serialFrom