GuiCreateCheckBox - Revision history

IManGaaX at 08:09, 30 October 2023

2023-10-30T08:09:20Z

← Older revision		Revision as of 08:09, 30 October 2023
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element guiCreateCheckBox ( float x, float y, float width, float height, string text, bool selected, [ bool relative = false, element parent = nil] )		element guiCreateCheckBox ( float x, float y, float width, float height, string text, bool selected, [ bool relative = false, gui-element parent = nil] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[Element/GUI/Checkbox\|GuiCheckBox]]}}		{{OOP\|\|[[Element/GUI/Checkbox\|GuiCheckBox]]}}

IManGaaX: relative is optional, normal value is false

2023-10-30T08:03:26Z

relative is optional, normal value is false

← Older revision		Revision as of 08:03, 30 October 2023
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element guiCreateCheckBox ( float x, float y, float width, float height, string text, bool selected, bool relative, [element parent = nil] )		element guiCreateCheckBox ( float x, float y, float width, float height, string text, bool selected, [ bool relative = false, element parent = nil] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[Element/GUI/Checkbox\|GuiCheckBox]]}}		{{OOP\|\|[[Element/GUI/Checkbox\|GuiCheckBox]]}}
Line 17:		Line 17:
	*'''text:''' The text to be displayed next to the checkbox.		*'''text:''' The text to be displayed next to the checkbox.
	*'''selected:''' A boolean representing whether the checkbox created should be selected by default.		*'''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}}
			*'''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.
	*'''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.		*'''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.

StrixG: OOP syntax

2018-11-07T20:36:04Z

OOP syntax

← Older revision		Revision as of 20:36, 7 November 2018
Line 6:		Line 6:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element guiCreateCheckBox ( float x, float y, float width, float height, string text, bool selected, bool relative, [element parent = nil] )		element guiCreateCheckBox ( float x, float y, float width, float height, string text, bool selected, bool relative, [element parent = nil] )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[Element/GUI/Checkbox\|GuiCheckBox]]}}

	===Required Arguments===		===Required Arguments===

LordHenry: /* See Also */

2018-05-20T13:59:30Z

Lordazamath: Removed from category "Needs example"

2010-07-10T05:55:59Z

Removed from category "Needs example"

← Older revision		Revision as of 05:55, 10 July 2010
Line 51:		Line 51:
	==See Also==		==See Also==
	{{GUI_functions}}		{{GUI_functions}}
	~~[[Category:Needs Example]]~~

Lordazamath: /* Example */ Instead of asking for an example, why not do it yourself?

2010-07-10T05:37:22Z

Example: Instead of asking for an example, why not do it yourself?

← Older revision		Revision as of 05:37, 10 July 2010
Line 27:		Line 27:
	==Example==		==Example==
	<!-- Explain what the example is in a single sentance -->		<!-- Explain what the example is in a single sentance -->
	This example ~~does...~~		This example creates a GUI window with a checked and an unchecked checkbox and adds a command to toggle their visibility
	<!-- 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 -->		<!-- 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 lang="lua">
	--~~This line does..~~.		function drawGUI()
	~~blabhalbalhb~~ --~~abababa~~		local guiWindow = guiCreateWindow(100,100,200,100,"Checkbox test area",false,false) -- create the container window
	--~~This line does this..~~.		local checkedBox = guiCreateCheckBox(20,30,150,20,"Checked checkbox",true,false,guiWindow) -- note the parameter after header, it will make the checkbox be checked
	~~Mooooooooo~~ -- ~~cow!~~		local uncheckedBox = guiCreateCheckBox(20,60,150,20,"Unchecked checkbox",false,false,guiWindow) -- not here though
			guiSetVisible(guiWindow,false) -- set it invisible just in case
			return guiWindow -- we return the guiWindow
			end
			function cmdGUI(cmd)
			if not checkBoxWindow then -- if it hasn't been declared yet
			checkBoxWindow = drawGUI() -- we draw the gui window
			guiSetVisible(checkBoxWindow,true) -- we set it visible again. Strictly speaking it's not necessary, could have omitted both this and the upper guiSetVisible, but this is needed if you want to cache a window without actually showing it
			else -- if we actually have run this function before and declared checkBoxWindow
			guiSetVisible(checkBoxWindow, not guiGetVisible(checkBoxWindow)) -- we just toggle the visibility. If it was visible, not visible returns false and thus sets it's visibility false, effectivly hiding it
			end
			showCursor(not isCursorShowing()) -- similar to above visibility
			end
			addCommandHandler("guiwindow",cmdGUI) -- trigger cmdGUI function with this command
	</syntaxhighlight>		</syntaxhighlight>

	~~(seriosly, some one put a exemple here please...)~~

	==See Also==		==See Also==
	{{GUI_functions}}		{{GUI_functions}}
	[[Category:Needs Example]]		[[Category:Needs Example]]

Headshot4Fun: /* Example */

2010-07-09T13:36:04Z

Example

← Older revision		Revision as of 13:36, 9 July 2010
Line 33:		Line 33:
	blabhalbalhb --abababa		blabhalbalhb --abababa
	--This line does this...		--This line does this...
	~~mooo~~		Mooooooooo -- cow!
	</syntaxhighlight>		</syntaxhighlight>

			(seriosly, some one put a exemple here please...)

	==See Also==		==See Also==
	{{GUI_functions}}		{{GUI_functions}}
	[[Category:Needs Example]]		[[Category:Needs Example]]

Extrike at 11:12, 24 May 2010

2010-05-24T11:12:29Z

← Older revision		Revision as of 11:12, 24 May 2010
Line 9:		Line 9:

	===Required Arguments===		===Required Arguments===
			[[Image:Checkbox.png\|thumb\|Test Checkbox]]
	*'''x:''' A float of the 2D x position of the checkbox on a player's screen. This is affected by the ''relative'' argument.		*'''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.		*'''y:''' A float of the 2D y position of the checkbox on a player's screen. This is affected by the ''relative'' argument.

R3mp at 20:32, 2 January 2009

2009-01-02T20:32:55Z

← Older revision		Revision as of 20:32, 2 January 2009
Line 19:		Line 19:
	===Optional Arguments===		===Optional Arguments===
	{{OptionalArg}}		{{OptionalArg}}
	*'''parent:''' This is the parent that the checkbox 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.		*'''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===		===Returns===

Awwu at 16:49, 20 March 2008

2008-03-20T16:49:03Z

← Older revision		Revision as of 16:49, 20 March 2008
Line 9:		Line 9:

	===Required Arguments===		===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.		*'''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.		*'''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.		*'''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 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.		*'''text:''' The text to be displayed next to the checkbox.
	*'''selected:''' A boolean representing whether the checkbox created should be selected by default.		*'''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.		*'''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}}
	*'''parent:''' This is the parent that the checkbox 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.		*'''parent:''' This is the parent that the checkbox 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===

← Older revision		Revision as of 13:59, 20 May 2018
Line 51:		Line 51:
	==See Also==		==See Also==
	{{GUI_functions}}		{{GUI_functions}}
			{{GUI_events}}