View source for GUI Classes/CheckBox:Create

<pageclass class="client" subcaption="GUI Class method"></pageclass>
__NOTOC__ 
This function creates a [[Element/GUI/Checkbox|CheckBox]] object.

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

===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 text field next to the checkbox. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the text field next to 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.

===Optional Arguments=== 
{{OptionalArg}} 
*'''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. Default value is '''false'''
*'''parent:''' This is the parent that the checkbox is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

===Returns===
*'''checkboxObject''' if it was created succesfully 
*'''false''' otherwise. 

==Example== 
<!-- Explain what the example is in a single sentance -->
This example does...
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">

</syntaxhighlight>

==See Also==
[[GUI_Classes|Back to GUI Classes page]]
{{GUI_Classes_allfunctions}}