|
|
Wolfpack Library Reference
|
MODULE DESCRIPTION MODULE FUNCTIONS wolfpack.gumps.cGump.addBackground(id, width, height)- id The artwork id of the background. - width The width of the background. - height The height of the background. Return Value: None Description: Adds a background to the gump. Back to top wolfpack.gumps.cGump.addButton(x, y, upid, downid, returncode)- x The x alignment of the button. - y The y alignment of the button. - upid The artwork id used when the button is not pressed. - downid The artwork id used when the button is being pressed. - returncode The return code passed to the callback if the button is pressed. Return Value: None Description: Adds a button to the gump. Back to top wolfpack.gumps.cGump.addCheckbox(x, y, off, on, id, checked)- x - y - off - on - id - checked Defaults to 0 or False. Return Value: None Description: Adds a checkbox to the gump. Back to top wolfpack.gumps.cGump.addCheckerTrans(x, y, width, height)- x - y - width - height Return Value: None Description: Adds a commonly used checkered transparency effect to the gump. Back to top wolfpack.gumps.cGump.addCroppedText(x, y, width, height, text, hue)- x The x alignment of the text. - y The y alignment of the text. - width The weidth limit to crop the text to, in pixels. - height The height limit to crop the text to, in pixels. - text The text string to be added. - hue The hue of the text. Return Value: None Description: Adds cropped text to the gump. Back to top wolfpack.gumps.cGump.addGump(x, y, id, hue)- x The x alignment of the gump. - y The y alignment of the gump. - id The artwork id of the gump. - hue The optional hue to apply to the gump artwork, defaults to 0x0. Return Value: None Description: Adds a gump object to the gump. Back to top wolfpack.gumps.cGump.addHtmlGump(x, y, width, height, html, hasBack, canScroll)- x - y - width - height - html - hasBack Defaults to 0 or False. - canScroll Defaults to 0 or False. Return Value: None Description: Adds an HTML text field to the gump. Back to top wolfpack.gumps.cGump.addInputField(x, y, width, height, hue, id, starttext)- x - y - width - height - hue - id - starttext Return Value: None Description: Adds an input field to the gump. Back to top wolfpack.gumps.cGump.addPageButton(x, y, upid, downid, page)- x The x alignment of the button. - y The y alignment of the button. - upid The artwork id used when the button is not pressed. - downid The artwork id used when the button is being pressed. - page The page to turn to. Return Value: None Description: Adds a page button to the gump. Back to top wolfpack.gumps.cGump.addRadioButton(x, y, off, on, id, selected)- x - y - off - on - id - selected Defaults to 0 or False. Return Value: None Description: Adds a readio button to the gump. Back to top wolfpack.gumps.cGump.addRawLayout(data)- data Unknown Return Value: None Description: Unknown Back to top wolfpack.gumps.cGump.addRawText(data)- data Unknown Return Value: None Description: Unknown Back to top wolfpack.gumps.cGump.addResizeGump(x, y, id, width, height)- x The starting x coordinate of the gump. - y The starting y coordinate of the gump. - id The artwork id used for the gump. - width The width of the gump. - height The height of the gump. Return Value: None Description: Resizes a gump to the given coordinates. Back to top wolfpack.gumps.cGump.addText(x, y, text, hue)- x The x value of the text alignment. - y The y value of the text alignment. - text The string value to append to the gump. - hue The hue of the text, defaults to 0x0. Return Value: None Description: Appends text to the gump. Back to top wolfpack.gumps.cGump.addTilePic(x, y, id)- x The x alignment of the gump object. - y The y alignment of the gump object. - id The artwork id to be used. Return Value: None Description: Adds an object's artwork id to the gump. Back to top wolfpack.gumps.cGump.addTiledGump(x, y, width, height, id, hue)- x The x alignement of the gump. - y The y alignment of the gump. - width The width of the gump. - height The height of the gump. - id The artwork id to be tiled. - hue The optional hue to apply to the gump artwork, defaults to 0x0. Return Value: None Description: Adds a tiled gump object. Back to top wolfpack.gumps.cGump.addTooltip(id)- id The cliloc id of the tooltip to be added. Return Value: None Description: Appends a tooltip cliloc id to the gump. Back to top wolfpack.gumps.cGump.addXmfHtmlGump(x, y, width, height, clilocid, hasBack, canScroll, color)- x - y - width - height - clilocid - hasBack Defaults to 0 or False. - canScroll Defaults to 0 or False. - color Defaults to 0x0. Return Value: None Description: Unknown Back to top wolfpack.gumps.cGump.copy(gump)- gump This is the gump which is to be copied. Return Value: Returns a copy of the gump. Description: Takes a gump and returns a copy. Back to top wolfpack.gumps.cGump.dummyCallback(player, args, choice)- player - args - choice Return Value: None Description: A dummy callback. Back to top wolfpack.gumps.cGump.send(char)- char The character to receive the gump. Return Value: None Description: Sends a gump to a character. Back to top wolfpack.gumps.cGump.setArgs(arguments)- arguments ListType of arguments. Return Value: None Description: Sets a list of arguments to the gump. Back to top wolfpack.gumps.cGump.setCallback(callback)- callback The callback function to pass the gump to. Return Value: None Description: Defines the callback function for the gump. Back to top wolfpack.gumps.cGump.setSerial(serialid)- serialid An unique serial id for the gump. Return Value: None. Description: Assigns a serial id to the gump, used to insure only one gump of this type is open at once. Back to top wolfpack.gumps.cGump.setType(typeid)- typeid An unique id for the gump. Return Value: None Description: Sets the gump-type id, used to close it later on. Back to top wolfpack.gumps.cGump.startGroup(groupid)- groupid The group id to start with. Return Value: None Description: Sets the starting group id of the gump. Back to top wolfpack.gumps.cGump.startPage(page)- page The page number to start on. Return Value: None Description: Sets the starting page of the gump. Back to top |
| Back to the Module Overview Back to the Wolfpack Reference |