Classes

Client

Methods

toggleCircleOfTransparency()

toggleCircleOfTransparency(): void

Toggles the Circle of Transparency between states

Example

client.toggleCircleOfTransparency();

---

sysMsg()

(message: string, hue?: number): void

Parameters

Parameter	Type
message	string
hue?	number

---

headMsg()

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

Parameters

Parameter	Type
message	string
serial	number | SerialObject | GameObject
hue?	number

---

openPaperdoll()

(serial?: number | SerialObject | GameObject): void

Parameters

Parameter	Type
serial?	number | SerialObject | GameObject

---

findObject()

(
   serial: number | SerialObject | GameObject,
   hue?: null | number,
   sourceSerial?: null | number | SerialObject | GameObject,
   amount?: null | number,
   range?: null | number): any

Parameters

Parameter	Type
serial	number | SerialObject | GameObject
hue?	null | number
sourceSerial?	null | number | SerialObject | GameObject
amount?	null | number
range?	null | number

---

findType()

(
   graphic: number,
   hue?: null | number,
   sourceSerial?: null | number | SerialObject | GameObject,
   amount?: null | number,
   range?: null | number): any

Parameters

Parameter	Type
graphic	number
hue?	null | number
sourceSerial?	null | number | SerialObject | GameObject
amount?	null | number
range?	null | number

---

findItemOnLayer()

(serial: number | SerialObject | GameObject, layer: Layers): any

Parameters

Parameter	Type
serial	number | SerialObject | GameObject
layer	Layers

---

selectEntity()

(
   searchOpt: number,
   searchRangeOpt: number,
   searchTypeOpt: number,
   asFriend: boolean): any

Parameters

Parameter	Type
searchOpt	number
searchRangeOpt	number
searchTypeOpt	number
asFriend	boolean

---

allNames()

(): any

---

quitGame()

(): any

---

toggleAlwaysRun()

(): any

---

closeAllGumps()

(): any

---

closeCorpses()

(): any

---

closeAllHealthBars()

(): any

---

closeInactiveHealthBars()

(): any

---

zoomReset()

(): any

---

zoomIn()

(): any

---

zoomOut()

(): any

---

toggleChatVisibility()

(): any

---

setGrabBag()

(): any

---

toggleNameOverheads()

(): any

---

toggleAuras()

(): any

---

getStatic()

(graphic: number): undefined | object

Parameters

Parameter	Type
graphic	number

Returns

undefined | object

---

getTile()

(graphic: number): undefined | object

Parameters

Parameter	Type
graphic	number

Returns

undefined | object

---

getTerrainList()

(x: number, y: number): undefined | object[]

Parameters

Parameter	Type
x	number
y	number

Returns

undefined | object[]

---

sendBuyRequest()

(vendorSerial: any, items: object[]): boolean

Parameters

Parameter	Type
vendorSerial	any
items	object[]

Returns

boolean

---

sendSellRequest()

(vendorSerial: any, items: object[]): boolean

Parameters

Parameter	Type
vendorSerial	any
items	object[]

Returns

boolean

---

queryItemOPL()

(serialOrObject: number | SerialObject | GameObject, timeout?: number): object

Parameters

Parameter	Type
serialOrObject	number | SerialObject | GameObject
timeout?	number

Returns

object

Member	Type
amount	number
data	null | string
graphic	number
hue	number
name	string
properties	null | object[]
serial	number

---

queryItemSingleClickName()

(serialOrObject: number | SerialObject | GameObject, timeout?: number): string

Parameters

Parameter	Type
serialOrObject	number | SerialObject | GameObject
timeout?	number

Returns

string