Gumps
The Gumps class is used to read and interact with in-game gumps, via scripting.
NOTE
----
During development of scripts that involves interecting with Gumps, is often needed to know gumpids and buttonids.
For this purpose, can be particularly usefull to use *Inspect Gumps* and *Record*, top right, in the internal RE script editor.
TODO: Gumps Constructors
Methods
Gumps
.
AddAlphaRegion
(
gd
,
x
,
y
,
width
,
height
)
Gumps
.
AddAlphaRegion
(
gd
,
x
,
y
,
width
,
height
)
Gumps
.
AddBackground
(
gd
,
x
,
y
,
width
,
height
,
gumpID
)
Gumps
.
AddBackground
(
gd
,
x
,
y
,
width
,
height
,
gumpID
)
Gumps
.
AddButton
(
gd
,
x
,
y
,
normalID
,
pressedID
,
buttonID
,
type
,
param
)
Gumps
.
AddButton
(
gd
,
x
,
y
,
normalID
,
pressedID
,
buttonID
,
type
,
param
)
Gumps
.
AddCheck
(
gd
,
x
,
y
,
inactiveID
,
activeID
,
initialState
,
switchID
)
Gumps
.
AddCheck
(
gd
,
x
,
y
,
inactiveID
,
activeID
,
initialState
,
switchID
)
Gumps
.
AddGroup
(
gd
,
group
)
Gumps
.
AddGroup
(
gd
,
group
)
Gumps
.
AddHtml
(
gd
,
x
,
y
,
width
,
height
,
text
,
background
,
scrollbar
)
Gumps
.
AddHtml
(
gd
,
x
,
y
,
width
,
height
,
text
,
background
,
scrollbar
)
Gumps
.
AddHtmlLocalized
(
gd
,
x
,
y
,
width
,
height
,
number
,
args
,
color
,
background
,
scrollbar
)
Gumps
.
AddHtmlLocalized
(
gd
,
x
,
y
,
width
,
height
,
number
,
args
,
color
,
background
,
scrollbar
)
Gumps
.
AddImage
(
gd
,
x
,
y
,
gumpID
,
hue
)
Gumps
.
AddImage
(
gd
,
x
,
y
,
gumpID
,
hue
)
Gumps
.
AddImageTiled
(
gd
,
x
,
y
,
width
,
height
,
gumpID
)
Gumps
.
AddImageTiled
(
gd
,
x
,
y
,
width
,
height
,
gumpID
)
Gumps
.
AddImageTiledButton
(
gd
,
x
,
y
,
normalID
,
pressedID
,
buttonID
,
type
,
param
,
itemID
,
hue
,
width
,
height
,
localizedTooltip
)
Gumps
.
AddImageTiledButton
(
gd
,
x
,
y
,
normalID
,
pressedID
,
buttonID
,
type
,
param
,
itemID
,
hue
,
width
,
height
,
localizedTooltip
)
Gumps
.
AddItem
(
gd
,
x
,
y
,
itemID
,
hue
)
Gumps
.
AddItem
(
gd
,
x
,
y
,
itemID
,
hue
)
Gumps
.
AddLabel
(
gd
,
x
,
y
,
hue
,
text
)
Gumps
.
AddLabel
(
gd
,
x
,
y
,
hue
,
text
)
Gumps
.
AddLabelCropped
(
gd
,
x
,
y
,
width
,
height
,
hue
,
text
)
Gumps
.
AddLabelCropped
(
gd
,
x
,
y
,
width
,
height
,
hue
,
text
)
Gumps
.
AddRadio
(
gd
,
x
,
y
,
inactiveID
,
activeID
,
initialState
,
switchID
)
Gumps
.
AddRadio
(
gd
,
x
,
y
,
inactiveID
,
activeID
,
initialState
,
switchID
)
Gumps
.
AddSpriteImage
(
gd
,
x
,
y
,
gumpID
,
width
,
height
,
sx
,
sy
)
Gumps
.
AddSpriteImage
(
gd
,
x
,
y
,
gumpID
,
width
,
height
,
sx
,
sy
)
Gumps
.
AddTextEntry
(
gd
,
x
,
y
,
width
,
height
,
hue
,
entryID
,
initialText
)
Gumps
.
AddTextEntry
(
gd
,
x
,
y
,
width
,
height
,
hue
,
entryID
,
initialText
)
Gumps
.
AddTooltip
(
gd
,
number
)
Gumps
.
AddTooltip
(
gd
,
number
)
Close a specific Gump.
Parameters
gumpid
UInt32
ID of the gump
Gumps
.
CreateGump
(
movable
,
closable
,
disposable
,
resizeable
)
Gumps
.
CreateGump
(
movable
,
closable
,
disposable
,
resizeable
)
Creates an initialized GumpData structure
Parameters
movable
Boolean
allow the gump to be moved
closable
Boolean
allow the gump to be right clicked to close
disposable
Boolean
allow the gump to be disposed (beats me what it does)
resizeable
Boolean
allow the gump to be resized
Return the ID of most recent, still open Gump.
Gumps
.
GetGumpData
(
gumpid
)
Gumps
.
GetGumpData
(
gumpid
)
Get status if have a gump open or not.
Return
Boolean
True: There is a Gump open - False: otherwise.
Gumps
.
LastGumpGetLine
(
line_num
)
Gumps
.
LastGumpGetLine
(
line_num
)
Get a specific line from the most recent and still open Gump. Filter by line number.
Parameters
line_num
Int32
Number of the line.
Return
String
Text content of the line. (empty: line not found)
Gumps
.
LastGumpGetLineList
()
Gumps
.
LastGumpGetLineList
()
Get all text from the most recent and still open Gump.
Return
List[String]
Text of the gump.
Get the Raw Data of the most recent and still open Gump.
Return
String
Raw Data of the gump.
Get the Raw Text of the most recent and still open Gump.
Return
List[String]
List of Raw Text.
Gumps
.
LastGumpTextExist
(
text
)
Gumps
.
LastGumpTextExist
(
text
)
Search for text inside the most recent and still open Gump.
Parameters
text
String
Text to search.
Return
Boolean
True: Text found in active Gump - False: otherwise
Gumps
.
LastGumpTextExistByLine
(
line_num
,
text
)
Gumps
.
LastGumpTextExistByLine
(
line_num
,
text
)
Search for text, in a spacific line of the most recent and still open Gump.
Parameters
line_num
Int32
Number of the line.
text
String
Text to search.
Get the list of Gump Tile (! this documentation is a stub !)
Return
List[Int32]
List of Gump Tile.
Clean current status of Gumps.
Gumps
.
SendAction
(
gumpid
,
buttonid
)
Gumps
.
SendAction
(
gumpid
,
buttonid
)
Send a Gump response by gumpid and buttonid.
Parameters
gumpid
UInt32
ID of the gump.
buttonid
Int32
ID of the Button to press.
Gumps
.
SendAdvancedAction
(
gumpid
,
buttonid
,
switchlist_id
,
textlist_id
,
textlist_str
)
Gumps
.
SendAdvancedAction
(
gumpid
,
buttonid
,
switchlist_id
,
textlist_id
,
textlist_str
)
Parameters
textlist_id
List[Int32]
List[String]
Gumps
.
SendGump
(
gumpid
,
serial
,
x
,
y
,
gumpDefinition
,
gumpStrings
)
Gumps
.
SendGump
(
gumpid
,
serial
,
x
,
y
,
gumpDefinition
,
gumpStrings
)
Sends a gump using an existing GumpData structure
Parameters
gumpid
Gumps.GumpData
UInt32
Gumps
.
WaitForGump
(
gumpid
,
delay
)
Gumps
.
WaitForGump
(
gumpid
,
delay
)
Waits for a specific Gump to appear, for a maximum amount of time. If gumpid is 0 it will match any Gump.
Parameters
gumpid
UInt32
ID of the gump. (0: any)
delay
Int32
Maximum wait, in milliseconds.