#Class: Gump

Gump.Gump

This class is for interacting with Gumps that are sent to the client by the server. Server gumps have a unique serial per shard, and can only have one open at a time.

An instance of Gump therefore interacts with any gump of that serial, and it may become "invalid" if the gump closes externally (e.g. by the shard or the user) You should always to validate the gump is still open by using gump.exists periodically.

Example

A simple script that waits for a Runebook gump before pressing one of the buttons

player.use(0x4021C7B1); // Runebook object serial
const gump = Gump.findOrWait(0x59, 1000); // Wait 1 second for the gump to appear
if(!gump) {
  exit("There's no gump open, is the runebook missing?");
}

player.say("I'm outta here!");
gump.reply(10) // Press the first rune

#Hierarchy

• GameObject

  ↳ Gump

#Accessors

#serial

• get serial(): number

#Returns

number

#Inherited from

GameObject.serial

#exists

• get exists(): boolean

Check if the gump is still open, i.e. the server hasn't closed it or the player.

Example

const gump = Gump.findOrWait(0xBB1B5472, 100);
if(!gump) {
  exit("There's no gump open!");
}

// ... somewhere further down the script

if(gump.exists) {
  console.log("The gump closed, did you do it?");
}

#Returns

boolean

#lastSerial

• Static get lastSerial(): number

The server serial of the last gump sent by the server. May no longer be open, check with exists first.

#Returns

number

#last

• Static get last(): null | Gump

Get a reference to the last Gump sent by the server. Returns undefined if the gump is no longer open.

Example

Closes the last sent gump, if it's open.

Gump.last?.close();

#Returns

null | Gump

#Methods

#serialFrom

▸ Static serialFrom(value): number

#Parameters

#Returns

number

#Inherited from

GameObject.serialFrom

#reply

▸ reply(buttonID): void

Replies to a gump by "pressing" one of the buttons

Example

const gump = Gump.findOrWait(0xBB1B5472, 100);
if(gump?.containsText("Alchemy")) { // If there's a gump open with that serial, check if it has `Alchemy` in it.
  gump.reply(1); // Craft something
}

#Parameters

#Returns

void

#close

▸ close(): void

Closes the gump

Example

Closes the last open gump if it has the word Chat in it.

if(Gump.last?.containsText("Chat")) {
  gump.last?.close();
}

#Returns

void

#containsText

▸ containsText(value): boolean

Checks if the gump contains a certain string, case-insensitive.

Example

const gump = Gump.findOrWait(0xBB1B5472, 100);
if(gump.containsText("Tailoring")) {
  player.say("I hate tailors");
  gump.close();
}

#Parameters

#Returns

boolean

#exists

▸ Static exists(serial): boolean

Checks if a gump with the provided server serial is open without making a new instance of Gump

Example

if(Gump.exists(0xBB1B5472)) {
  player.say("My lovely lady gumps, check it out")
}

#Parameters

#Returns

boolean

#findOrWait

▸ Static findOrWait(serialOrText, timeoutMs?): undefined | Gump

Find a gump by its serial or containing certain text, or wait for it to appear

Example

Waits for the gump with the serial 0xBB1B5472 to open, and then presses a button.

const gump = Gump.findOrWait(0xBB1B5472, 100); // Wait 100 milliseconds (5,000 if unspecified) for the gump to appear
if(gump) {
  gump.reply(1); // Gump is open, simulate pressing a button
}

Example

Waits for a gump to exist that contains the text "Blacksmithing", and then presses a button.

const gump = Gump.findOrWait("Blacksmithy Selection Menu");
if(gump) {
  gump.reply(1); // Gump is open, simulate pressing a button
}

#Parameters

#Returns

undefined | Gump

#closeAll

▸ Static closeAll(): void

Closes all gumps that aren't the Top Bar, Buff bar, or the World view (radar) Same as the Close Gumps hotkey

Example

Gump.closeAll();

#Returns

void

#hasButton

▸ hasButton(id): boolean

Checks if the gump has the button id. Useful if you want to prevent clicking a button that doesn't exist.

Example

const gump = Gump.findOrWait(0x59);
if(gump && gump.hasButton(10)) {
  gump.reply(10); // gump is open and has a button with id 10
}

#Parameters

#Returns

boolean

#switchPage

▸ switchPage(page): void

Attempts to switch the page if possible.

Example

const gump = Gump.findOrWait(0x59);
gump?.switchPage(2); // if gump is open, try changing to page 2

#Parameters

#Returns

void

#setCheckbox

▸ setCheckbox(serial, value): void

Check or uncheck a checkbox/radio button

Example

const gump = Gump.findOrWait(0x59);
gump?.gumpSetCheckbox(serial, true); // if the gump is open, check the checkbox/radio control
gump?.reply(1); // Press a button to reply

#Parameters

#Returns

void

#setTextEntry

▸ setTextEntry(localSerial, value): void

Set the contents of a text entry in a gump

Example

const gump = Gump.findOrWait(0x59);
gump?.setTextEntry(0x01, "Hello there"); // if the gump is open, set the text entries content
gump?.reply(1); // Press a button to reply

#Parameters

#Returns

void

#horizontalMenuSelect

▸ horizontalMenuSelect(graphic, hue?): void

Select an item in the old-school T2A horizontal menu gump.

Example

const gump = Gump.findOrWait(0x59);
if(gump) {
  console.log('Gump exists.');
  gump.horizontalMenuSelect(gump, )
}

#Parameters

#Returns

void