GuiGetVisible - Revision history

LordHenry: /* See Also */

2018-11-21T17:19:06Z

2018-11-07T16:24:43Z

← Older revision		Revision as of 16:24, 7 November 2018
Line 6:		Line 6:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool guiGetVisible ( element guiElement )		bool guiGetVisible ( element guiElement )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[GUI widgets\|GuiElement]]:getVisible\|visible\|guiSetVisible}}

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

2018-01-13T20:23:09Z

← Older revision		Revision as of 20:23, 13 January 2018
Line 7:		Line 7:
	bool guiGetVisible ( element guiElement )		bool guiGetVisible ( element guiElement )
	</syntaxhighlight>		</syntaxhighlight>
	~~{{OOP\|\|\|\|guiGetVisible}}~~

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

2018-01-13T20:22:52Z

← Older revision		Revision as of 20:22, 13 January 2018
Line 8:		Line 8:
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|\|\|guiGetVisible}}		{{OOP\|\|\|\|guiGetVisible}}
	~~{{OOP\|\|[[element]]:setPosition\|position\|getElementPosition}}~~
	===Required Arguments===		===Required Arguments===
	*'''guiElement:''' the GUI element to be checked		*'''guiElement:''' the GUI element to be checked

2018-01-13T20:22:27Z

← Older revision		Revision as of 20:22, 13 January 2018
Line 8:		Line 8:
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|\|\|guiGetVisible}}		{{OOP\|\|\|\|guiGetVisible}}
			{{OOP\|\|[[element]]:setPosition\|position\|getElementPosition}}
	===Required Arguments===		===Required Arguments===
	*'''guiElement:''' the GUI element to be checked		*'''guiElement:''' the GUI element to be checked

2018-01-13T20:22:10Z

← Older revision		Revision as of 20:22, 13 January 2018
Line 7:		Line 7:
	bool guiGetVisible ( element guiElement )		bool guiGetVisible ( element guiElement )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|\|\|guiGetVisible}}
	===Required Arguments===		===Required Arguments===
	*'''guiElement:''' the GUI element to be checked		*'''guiElement:''' the GUI element to be checked

2007-10-08T04:14:14Z

Example

← Older revision		Revision as of 04:14, 8 October 2007
Line 15:		Line 15:

	==Example==		==Example==
	~~<!-- Explain what the example is in a single sentance -->~~		This example toggles the visibility of myWindow.
	This example toggles the visibility of ~~an element~~.		<syntaxhighlight lang="lua">function guiToggleVisible ( )
	<syntaxhighlight lang="lua">		if ( guiGetVisible ( myWindow ) == true ) then -- check if the gui element is visible
	function guiToggleVisible ( ~~guiElement~~ )		guiSetVisible ( myWindow, false ) -- if it is, we hide it
	-- check if the gui element is visible		else
	if ( ~~guiGetVisible ( guiElement ) == true~~ ) ~~then~~		guiSetVisible ( myWindow, true ) -- if not, we make it visible
	-- if it is, we hide it		end
	guiSetVisible ( ~~guiElement~~, ~~false~~ )
	~~else~~
	-- if not, we make it visible
	~~guiSetVisible ( guiElement, true )~~
	end
	end		end
	</syntaxhighlight>
			myWindow = guiCreateWindow ( 0, 0, .5, .5, "my window", true ) -- Create the gui window
			bindKey ( "space", "down", guiToggleVisible ) --bind the player's spacebar to the function guiToggleVisible</syntaxhighlight>

	==See Also==		==See Also==
	{{GUI_functions}}		{{GUI_functions}}

2007-08-18T16:18:47Z

← Older revision		Revision as of 16:18, 18 August 2007
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	This function ~~returns the visibility state of~~ a GUI element.		This function determines if a GUI element is visible.

	==Syntax==		==Syntax==

2007-08-18T15:06:42Z

← Older revision		Revision as of 15:06, 18 August 2007
Line 1:		Line 1:
	__NOTOC__		{{Client function}}
			__NOTOC__
	This function returns the visibility state of a GUI element.		This function returns the visibility state of a GUI element.

Line 15:		Line 16:
	==Example==		==Example==
	<!-- Explain what the example is in a single sentance -->		<!-- Explain what the example is in a single sentance -->
	This example toggles the element ~~visibility~~		This example toggles the visibility of an element.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function guiToggleVisible ( guiElement )		function guiToggleVisible ( guiElement )
	--we check if the gui element is visible		-- check if the gui element is visible
	if ( guiGetVisible ( guiElement ) == true ) then		if ( guiGetVisible ( guiElement ) == true ) then
	--if it is we hide it		-- if it is, we hide it
	guiSetVisible ( guiElement, false )		guiSetVisible ( guiElement, false )
	else		else
	--if not, we make it visible		-- if not, we make it visible
	guiSetVisible ( guiElement, true )		guiSetVisible ( guiElement, true )
	end		end

2007-07-30T14:22:44Z

← Older revision		Revision as of 14:22, 30 July 2007
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool guiGetVisible ( element ~~gui~~ )		bool guiGetVisible ( element guiElement )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''~~gui~~:''' the GUI element to be checked		*'''guiElement:''' the GUI element to be checked

	===Returns===		===Returns===
Line 15:		Line 15:
	==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 toggles the element 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 -->~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--~~This line does...~~		function guiToggleVisible ( guiElement )
	~~blabhalbalhb~~ --~~abababa~~		--we check if the gui element is visible
	--~~This line does this...~~		if ( guiGetVisible ( guiElement ) == true ) then
	~~mooo~~		--if it is we hide it
			guiSetVisible ( guiElement, false )
			else
			--if not, we make it visible
			guiSetVisible ( guiElement, true )
			end
			end
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{GUI_functions}}		{{GUI_functions}}
	~~[[Category:Incomplete]]~~