GuiCreateButton: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 18: Line 18:
===Optional Arguments===  
===Optional Arguments===  
{{OptionalArg}}  
{{OptionalArg}}  
*'''parent:''' This is the parent that the gui button is attached to.  Sizes and positioning will be made relative to this parent.  If no parent is passed, the parent will become the screen - causing relative positioning and sizing according to screen positioning.
*'''parent:''' This is the parent that the gui button is attached to.  The ''relative'' argument must be true to use this.  Sizes and positioning will be made relative to this parent.  If no parent is passed, the parent will become the screen - causing relative positioning and sizing according to screen positioning.
*'''callbackOnClick :''' This is a function representing the function that will be called when clicking this GUI Button.  This is optional, and the [[onClientClick]] event can be used as an alternative.
*'''callbackOnClick :''' This is a function representing the function that will be called when clicking this GUI Button.  This is optional, and the [[onClientClick]] event can be used as an alternative.


Revision as of 13:21, 1 August 2007

This function allows creation of a GUI Button, which is a clickable item as part of GUI.

Syntax

element guiCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil, function callbackOnClick ] )

Required Arguments

  • x: A float of the 2D x position of the GUI button on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the GUI button on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the GUI button. This is affected by the relative argument.
  • height: A float of the height of the GUI button. This is affected by the relative argument.
  • text: A string of the text that will be displayed as a label on the button.
  • relative: This is whether sizes and positioning are relative. If this is true, then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • parent: This is the parent that the gui button is attached to. The relative argument must be true to use this. Sizes and positioning will be made relative to this parent. If no parent is passed, the parent will become the screen - causing relative positioning and sizing according to screen positioning.
  • callbackOnClick : This is a function representing the function that will be called when clicking this GUI Button. This is optional, and the onClientClick event can be used as an alternative.

Returns

Returns an element of the created button if it was successfully created, false otherwise.

Example

This example creates an edit box alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the Chat Box. 

--setup our function to output the message to the chatbox
function outputEditBox ()
	local text = guiGetText ( editBox )--get the text from the edit box
	outputChatBox ( text ) --output that text
end

--create our button and attach it to the outputEditBox function
guiCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true, nil, outputEditBox )
--Create an edit box and define it as "editBox".
editBox = guiCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

Retrieved from "https://wiki.multitheftauto.com/wiki/GuiCreateButton?oldid=9531"