Palanthir Object Reference
OBJECT DESCRIPTION Properties: OBJECT METHODS addcheckbox(x, y, trueid, falseid, checked, returnnumber, page) - x X position of the button. - y Y position of the button. - trueid - falseid - checked - returnnumber - page Return Value: A gumpobject object. Description: This method creates a checkbox, adds it to the gump and returns it. Back to top addcheckertrans(x, y, width, height, page) - x X position of the button. - y Y position of the button. - width - height - page Return Value: A gumpobject object. Description: This method creates a checkertrans, adds it to the gump and returns it. Back to top addcroppedtext(x, y, width, height, text, font, hue, page, maxlines, border, divheightmod) - x X position of the button. - y Y position of the button. - width - height - text - font Font id of the text. - hue - page - maxlines Maximum lines that are shown. (optional, default = 1) - border Determines whether the characters have a black one-pixel border or not. (optional, default = 1) - divheightmod Changes the differenz between 2 lines of text by the given number of pixels. (optional, default = 0) Return Value: A gumpobject object. Description: This method creates some cropped text, adds it to the gump and returns it. Back to top addextimage(x, y, width, height, url, page) - x X position of the button. - y Y position of the button. - width - height - url - page Return Value: A gumpobject object. Description: This method creates a addextimage gumpobject, adds it to the gump and returns it. Back to top addgumpitem(x, y, serial, pos, page) - x X position of the image. - y Y position of the image. - serial - pos Position in the drawlist of the gump, where this objects is inserted. - page Return Value: A gumpobject object. Description: This method creates a gumpitem, adds it to the gump and returns it. This is mainly used for the paperdoll. Back to top addhtmlgump(x, y, width, height, text, hasback, canscroll, page) - x X position of the button. - y Y position of the button. - width - height - text - hasback - canscroll - page Return Value: A gumpobject object. Description: This method creates a htmlgump, adds it to the gump and returns it. Back to top addhuebutton(x, y, width, height, red, green, blue, returnnumber, page) - x X position of the button. - y Y position of the button. - width - height - red - green - blue - returnnumber - page Return Value: A gumpobject object. Description: This method creates a huebutton gumpobject, adds it to the gump and returns it. Back to top addimage(x, y, id, hue, page, width, height, keepproportions) - x X position of the button. - y Y position of the button. - id - hue - page - width (optional) - height (optional) - keepproportions (optional) Return Value: A gumpobject object. Description: This method creates an image, adds it to the gump and returns it. Back to top addinputfield(x, y, width, height, text, font, textid, hue, page, allowonlynumbers, stars, allowmultilines) - x X position of the button. - y Y position of the button. - width - height - text - font Font id of the text. - textid Id to identify this inputfield. - hue - page - allowonlynumbers (optional, default = 0) - stars Show stars instead of the real characters. (optional, default = 0) - allowmultilines (optional, default = 0) Return Value: A gumpobject object. Description: This method creates an inputfield, adds it to the gump and returns it. Back to top addlandtilepic(x, y, id, hue, page) - x X position of the button. - y Y position of the button. - id Id of map art tile. - hue - page Return Value: A gumpobject object. Description: This method creates an land tile image (map art), adds it to the gump and returns it. Back to top addpagebutton(x, y, upid, downid, pageid, page) - x X position of the button. - y Y position of the button. - upid - downid - pageid Id of the target page. - page Return Value: A gumpobject object. Description: This method creates a pagebutton, adds it to the gump and returns it. Back to top addprogressbar(x, y, width, height, current, max, backlefthue, backrighthue, lefthue, righthue, text, align, textcolor, horizontal, page) - x X position of the button. - y Y position of the button. - width - height - current - max - backlefthue - backrighthue - lefthue - righthue - text - align Either "RIGHT", "LEFT" or "CENTER" as string. - textcolor - horizontal - page Return Value: A gumpobject object. Description: This method creates a addprogressbar gumpobject, adds it to the gump and returns it. Back to top addradiobutton(x, y, trueid, falseid, checked, returnnumber, group, page) - x X position of the button. - y Y position of the button. - trueid - falseid - checked - returnnumber - group - page Return Value: A gumpobject object. Description: This method creates a radiobutton, adds it to the gump and returns it. Back to top addresizegump(x, y, width, height, id, hue, page, onlyborder) - x X position of the button. - y Y position of the button. - width - height - id - hue - page - onlyborder If 1, then only the borders are drawn. (optional) Return Value: A gumpobject object. Description: This method creates a resizegump (background), adds it to the gump and returns it. Back to top addscrollbar(x, y, horizontal, length, upid, moveoverid, number, page) - x X position of the button. - y Y position of the button. - horizontal - length - upid - moveoverid - number - page Return Value: A gumpobject object. Description: This method creates a scrollbar gumpobject, adds it to the gump and returns it. Back to top addstaticitem(x, y, serial, page) - x X position of the button. - y Y position of the button. - serial - page Return Value: A gumpobject object. Description: This method creates a staticitem gumpobject, adds it to the gump and returns it. This is used for example for containers and secure trading gumps. Back to top addtext(x, y, text, font, hue, page, border) - x X position of the button. - y Y position of the button. - text - font Font id of the text. - hue - page - border Determines whether the characters have a black one-pixel border or not. (optional, default=True) Return Value: A gumpobject object. Description: This method creates some text, adds it to the gump and returns it. Back to top addtextbutton(x, y, returnnumber, text, font, page, width, uphue, downhue, moveoverhue, backgroundupid, backgrounddownid, backgroundmoveoverid, backgrounduphue, backgrounddownhue, backgroundmoveoverhue, height, ispagebutton, pageid, border) - x X position of the button. - y Y position of the button. - returnnumber - text - font Font id of the text. - page - width - uphue (optional) - downhue (optional) - moveoverhue (optional) - backgroundupid (optional) - backgrounddownid (optional) - backgroundmoveoverid (optional) - backgrounduphue (optional) - backgrounddownhue (optional) - backgroundmoveoverhue (optional) - height (optional) - ispagebutton Set to 1 to use this textbutton as pagebutton. (optional) - pageid If this button is used as pagebutton, then its the target page. Otherwise its useless. (optional) - border Determines whether the characters have a black one-pixel border or not. (optional) Return Value: A gumpobject object. Description: This method creates a textbutton, adds it to the gump and returns it. Back to top addtiledimage(x, y, width, height, id, hue, page) - x X position of the button. - y Y position of the button. - width - height - id - hue - page Return Value: A gumpobject object. Description: This method creates an tiled image, adds it to the gump and returns it. Back to top addtilepic(x, y, id, hue, page) - x X position of the button. - y Y position of the button. - id Id of static art tile. - hue - page Return Value: A gumpobject object. Description: This method creates an tile image (static art), adds it to the gump and returns it. Back to top addtooltip(x, y, width, height, text, page) - x X position of the button. - y Y position of the button. - width - height - text - page Return Value: A gumpobject object. Description: This method creates a tooltip gumpobject, adds it to the gump and returns it. This is just an rectangle, where a tooltip is shown when the mouse stays over it for more than 1 second. It always overrides all existing tooltips of non tooltip gumpobjects at its position. Back to top addtransparendgumpitem(x, y, id, hue, layer, pos, page) - x X position of the image. - y Y position of the image. - id - hue - layer - pos Position in the drawlist of the gump, where this objects is inserted. - page Return Value: A gumpobject object. Description: This method creates a semitransparend gumpitem, adds it to the gump and returns it. This is mainly used for the paperdoll. Back to top addxmfhtmlgump(x, y, width, height, clilocid, hasback, canscroll, page, hue) - x X position of the button. - y Y position of the button. - width - height - clilocid Id of the text in the clilocfile. - hasback - canscroll - page - hue (optional) Return Value: A gumpobject object. Description: This method creates an xmfhtmlgump, adds it to the gump and returns it. Back to top delete() Description: Deletes the gump. Back to top deleteobject(gumpobject) - gumpobject A gumpobject object. Description: Deletes the gumpobject. Only works if the gumpobject is assosiated with this gump. Back to top getbutton(returnnumber) - returnnumber Return Value: A button object. Description: Returns the button with the given returnnumber. Back to top getinputfieldtext(returnnumber) - returnnumber Description: Returns the text of the inputfield with the given returnnumber. Back to top getobject(index) - index Index of the gumpobject. Return Value: Gumpobject A gumpobject object. Description: Returns the gumpobject of this gump with the given index. Back to top getobjectcount() Return Value: int Description: Returns the number of gumpobject this gump contains. Back to top getradiobutton(groupid) - groupid Description: Returns the text of the inputfield with the given returnnumber. Back to top setboundingbox(x, y, width, height) - x - y - width - height Description: Sets the bounding box of the gump. The bounding box has to be enabled by Gump.enableboundingbox. Back to top show() Description: Adds the gump to the internal drawlist. Back to top OBJECT PROPERTIES activepage Description: The page of the gump that is drawn at the moment. Back to top customvars Description: A dictionary to save variables on the gump. (see cv) Back to top cv Description: A dictionary to save variables on the gump. (see customvars) Back to top enableboundingbox Description: Indicates if the boundingbox is used. Back to top globalalpha Description: Alpha value that is used for the whole gump. Back to top internalid Description: Internal id of the gump. (readonly) Back to top noautoclose Description: Indicates whether the gump will be closed after a click on any button. Back to top noclose Description: Indicates whether the client is allowed to close the gump or not. Back to top nodispose Description: Indicates whether the gump is disposable or not. Back to top nomove Description: Indicates whether the gump is movable or not. Back to top onafterdrawgump Description: The function that is triggered for all gumps each time after all gumps are drawn. The function should have the following prototype: def onafterdrawgump( gump ): Although you can choose any name you want. Gump is this gump object. Gumpobject is the selected gumpobject object. Return 1 to stop the core to handle this event. Back to top onbeforedrawgump Description: The function that is triggered for all gumps each time before all gumps are drawn. The function should have the following prototype: def onbeforedrawgump( gump ): Although you can choose any name you want. Gump is this gump object. Gumpobject is the selected gumpobject object. Return 1 if you dont want the gump to be drawn. Back to top onbuttonclick Description: The function that is triggered when a button is clicked. The function should have the following prototype: def onbuttonclick( gump, returnnumber ): Although you can choose any name you want. Gump is the gump object you clicked on and returnnumber the returnnumber of the button used. Return 1 to stop the core to handle this click. Back to top oncheckboxchange Description: The function that is triggered when a checkbox is changed. The function should have the following prototype: def oncheckboxchange( gump, gumpobject ): Although you can choose any name you want. Gump is this gump object. Gumpobject is the checkbox object that changed. Return 1 to stop the core to handle this event. Back to top onclickxy Description: The function that is triggered when a button is clicked. The function should have the following prototype: def onclickxy( gump, x, y ): Although you can choose any name you want. Gump is this gump object. X, Y are the coordinates of the clickpoint relativ to the origin of the gump. Return 1 to stop the core to handle this click. Back to top ondblclick Description: The function that is triggered when a gump is dblclicked. The function should have the following prototype: def ondblclick( gump, gumpobject ): Although you can choose any name you want. Gump is this gump object. Gumpobject is the gumpobject object you dblclicked on. Return 1 to stop the core to handle this dblclick. Back to top ondblclickxy Description: The function that is triggered when a gump is dblclicked. The function should have the following prototype: def onbuttonclickxy( gump, x, y ): Although you can choose any name you want. Gump is this gump object. X, Y are the coordinates of the dblclickpoint relativ to the origin of the gump. Return 1 to stop the core to handle this dblclick. Back to top ondelete Description: The function that is triggered before the gump is deleted. The function should have the following prototype: def ondelete( gump ): Although you can choose any name you want. Gump is this gump object. Gumpobject is the selected gumpobject object. Return 1 to stop the core to handle this event. Back to top ondrawgump Description: The function that is triggered each time directly before the gump is drawn. The function should have the following prototype: def ondrawgump( gump ): Although you can choose any name you want. Return 1 if you dont want the gump to be drawn. Back to top oninputfieldchange Description: The function that is triggered when an inputfield changes. The function should have the following prototype: def oninputfieldchange( gump, inputfield ): Although you can choose any name you want. Gump is this gump object. Inputfield is the inputfield object that changes. Back to top onkeyreturn Description: The function that is triggered when return is pressed and a gump is selected. The function should have the following prototype: def onkeyreturn( gump, gumpobject ): Although you can choose any name you want. Gump is this gump object. Gumpobject is the selected gumpobject object. Return 1 to stop the core to handle this event. Back to top onkeytab Description: The function that is triggered when tab is pressed and a gump is selected. The function should have the following prototype: def onkeytab( gump, gumpobject ): Although you can choose any name you want. Gump is this gump object. Gumpobject is the selected gumpobject object. Return 1 to stop the core to handle this event. Back to top onmousedown Description: The function that is triggered when the left mousebutton goes down. The function should have the following prototype: def onmousedown( gump, gumpobject ): Although you can choose any name you want. Gump is this gump object. Gumpobject is the selected gumpobject object. Return 1 to stop the core to handle this event. Back to top onmouseup Description: The function that is triggered when the left mousebutton goes up. The function should have the following prototype: def onmouseup( gump, gumpobject ): Although you can choose any name you want. Gump is this gump object. Gumpobject is the selected gumpobject object. Return 1 to stop the core to handle this event. Back to top onmovegump Description: The function that is triggered when the gump is moved around. The function should have the following prototype: def onmovegump( gump, gumpobject ): Although you can choose any name you want. Gump is this gump object. Gumpobject is the selected gumpobject object. Return 1 to stop the core to handle this event. Back to top onmoveoverbutton Description: The function that is triggered when the cursor moves over a button. The function should have the following prototype: def onmoveoverbutton( gump, returnnumber ): Although you can choose any name you want. Gump is this gump object. Returnnumber is the returnnumber of the button. Return 1 to stop the core to handle this event. Back to top onscrollbarchange Description: The function that is triggered when a scrollbar is changed. The function should have the following prototype: def onscrollbarchange( gump, gumpobject ): Although you can choose any name you want. Gump is this gump object. Gumpobject is the scrollbar object that changed. Return 1 to stop the core to handle this event. Back to top onscrollbarrelease Description: The function that is triggered when a scrollbar is released. The function should have the following prototype: def onscrollbarrelease( gump, inputfield ): Although you can choose any name you want. Gump is this gump object. Scrollbar is the scrollbar object that is released. Back to top x Description: X position of the gump. Back to top y Description: Y position of the gump. Back to top |
Back to the Object Overview Back to the Palanthir Reference |