ClassicUO Logo

#Class: Client

Client.Client

#Properties

#sysMsg

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

#Type declaration

▸ (message, hue?): null

#Parameters
Name Type
message string
hue? number
#Returns

null


#headMsg

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

#Type declaration

▸ (message, serial, hue?): null

#Parameters
Name Type
message string
serial number | SerialObject | GameObject
hue? number
#Returns

null


#openPaperdoll

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

#Type declaration

▸ (serial?): null

#Parameters
Name Type
serial? number | SerialObject | GameObject
#Returns

null


#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

#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

#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

#Parameters
Name Type
serial number | SerialObject | GameObject
layer Layers
#Returns

undefined | Item


#selectEntity

selectEntity: (searchOpt: number, searchRangeOpt: SearchEntityRangeOptions, searchTypeOpt: SearchEntityTypeOptions, asFriend: boolean) => number

#Type declaration

▸ (searchOpt, searchRangeOpt, searchTypeOpt, asFriend): number

#Parameters
Name Type
searchOpt number
searchRangeOpt SearchEntityRangeOptions
searchTypeOpt SearchEntityTypeOptions
asFriend boolean
#Returns

number


#allNames

allNames: () => unknown

#Type declaration

▸ (): unknown

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

Example

client.allNames();
#Returns

unknown


#quitGame

quitGame: () => unknown

#Type declaration

▸ (): unknown

Triggers the Quit Game dialogue

Example

client.quitGame();
#Returns

unknown


#toggleAlwaysRun

toggleAlwaysRun: () => unknown

#Type declaration

▸ (): unknown

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

Example

client.toggleAlwaysRun();
#Returns

unknown


#closeAllGumps

closeAllGumps: () => unknown

#Type declaration

▸ (): unknown

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

Example

client.closeAllGumps();
#Returns

unknown


#closeCorpses

closeCorpses: () => unknown

#Type declaration

▸ (): unknown

Closes all corpses on-screen

Example

client.closeCorpses();
#Returns

unknown


#closeAllHealthBars

closeAllHealthBars: () => unknown

#Type declaration

▸ (): unknown

Closes all healthbars on-screen

Example

client.closeAllHealthBars();
#Returns

unknown


#closeInactiveHealthBars

closeInactiveHealthBars: () => unknown

#Type declaration

▸ (): unknown

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

Example

client.closeInactiveHealthBars();
#Returns

unknown


#zoomReset

zoomReset: () => unknown

#Type declaration

▸ (): unknown

Reset the viewport zoom back to default (1.1)

Example

client.zoomReset();
#Returns

unknown


#zoomIn

zoomIn: () => unknown

#Type declaration

▸ (): unknown

Zooms in the viewport

Example

client.zoomIn();
#Returns

unknown


#zoomOut

zoomOut: () => unknown

#Type declaration

▸ (): unknown

Zooms out the viewport

Example

client.zoomIn();
#Returns

unknown


#toggleChatVisibility

toggleChatVisibility: () => unknown

#Type declaration

▸ (): unknown

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

Example

client.zoomIn();
#Returns

unknown


#setGrabBag

setGrabBag: () => unknown

#Type declaration

▸ (): unknown

Sets the grab bag used by Grid Loot

Example

client.zoomIn();
#Returns

unknown


#toggleNameOverheads

toggleNameOverheads: () => unknown

#Type declaration

▸ (): unknown

Toggles whether entities have name plates

Example

client.toggleNameOverheads();
#Returns

unknown


#toggleAuras

toggleAuras: () => unknown

#Type declaration

▸ (): unknown

Toggles whether mobiles have auras underneath them

Example

client.toggleAuras();
#Returns

unknown


#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