A short compilation of available gump commands.
CmdName: |
NoClose |
Client introduced: |
- |
Description: |
Prevents that the gump can be closed by right clicking. |
|
CmdName: |
NoDispose |
Client introduced: |
- |
Description: |
Prevents that the gump can be closed by hitting Esc. Be carefull if you allow it, there may occur problems. |
|
CmdName: |
NoMove |
Client introduced: |
- |
Description: |
Locks the gump in his position. Movement is not allowed. |
|
CmdName: |
Group [Number] |
Client introduced: |
- |
Description: |
Links radio buttons to a group. Add this before radiobuttons to do so. See also endgroup. |
|
CmdName: |
EndGroup |
Client introduced: |
between 4.0.4d and 5.0.0b |
Description: |
Ends the group-definition, only then group works on pages bigger than 1. |
|
CmdName: |
Page [Number] |
Client introduced: |
- |
Description: |
Specifies which page to define. Page 0 is the background thus always visible. |
|
CmdName: |
MasterGump [Number] |
Client introduced: |
between 4.0.4d and 5.0.0b |
Description: |
Overrides the GumpID send with the gumppacket. |
|
|
CmdName: |
Button [x] [y] [released-id] [pressed-id] [quit] [page-id] [return-value] |
Client introduced: |
- |
Description: |
Adds a button to the gump with the specified coordinates and button graphics.
[released-id] and [pressed-id] specify the buttongraphic. If pressed check for [return-value].
Use [page-id] to switch between pages and [quit]=1/0 to close the gump. |
|
CmdName: |
ButtonTileArt [x] [y] [released-id] [pressed-id] [quit] [page-id] [return-value] [tilepic-id] [hue] [tile-x] [tile-y] |
Client introduced: |
between 4.0.4d and 5.0.0b |
Description: |
Adds a button to the gump with the specified coordinates and tilepic as graphic.
[tile-x] and [tile-y] define the coordinates of the tile graphic and are relative to [x] and [y]. |
|
CmdName: |
CheckBox [x] [y] [released-id] [pressed-id] [status] [return-value] |
Client introduced: |
- |
Description: |
Adds a CheckBox to the gump. Multiple CheckBoxes can be pressed at the same time.
Check the [return-value] if you want to know which CheckBoxes were selected. |
|
CmdName: |
CheckerTrans [x] [y] [width] [height] |
Client introduced: |
- |
Description: |
Creates a transparent rectangle on position [x,y] using [width] and [height]. |
|
CmdName: |
CroppedText [x] [y] [width] [height] [color] [text-id] |
Client introduced: |
- |
Description: |
Adds a text field to the gump. This is similar to the text command, but the text is cropped to the defined area. |
|
CmdName: |
GumpPic [x] [y] [id] hue=[color] class=[class] |
Client introduced: |
- |
Description: |
Adds a graphic to the gump, where [id] is the graphic id of an item. For example use InsideUO to get them.
Optionaly there is a color parameter. The class parameter is also optional, triggers special behavior (e.g. "VirtueGump" will enable virtue tooltips). |
|
CmdName: |
GumpPicTiled [x] [y] [width] [height] [id] |
Client introduced: |
3.0.4p |
Description: |
Similar to GumpPic, but the gumppic is tiled to the given [height] and [width]. |
|
CmdName: |
HtmlGump [x] [y] [width] [height] [text-id] [background] [scrollbar] |
Client introduced: |
- |
Description: |
Defines a text-area where Html-commands are allowed. [background] and [scrollbar]
can be 0 or 1 and define whether the background is transparent and a scrollbar s displayed.
<B></B> <BIG></BIG> <SMALL></SMALL> <EM></EM> <I></I> <U></U>
<H1></H1> <H2></H2> <H3></H3>
<H4></H4> <H5></H5> <H6></H6>
<a href=""></a>
<div align="right"><div align="left"></DIV>
<left></left> <P>
<CENTER></CENTER> <BR></BR>
<BASEFONT color=#ffffff size=1-7></BASEFONT>
|
|
CmdName: |
Radio [x] [y] [released-id] [pressed-id] [status] [return-value] |
Client introduced: |
- |
Description: |
Same as Checkbox, but only one Radiobutton can be pressed at the same time, except they are per linked
via the 'Group' command. |
|
CmdName: |
ResizePic [x] [y] [gump-id] [width] [height] |
Client introduced: |
- |
Description: |
Similar to GumpPic but the pic is automatically resized to the given [width] and [height]. |
|
CmdName: |
Text [x] [y] [color] [text-id] |
Client introduced: |
- |
Description: |
Defines the position and color of a text (data) entry. |
|
CmdName: |
TextEntry [x] [y] [width] [height] [color] [return-value] [default-text-id] |
Client introduced: |
- |
Description: |
Defines an area where the [default-text-id] is displayed.
The player can modify this data. To get this data check the [return-value]. |
|
CmdName: |
TextEntryLimited [x] [y] [width] [height] [color] [return-value] [default-text-id] [textlen] |
Client introduced: |
between 4.0.4d and 5.0.0b |
Description: |
Similar to TextEntry but you can specify via [textlen] the maximum of characters the player can type in. |
|
CmdName: |
TilePic [x] [y] [id] |
Client introduced: |
- |
Description: |
Adds a Tilepicture to the gump. [id] defines the tile graphic-id. For example use InsideUO to get them. |
|
CmdName: |
TilePicHue [x] [y] [id] [hue] |
Client introduced: |
between 4.0.4d and 5.0.0b |
Description: |
Similar to the tilepic command, but with an additional hue parameter. |
|
CmdName: |
Tooltip [cliloc-nr] |
Client introduced: |
between 3.0.8q and 4.0.0c |
Description: |
Adds to the previous layoutarray entry a Tooltip with the in [cliloc-nr] defined CliLoc entry. |
|
CmdName: |
XmfHtmlGump [x] [y] [width] [height] [cliloc-nr] [background] [scrollbar] |
Client introduced: |
1.26.4b |
Description: |
Similar to the htmlgump command, but in place of the [text-id] a CliLoc entry is used. |
|
CmdName: |
XmfHtmlGumpColor [x] [y] [width] [height] [cliloc-nr] [background] [scrollbar] [color] |
Client introduced: |
3.0.4p |
Description: |
Similar to the xmfhtmlgump command, but additionally a [color] can be specified. |
|
CmdName: |
XmfHtmlTok [x] [y] [width] [height] [background] [scrollbar] [color] [cliloc-nr] @[arguments]@ |
Client introduced: |
5.0.1d |
Description: |
Similar to xmfhtmlgumpcolor command, but the parameter order is different and an additionally [argument] entry enclosed with @'s can be used.
With this you can specify texts that will be added to the CliLoc entry. |
|
Copyright ©2009 Turley |