Documentation Index
Fetch the complete documentation index at: https://mintlify.com/ClassicUO/classicuo-web/llms.txt
Use this file to discover all available pages before exploring further.
The Gump class provides a scripting interface for gumps sent to the client by the server — dialog boxes, crafting menus, runebooks, vendor interfaces, and more. Each server gump has a unique serial per shard and only one instance of a given serial can be open at a time.
A Gump instance represents a reference to that open gump. If the gump is closed (by the server, the player, or your script), gump.exists will return false. Always check this before interacting with a gump in long-running scripts.
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 button
Static Properties
Gump.last
static last: null | Gump;
null if no gump has been seen or the last one was closed.
Gump.lastSerial
static lastSerial: number;
Gump.exists(serial) first.
Gump.lastVendorBuyData
static lastVendorBuyData: undefined | object;
const data = Gump.lastVendorBuyData;
if (data && data.type === 'buy') {
// Buy all ingots the vendor has
const ingots = data.items.filter((i) => i.name.toLowerCase().includes('ingot'));
client.sendBuyRequest(data.vendor, ingots);
console.log('Bought items', ingots);
}
Gump.lastVendorSellData
static lastVendorSellData: undefined | object;
player.say('vendor sell');
const data = Gump.lastVendorSellData;
if (data && data.type === 'sell') {
const tongs = data.items.filter((i) => i.name.toLowerCase() === 'tongs');
client.sendSellRequest(data.vendor, tongs);
console.log('Sold items', tongs.map((i) => i.name));
}
Instance Properties
exists
Returns true if this gump instance is still open. Becomes false if the server or player closes it.
const gump = Gump.findOrWait(0xbb1b5472, 100);
if (!gump) {
exit("There's no gump open!");
}
// ... later in the script
if (!gump.exists) {
console.log('The gump was closed externally.');
}
serial
The server serial that uniquely identifies this gump on the shard.
Static Methods
Gump.findOrWait()
static findOrWait(
serialOrText: string | number,
timeoutMs?: number,
fromServer?: boolean
): undefined | Gump
timeoutMs for one to appear. Can search by serial number or by text content.
The server serial (number) or a text substring (string) to search for.
Maximum wait time in milliseconds. Defaults to 5000ms if not specified.
If false, searches local (client-side) gumps too. Defaults to true.
// Find by serial, wait 100ms
const gump = Gump.findOrWait(0xbb1b5472, 100);
if (gump) {
gump.reply(1);
}
// Find by text content
const gump = Gump.findOrWait('Blacksmithy Selection Menu');
if (gump) {
gump.reply(1);
}
// Find a local (non-server) gump
const bag = client.findObject(0x4021c7b1);
if (bag) {
player.use(bag);
const gump = Gump.findOrWait(bag, 1000, false); // false = search local gumps
if (gump) {
client.sysMsg('gump found');
}
}
Gump.exists()
static exists(serial: number): boolean
Gump instance.
if (Gump.exists(0xbb1b5472)) {
player.say('My lovely lady gumps, check it out');
}
Gump.closeAll()
Closes all open gumps except the Top Bar, Buff Bar, and World view. Equivalent to the Close Gumps hotkey.
Gump.waitForVendorGumpData()
static waitForVendorGumpData(timeoutMs?: number): undefined | object
undefined if no vendor gump appears within the timeout.
Maximum time to wait in milliseconds.
// Caution! This sells everything the vendor will accept!
player.say('vendor sell');
const data = Gump.waitForVendorGumpData();
if (data && data.type === 'sell') {
client.sendSellRequest(data.vendor, data.items);
console.log('Sold items', data.items.map((i) => i.name));
}
Instance Methods
reply()
reply(buttonID: number): void
hasButton() first if you’re unsure the button exists.
The numeric ID of the button to press.
const gump = Gump.findOrWait(0xbb1b5472, 100);
if (gump?.containsText('Alchemy')) {
gump.reply(1); // Craft something
}
containsText()
containsText(value: string): boolean
const gump = Gump.findOrWait(0xbb1b5472, 100);
if (gump?.containsText('Tailoring')) {
player.say('I hate tailors');
gump.close();
}
hasButton(id: number): boolean
true if the gump has a button with the given ID. Use this before reply() to avoid sending an invalid button press.
const gump = Gump.findOrWait(0x59);
if (gump && gump.hasButton(10)) {
gump.reply(10);
}
close()
Closes this gump.
if (Gump.last?.containsText('Chat')) {
Gump.last?.close();
}
setCheckbox()
setCheckbox(serial: number, value: boolean): void
reply() afterwards to submit.
The control serial within the gump.
true to check, false to uncheck.
const gump = Gump.findOrWait(0x59);
gump?.setCheckbox(0x01, true);
gump?.reply(1);
setTextEntry()
setTextEntry(localSerial: number, value: string): void
The local serial of the text entry control.
const gump = Gump.findOrWait(0x59);
gump?.setTextEntry(0x01, 'Hello there');
gump?.reply(1);
switchPage()
switchPage(page: number): void
const gump = Gump.findOrWait(0x59);
gump?.switchPage(2);
horizontalMenuSelect(graphic: number, hue?: number): void
The graphic ID of the item to select.
Optional hue of the item.
Common Pattern — Runebook
player.use(0x4021c7b1); // Runebook serial
const gump = Gump.findOrWait(0x59, 2000);
if (!gump) exit('Runebook gump not found');
// Navigate to the second rune
if (gump.hasButton(11)) {
gump.reply(11);
}
