GuiCreateCheckBox: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(moved to talk)
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__
This function creates a checkbox.
{{Client function}}
This function creates a [[Element/GUI/Checkbox|checkbox]].


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element guiCreateCheckBox ( float x, float y, float width, float height, string text, bool selected, bool relative, parent element )
element guiCreateCheckBox ( float x, float y, float width, float height, string text, bool selected, bool relative, [element parent = nil] )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''argumentName:''' description
*'''x:''' A float of the 2D x position of the checkbox on a player's screen. This is affected by the relative argument.
*'''y:''' A float of the 2D y position of the checkbox on a player's screen. This is affected by the relative argument.
*'''width:''' A float of the width of the checkbox. This is affected by the relative argument.
*'''height:''' A float of the height of the checkbox. This is affected by the relative argument.
*'''text:''' The text to be displayed next to the checkbox.
*'''selected:''' A boolean representing whether the checkbox created should be selected by default.
*'''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 measures relative to the parent.


===Optional Arguments===  
===Optional Arguments===  
{{OptionalArg}}  
{{OptionalArg}}  
*'''argumentName2:''' description
*'''parent:''' This is the parent that the image is attached to. The relative argument must be true to use this. Sizes and positioning will be made relative to this parent. If nil parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
*'''argumentName3:''' description


===Returns===
===Returns===
Returns ''true'' if blah, ''false'' otherwise.
Returns [[element]] of the checkbox if it was created succesfully, ''false'' otherwise.  


==Example==  
==Example==  
Line 31: Line 37:
==See Also==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
[[Category:Incomplete]]
[[Category:Needs Example]]

Revision as of 15:26, 18 March 2008

This function creates a checkbox.

Syntax

element guiCreateCheckBox ( float x, float y, float width, float height, string text, bool selected, bool relative, [element parent = nil] )

Required Arguments

  • x: A float of the 2D x position of the checkbox on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the checkbox on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the checkbox. This is affected by the relative argument.
  • height: A float of the height of the checkbox. This is affected by the relative argument.
  • text: The text to be displayed next to the checkbox.
  • selected: A boolean representing whether the checkbox created should be selected by default.
  • 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 measures 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 image is attached to. The relative argument must be true to use this. Sizes and positioning will be made relative to this parent. If nil parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

Returns

Returns element of the checkbox if it was created succesfully, false otherwise.

Example

This example does... 

--This line does...
blabhalbalhb --abababa
--This line does this...
mooo

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/GuiCreateCheckBox?oldid=16215"