EN Runtime API 04 Gumps and Menus - LIHACHTETAN/ClassicUO-Bad-Newbie-CSharp-Scripts-IDE GitHub Wiki
Українська · Русский · English · Deutsch · Français · Italiano · Español · 繁體中文 · 日本語 · 한국어
Runtime API - Gumps and menus
Home · C# · IDE · UO API · A–Z · Examples · Languages
Each team opens a card with C#-signatures, parameters and several independent examples.
UO.AutoMenu
Registers a persistent menu hook: when a server menu with a suitable caption appears, the client selects the appropriate item. The call does not open the menu and does not wait for it synchronously.
UO.CancelAllMenuHooks
Removes all registered automatic hooks from old client server menus.
UO.CancelGump
Closes the selected server gump via a compatible resolver CloseSimpleGump.
UO.CancelMenu
Removes all registered automatic hooks from old client server menus.
UO.CloseClientGump
Removes local server gumps whose ServerSerial matches the passed ID.
UO.CloseMenu
Cancels all active old server menus via CancelForYoko.
UO.CloseSimpleGump
Locally closes a server gump that is allowed to be closed by a strict index.
UO.GetGump
Reads one field of the selected server gump. Allows you to explicitly set the window selector.
UO.GetGumpButtonsDescription
Returns descriptions of regular server gump buttons.
UO.GetGumpCount
Short version GetGumpsCount: number of active server gumps.
UO.GetGumpFullLines
Returns descriptions of all living elements, including nested server gumps.
UO.GetGumpID
Reads the GumpID window type ID from the server gump index.
UO.GetGumpInfo
Returns a consistent snapshot of the identifiers and elements of a single server gump.
UO.GetGumpsCount
Returns the number of active server gumps.
UO.GetGumpSerial
Reads the serial of the window instance/owner by the server gump index.
UO.GetGumpShortLines
Returns descriptions of text elements and buttons of the server gump.
UO.GetLastMenuItems
Reads the items of the already open old server menu.
UO.GetMenuItems
Reads the items of the already open old server menu.
UO.GetMenuItemsEx
Reads the items of the already open old server menu.
UO.GumpAutoCheckBox
Sets the value of the element once in the first suitable server gump; if the element does not exist yet, saves the wait.
UO.GumpAutoRadiobutton
Sets the value of the element once in the first suitable server gump; if the element does not exist yet, saves the wait.
UO.GumpExists
Checks for the presence of a server gump using one selector or an exact serial/GumpID pair.
UO.GumpObject
Selects an existing server gump for subsequent calls.
UO.InfoGump
Opens a detailed inspector of the server window: GumpID, Serial, position, dimensions, pages, buttons and ButtonID, text, input fields and radio buttons. Without an argument, the previously selected or last active server gump is selected. The argument is resolved by GumpID/serial, then by list index. Only -1 means selected/last window; other negative int retain the 32-bit ID, such as 0x87654321. The inspected window becomes selected for SendGumpSelect(buttonId). If there is no suitable window, the client reports this; the command does not return anything.
UO.InfoGumps
Without an argument, opens a list of active server windows, their indexes, GumpID, serial and sizes. Client interior windows are not included in this list. The form InfoGumps(gump) opens the detailed inspector of the specified window, like InfoGump(gump). The list reflects the status at the time of opening.
UO.IsGump
Checks if there is at least one active server gump.
UO.IsGumpCanBeClosed
Checks whether local right-click closing of server gump is allowed.
UO.LastGump
Reads one field of the selected server gump. Uses the window selected by this script or the last element of the current list.
UO.MenuHookPresent
Reads the presence of registered menu hooks.
UO.MenuPresent
MenuPresent directly calls WaitingMenu.
UO.NumGumpButton
Activates an existing server gump button based on the strict window index and exact ButtonID.
UO.NumGumpCheckBox
Sets the state of the flag in the server gump by index.
UO.NumGumpRadiobutton
Sets the state of a radio button in a server gump by index.
UO.ReqVirtuesGump
Requests a character's virtues window.
UO.SelectGump
Selects an existing server gump for subsequent calls.
UO.SendGumpSelect
Sends the ButtonID for the selected server gump.
UO.SetGump
Changes the field of an existing server gump.
UO.WaitGump
Registers a sequence of one-time responses to buttons. The script continues running immediately; the absence of a window does not cause a 30-second delay.
UO.WaitGumpCheck
Changes up to three checkbox fields of the current gump.
UO.WaitGumpEntry
Changes up to three textentry fields of the current gump.
UO.WaitingForMenu
The required number of server menu appearances is limited.
UO.WaitingMenu
Reads _world.ServerMenus.Snapshot().Length != 0.
UO.WaitMenu
Registers up to three one-time menu hooks.