ClassicUO Logo

#Class: Client

Client.Client

#Constructors

#constructor

new Client()

#Properties

#sysMsg

sysMsg: (message: string, hue?: number) => void

#Type declaration

▸ (message, hue?): void

Display a message in the text chat.

Example

Say a message in red/green over the players head.

client.headMsg('A chat in Red', 33);
client.headMsg('A chat in Green', 66);
#Parameters
Name Type
message string
hue? number
#Returns

void


#headMsg

headMsg: (message: string, serial: number | SerialObject | GameObject, hue?: number) => void

#Type declaration

▸ (message, serial, hue?): void

Display a message overhead of the target entity.

Example

Say a message in red/green over the players head.

client.headMsg('A message in Red', player, 33);
client.headMsg('A message in Green', player, 66);
#Parameters
Name Type
message string
serial number | SerialObject | GameObject
hue? number
#Returns

void


#openPaperdoll

openPaperdoll: (serial?: number | SerialObject | GameObject) => void

#Type declaration

▸ (serial?): void

Open the paperdoll for a Mobile.

Example

const nearestHuman = client.selectEntity(
 SearchEntityOptions.Any,
 SearchEntityRangeOptions.Nearest,
 SearchEntityTypeOptions.Human,
 false
);

client.openPaperdoll(nearestHuman);
#Parameters
Name Type
serial? number | SerialObject | GameObject
#Returns

void


#findObject

findObject: (serial: number | SerialObject | GameObject, hue?: null | number, sourceSerial?: null | number | SerialObject | GameObject, amount?: null | number, range?: null | number) => undefined | Item | Mobile

#Type declaration

▸ (serial, hue?, sourceSerial?, amount?, range?): undefined | Item | Mobile

Attempts to check whether a certain object can be found in the game.

Example

const runebookSerial = 0x401C37FB;
const runebook = client.findObject(runebookSerial);

if(runebook) {
  player.use(runebook);
} else {
  client.headMsg("Runbook missing!", player.serial);
}
#Parameters
Name Type
serial number | SerialObject | GameObject
hue? null | number
sourceSerial? null | number | SerialObject | GameObject
amount? null | number
range? null | number
#Returns

undefined | Item | Mobile


#findType

findType: (graphic: number, hue?: null | number, sourceSerial?: null | number | SerialObject | GameObject, amount?: null | number, range?: null | number) => undefined | Item | Mobile

#Type declaration

▸ (graphic, hue?, sourceSerial?, amount?, range?): undefined | Item | Mobile

Attempts to find an object in the world with the specified search parameters, returning it if found.

Example

const bandageType = 0xE21;
const bandages = client.findType(bandageType);

if(bandages) {
  player.use(bandages);
  target.waitTargetSelf();
} else {
  client.headMsg("Out of bandages", player.serial);
}
#Parameters
Name Type
graphic number
hue? null | number
sourceSerial? null | number | SerialObject | GameObject
amount? null | number
range? null | number
#Returns

undefined | Item | Mobile


#findItemOnLayer

findItemOnLayer: (serial: number | SerialObject | GameObject, layer: Layers) => undefined | Item

#Type declaration

▸ (serial, layer): undefined | Item

Attempts to find the object at the specified layer, if it exists.

Example

Try to remove the currently equipped helmet.

const helm = client.findItemOnLayer(player.serial, Layers.Helmet);

if (helm) {
  client.headMsg(`Removing helm`, player);
  player.moveItem(helm, player.backpack);
} else {
  client.headMsg("Not wearing a helm", player.serial);
}
#Parameters
Name Type
serial number | SerialObject | GameObject
layer Layers
#Returns

undefined | Item


#selectEntity

selectEntity: (searchOpt: SearchEntityOptions, searchRangeOpt: SearchEntityRangeOptions, searchTypeOpt: SearchEntityTypeOptions, asFriend: boolean) => undefined | Mobile

#Type declaration

▸ (searchOpt, searchRangeOpt, searchTypeOpt, asFriend): undefined | Mobile

Returns the entity based on the search criteria

Example

Select nearest Gray or Enemy entity, with Any body type, and not as a friend

 client.selectEntity(
   SearchEntityOptions.Enemy | SearchEntityOptions.Gray,
   SearchEntityRangeOptions.Nearest,
   SearchEntityTypeOptions.Any,
   false
 )

Example

Select nearest Innocent entity, with Any body type, and not as a friend

 client.selectEntity(
   SearchEntityOptions.Innocent,
   SearchEntityRangeOptions.Nearest,
   SearchEntityTypeOptions.Human,
   false
 )
#Parameters
Name Type
searchOpt SearchEntityOptions
searchRangeOpt SearchEntityRangeOptions
searchTypeOpt SearchEntityTypeOptions
asFriend boolean
#Returns

undefined | Mobile


#allNames

allNames: () => any

#Type declaration

▸ (): any

Triggers the All Names macro which shows name overheads for all entities on-screen.

Example

client.allNames();
#Returns

any


#quitGame

quitGame: () => any

#Type declaration

▸ (): any

Triggers the Quit Game dialogue

Example

client.quitGame();
#Returns

any


#toggleAlwaysRun

toggleAlwaysRun: () => any

#Type declaration

▸ (): any

Toggles whether the player always runs despite the mouse distance from the player mobile.

Example

client.toggleAlwaysRun();
#Returns

any


#closeAllGumps

closeAllGumps: () => any

#Type declaration

▸ (): any

Closes all gumps that aren't the Top Bar, Buff bar, or the World view (radar)

Example

client.closeAllGumps();
#Returns

any


#closeCorpses

closeCorpses: () => any

#Type declaration

▸ (): any

Closes all corpses on-screen

Example

client.closeCorpses();
#Returns

any


#closeAllHealthBars

closeAllHealthBars: () => any

#Type declaration

▸ (): any

Closes all healthbars on-screen

Example

client.closeAllHealthBars();
#Returns

any


#closeInactiveHealthBars

closeInactiveHealthBars: () => any

#Type declaration

▸ (): any

Closes all inactive healthbars (i.e. dead or off-screen entities).

Example

client.closeInactiveHealthBars();
#Returns

any


#zoomReset

zoomReset: () => any

#Type declaration

▸ (): any

Reset the viewport zoom back to default (1.1)

Example

client.zoomReset();
#Returns

any


#zoomIn

zoomIn: () => any

#Type declaration

▸ (): any

Zooms in the viewport

Example

client.zoomIn();
#Returns

any


#zoomOut

zoomOut: () => any

#Type declaration

▸ (): any

Zooms out the viewport

Example

client.zoomIn();
#Returns

any


#toggleChatVisibility

toggleChatVisibility: () => any

#Type declaration

▸ (): any

Toggles the chat visibility, e.g. the bar at the bottom of the game viewport

Example

client.zoomIn();
#Returns

any


#setGrabBag

setGrabBag: () => any

#Type declaration

▸ (): any

Sets the grab bag used by Grid Loot

Example

client.zoomIn();
#Returns

any


#toggleNameOverheads

toggleNameOverheads: () => any

#Type declaration

▸ (): any

Toggles whether entities have name plates

Example

client.toggleNameOverheads();
#Returns

any


#toggleAuras

toggleAuras: () => any

#Type declaration

▸ (): any

Toggles whether mobiles have auras underneath them

Example

client.toggleAuras();
#Returns

any


#getStatic

getStatic: (graphic: number) => undefined | { graphic: number ; flags: number }

#Type declaration

▸ (graphic): undefined | { graphic: number ; flags: number }

#Parameters
Name Type
graphic number
#Returns

undefined | { graphic: number ; flags: number }


#getTile

getTile: (graphic: number) => undefined | { graphic: number ; flags: number }

#Type declaration

▸ (graphic): undefined | { graphic: number ; flags: number }

#Parameters
Name Type
graphic number
#Returns

undefined | { graphic: number ; flags: number }


#getTerrainList

getTerrainList: (x: number, y: number) => undefined | { graphic: number ; x: number ; y: number ; z: number ; flags: number ; isLand: boolean }[]

#Type declaration

▸ (x, y): undefined | { graphic: number ; x: number ; y: number ; z: number ; flags: number ; isLand: boolean }[]

#Parameters
Name Type
x number
y number
#Returns

undefined | { graphic: number ; x: number ; y: number ; z: number ; flags: number ; isLand: boolean }[]


#getEntityOrControlAtCursor

getEntityOrControlAtCursor: () => any

#Type declaration

▸ (): any

#Returns

any


#sendBuyRequest

sendBuyRequest: (vendorSerial: number | Mobile, items: { serial: number ; amount: number }[]) => boolean

#Type declaration

▸ (vendorSerial, items): boolean

#Parameters
Name Type
vendorSerial number | Mobile
items { serial: number ; amount: number }[]
#Returns

boolean


#sendSellRequest

sendSellRequest: (vendorSerial: number | Mobile, items: { serial: number ; amount: number }[]) => boolean

#Type declaration

▸ (vendorSerial, items): boolean

#Parameters
Name Type
vendorSerial number | Mobile
items { serial: number ; amount: number }[]
#Returns

boolean


#queryItemOPL

queryItemOPL: (serial: number | Item, timeout?: number) => { serial: number ; data: string ; name: string ; graphic: number ; hue: number ; amount: number }

#Type declaration

▸ (serial, timeout?): Object

#Parameters
Name Type
serial number | Item
timeout? number
#Returns

Object

Name Type
serial number
data string
name string
graphic number
hue number
amount number

#queryItemSingleClickName

queryItemSingleClickName: (serial: number, timeout?: number) => string

#Type declaration

▸ (serial, timeout?): string

#Parameters
Name Type
serial number
timeout? number
#Returns

string