#Class: Player

Player.Player

This class references the current player whilst in-game and is accessible on the global scope as the player variable.

Example

A simple script which yells out when the player health is below a threshold

while(true) {
 if(player.hits < 50) {
   player.say('I need healing!');
 }
 sleep(500);
}

#Hierarchy

• Mobile

  ↳ Player

#Methods

#serialFrom

▸ Static serialFrom(value): number

#Parameters

#Returns

number

#Inherited from

Mobile.serialFrom

#say

▸ say(message, hue?): void

Sends a chat message as your player, with an optional hue for the message.

Example

player.say('Hello there!');

#Parameters

#Returns

void

#cast

▸ cast(spell): void

Casts a spell

Example

player.cast(Spells.Agility);
target.wait();
target.entity(player);

#Parameters

#Returns

void

#castTo

▸ castTo(spell, serial, timeout?): void

Casts a spell and automatically targets the given serial on the next target

Example

player.castTo(Spells.Heal, player);

#Parameters

#Returns

void

#useSkill

▸ useSkill(skill, target?, timeout?): void

Uses a skill

Example

Use skill without a target

player.useSkill(Skills.Meditation);

@example Use skill and target yourself
```ts
player.useSkill(Skills.Anatomy);

#Parameters

#Returns

void

#useVirtue

▸ useVirtue(virtue, target?, timeout?): void

Uses a virtue

Example

Use virtue without a target

player.useVirtue(Virtues.Honor);

@example Use virtue and target yourself
```ts
player.useVirtue(Virtues.Honor);

#Parameters

#Returns

void

#equip

▸ equip(serial): void

Attempts to equip an item if possible

Example

const axe = client.findType(0x0F49); // Axe graphic ID
player.equip(axe);

#Parameters

#Returns

void

#attack

▸ attack(serial): void

Attacks a mobile

Example

player.attack(target.lastSerial);

#Parameters

#Returns

void

#fly

▸ fly(): void

Attempt to fly... if you can.

Example

player.fly();

#Returns

void

#land

▸ land(): void

Turn off flying and land

Example

player.land();

#Returns

void

#toggleFlying

▸ toggleFlying(): void

Toggles flying, provided you are a Gargoyle.

Example

player.toggleFlying();

#Returns

void

#useItemInHand

▸ useItemInHand(): void

Uses the item currently in your left-hand first, otherwise it will try the right.

Example

player.useItemInHand();

#Returns

void

#useLastObject

▸ useLastObject(): void

Uses the last object you double-clicked

Example

player.useLastObject();

#Returns

void

#openDoor

▸ openDoor(): void

Uses any door directly in-front of where the player is facing

Example

player.openDoor();

#Returns

void

#bow

▸ bow(): void

Triggers the Bow emote

Example

player.bow();

#Returns

void

#salute

▸ salute(): void

Triggers the Salute emote

Example

player.salute();

#Returns

void

#toggleWarMode

▸ toggleWarMode(): void

Toggle War Mode

Example

player.toggleWarMode();

#Returns

void

#use

▸ use(serial): void

Attempts to use an object if possible

Example

const dagger = client.findType(0x0F52); // Dagger graphic ID
player.use(dagger);

#Parameters

#Returns

void

#click

▸ click(serial): void

Simulates clicking an object

Example

player.click(player);

#Parameters

#Returns

void

#useType

▸ useType(graphic, hue?, sourceSerial?, range?): boolean

Attempts to use an object of a certain type

Example

const myFriend = 0x217DED;
player.useType(0xE21); // Bandage type
target.wait(5000);
target.entity(myFriend);

#Parameters

#Returns

boolean

#moveItem

▸ moveItem(serial, container, x?, y?, z?, amount?): boolean

Attempts to move an object between containers

Example

if(player.equippedItems.robe) {
  player.moveItem(player.equippedItems.robe, player.backpack);
}

#Parameters

#Returns

boolean

#moveItemOnGroundOffset

▸ moveItemOnGroundOffset(serial, x?, y?, z?, amount?): boolean

Attempts to move an object around on the ground using an offset

Example

const targetInfo = target.queryTarget();
if(targetInfo) {
  player.moveItemOnGroundOffset(targetInfo, 1, 0, 0); // Move item to the east
}

#Parameters

#Returns

boolean

#moveType

▸ moveType(graphic, src, dest, x?, y?, z?, hue?, amount?, range?): boolean

Attempts to move an object of a certain type between containers

Example

player.moveType(0x0F52, player.backpack, bag);

#Parameters

#Returns

boolean

#moveTypeOnGroundOffset

▸ moveTypeOnGroundOffset(graphic, src, x?, y?, z?, hue?, amount?, range?): void

Attempts to move an object of a certain type onto the ground

Example

player.moveType(0x0F52, player.backpack); // Move item to the east

#Parameters

#Returns

void

#setAbility

▸ setAbility(primary, active): void

Toggle ability on/off

Example

player.setAbility(true, false); // Turn primary ability off
player.setAbility(false, true); // Turn secondary ability on

#Parameters

#Returns

void

#walk

▸ walk(direction): boolean

Walk/turn a single step in a direction

Example

player.walk(Directions.North);

#Parameters

#Returns

boolean

True if character can walk

#run

▸ run(direction): boolean

Run/turn a single step in a direction

Example

player.run(Directions.South);

#Parameters

#Returns

boolean

True if character can run

#setSkillLock

▸ setSkillLock(skill, lock): void

Set the status of a skill lock

Example

player.setSkillLock(Skills.Anatomy, SkillLock.Down);

#Parameters

#Returns

void

#getSkill

▸ getSkill(skill): undefined | { value: number ; index: number ; name: string ; lock: number ; base: number ; cap: number ; canBeUsable: boolean }

Gets an object containing the values of a skill. The actual value of the skill is represented as an integer value with no decimal. e.g. 74.6 would be 746

Example

const anatomySkill = player.getSkill(Skills.Anatomy).value;

#Parameters

#Returns

undefined | { value: number ; index: number ; name: string ; lock: number ; base: number ; cap: number ; canBeUsable: boolean }

#getAllSkills

▸ getAllSkills(): undefined | { value: number ; index: number ; name: string ; lock: number ; base: number ; cap: number ; canBeUsable: boolean }[]

Gets an array of all the skill values

Example

const skills = player.getSkills();
console.log(skills[0].value); // Print Alchemy skill value

#Returns

undefined | { value: number ; index: number ; name: string ; lock: number ; base: number ; cap: number ; canBeUsable: boolean }[]

#hasBuffDebuff

▸ hasBuffDebuff(buffID): boolean

#Parameters

#Returns

boolean

#Accessors

#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

Mobile.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

Mobile.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

Mobile.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

Mobile.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

Mobile.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

Mobile.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

Mobile.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

Mobile.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

Mobile.direction

#isHidden

• get isHidden(): boolean

#Returns

boolean

#Inherited from

Mobile.isHidden

#stamina

• get stamina(): number

#Returns

number

#Inherited from

Mobile.stamina

#maxStamina

• get maxStamina(): number

#Returns

number

#Inherited from

Mobile.maxStamina

#mana

• get mana(): number

#Returns

number

#Inherited from

Mobile.mana

#maxMana

• get maxMana(): number

#Returns

number

#Inherited from

Mobile.maxMana

#isPoisoned

• get isPoisoned(): boolean

#Returns

boolean

#Inherited from

Mobile.isPoisoned

#isYellowHits

• get isYellowHits(): boolean

#Returns

boolean

#Inherited from

Mobile.isYellowHits

#isFemale

• get isFemale(): boolean

#Returns

boolean

#Inherited from

Mobile.isFemale

#notoriety

• get notoriety(): Notorieties

#Returns

Notorieties

#Inherited from

Mobile.notoriety

#inWarMode

• get inWarMode(): boolean

#Returns

boolean

#Inherited from

Mobile.inWarMode

#isParalyzed

• get isParalyzed(): boolean

#Returns

boolean

#Inherited from

Mobile.isParalyzed

#isDead

• get isDead(): boolean

#Returns

boolean

#Inherited from

Mobile.isDead

#equippedItems

• get equippedItems(): Object

#Returns

Object

#Inherited from

Mobile.equippedItems

#serial

• get serial(): number

#Returns

number

#Overrides

Mobile.serial

#coldResistance

• get coldResistance(): number

#Returns

number

#damageIncrease

• get damageIncrease(): number

#Returns

number

#damageMax

• get damageMax(): number

#Returns

number

#damageMin

• get damageMin(): number

#Returns

number

#defenseChanceIncrease

• get defenseChanceIncrease(): number

#Returns

number

#dexterity

• get dexterity(): number

#Returns

number

#energyResistance

• get energyResistance(): number

#Returns

number

#fasterCasting

• get fasterCasting(): number

#Returns

number

#fasterCastRecovery

• get fasterCastRecovery(): number

#Returns

number

#fireResistance

• get fireResistance(): number

#Returns

number

#followers

• get followers(): number

#Returns

number

#maxFollowers

• get maxFollowers(): number

#Returns

number

#gold

• get gold(): number

#Returns

number

#hitChanceIncrease

• get hitChanceIncrease(): number

#Returns

number

#intelligence

• get intelligence(): number

#Returns

number

#lowerManaCost

• get lowerManaCost(): number

#Returns

number

#lowerReagentCost

• get lowerReagentCost(): number

#Returns

number

#luck

• get luck(): number

#Returns

number

#maxColdResistence

• get maxColdResistence(): number

#Returns

number

#maxDefenseChanceIncrease

• get maxDefenseChanceIncrease(): number

#Returns

number

#maxEnergyResistence

• get maxEnergyResistence(): number

#Returns

number

#maxFireResistence

• get maxFireResistence(): number

#Returns

number

#maxPhysicResistence

• get maxPhysicResistence(): number

#Returns

number

#maxPoisonResistence

• get maxPoisonResistence(): number

#Returns

number

#physicalResistance

• get physicalResistance(): number

#Returns

number

#poisonResistance

• get poisonResistance(): number

#Returns

number

#spellDamageIncrease

• get spellDamageIncrease(): number

#Returns

number

#statsCap

• get statsCap(): number

#Returns

number

#strength

• get strength(): number

#Returns

number

#swingSpeedIncrease

• get swingSpeedIncrease(): number

#Returns

number

#tithingPoints

• get tithingPoints(): number

#Returns

number

#weight

• get weight(): number

#Returns

number

#weightMax

• get weightMax(): number

#Returns

number

#primaryAbility

• get primaryAbility(): Abilities

#Returns

Abilities

#secondaryAbility

• get secondaryAbility(): Abilities

#Returns

Abilities

#backpack

• get backpack(): undefined | Item

#Returns

undefined | Item