User Tools

Site Tools


gump_funcs

Scripting - Gumps data and function

Here can find some information about Enhanced Scripting function and data for gump operation!

Gump Status

Get Current Gumps
Syntax Gumps.CurrentGump( )
Description:
Return a integer whit ID of last gump opened and still open.
Returns uint
In Object: Gumps
Parameters: none
Check Gump Open
Syntax Gumps.HasGump( )
Description:
Get status if have a gump open or not
Returns bool
In Object: Gumps
Parameters: none
Close Gump
Syntax Gumps.CloseGump(uint)
Description:
Close a specific Gump.
Returns void
In Object: Gumps
Parameters: GumpID
Reset Gump
Syntax Gumps.ResetGump()
Description:
Clean current status of gumps.
Returns void
In Object: Gumps
Parameters: none
Wait gump
Syntax WaitForGump(gumpid, timeout)
Description:
Description: Waits for a gump to appear with id specified in gumpid. If gumpid is 0 it will wait for any gump id
Returns void
In Object: In Object: Gumps
Parameters: gumpid, timeout - in ms

Gump Response

Send Response
Syntax Gumps.SendAction(uint, int)
Description:
Send a gump response by gump id and button id
Returns void
In Object: Gumps
Parameters: ButtonID
Send Advanced Response Switch Only
Syntax Gumps.SendAdvancedAction(uint, int, list(int))
Description:
Send a gump response by gump id and button id and advanced switch in gumps. You can add a switch list whit all parameters need setted in gump windows.
Returns void
In Object: Gumps
Parameters: Switchs
Send Advanced Response Switch and Text
Syntax Gumps.SendAdvancedAction(uint, int, list(int), list(int), list(string))
Description:
Send a gump response by gump id and button id and advanced switch and text in gumps. You can add a switch list whit all parameters need be setted in gump windows, also can send text need to be filled in gump
Returns void
In Object: Gumps
Parameters: text

Gump Data

Get Text Line
Syntax Gumps.LastGumpGetLine(int)
Description:
Get the text string in gump by line number, Gump must be still open for get data
Returns string
In Object: Gumps
Parameters: LineNumber
Get All Text
Syntax Gumps.LastGumpGetLineList( )
Description:
Get all text string in gump, Gump must be still open for get data
Returns list] string
In Object: Gumps
Parameters: None
Search Text in Gump
Syntax Gumps.LastGumpTextExist(string)
Description:
Search text string inside a gump text, return bool if found or not, Gump must be still open for get data
Returns bool
In Object: Gumps
Parameters: TextToSearch
Search Text in Gump by Line
Syntax Gumps.LastGumpTextExistByLine(int, string)
Description:
Search text string inside a gump text by line, return bool if found or not, Gump must be still open for get data
Returns bool
In Object: Gumps
Parameters: TextToSearch
Get Last gump raw data
Syntax Gumps.LastGumpRawData( )
Description:
Get the raw data of last gump opened.
Returns string
In Object: Gumps
Parameters: none

gump_funcs.txt · Last modified: 2020/08/23 15:28 (external edit)