GuiSetVisible: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
mNo edit summary
 
(13 intermediate revisions by 9 users not shown)
Line 1: Line 1:
__NOTOC__  
{{Client function}}
__NOTOC__
This function changes the visibility state of a GUI element.
This function changes the visibility state of a GUI element.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool guiSetVisible ( element gui, bool visible )
bool guiSetVisible ( element guiElement, bool state )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[GUI widgets|GuiElement]]:setVisible|visible|guiGetVisible}}


===Required Arguments===  
===Required Arguments===  
*'''gui:''' the GUI element whose visibility is to be changed
*'''guiElement:''' the GUI element whose visibility is to be changed
*'''visible:''' the new visibility state
*'''state:''' the new visibility state


===Returns===
===Returns===
Line 15: Line 17:


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example creates a GUI window and changes its visibility every 2 seconds, indefinitely.
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 lang="lua">
--This line does...
-- Create a GUI window called 'myWindow'
blabhalbalhb --abababa
myWindow = guiCreateWindow( 0.3, 0.3, 0.5, 0.60, "GUI window title", true )
--This line does this...
 
mooo
-- Set a timer to change the window's visibility every 2 seconds, indefinitely
setTimer( function( )
-- We toggle the visibility here by taking the opposite result of guiGetVisible (false => true, true => false), hence toggling its visibility
guiSetVisible( myWindow, not guiGetVisible( myWindow ) )
end, 2000, 0 )
</syntaxhighlight>
</syntaxhighlight>
This example creates a GUI window with ''yes'' and ''no'' buttons and you can toggle its visibility with the ''x'' key.
<syntaxhighlight lang="lua">addEventHandler( "onClientResourceStart", resourceRoot,
function( )
newgui.wind[ 1 ] = guiCreateWindow( 434, 304, 280, 123, "New Window", false )
guiWindowSetSizable( newgui.wind[ 1 ], false )
newgui.button[ 1 ] = guiCreateButton( 35, 46, 87, 40, "yes", false, newgui.wind[ 1 ] )
newgui.button[ 2 ] = guiCreateButton( 166, 49, 92, 37, "no", false, newgui.wind[ 1 ] )
showCursor( true )
end
)
bindKey( "x", "down",
function( )
local state = not guiGetVisible( newgui.wind[ 1 ] )
guiSetVisible( newgui.wind[ 1 ], state )
showCursor( state )
end
)</syntaxhighlight>


==See Also==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
[[Category:Incomplete]]
{{GUI_events}}
 
[[en:GuiSetVisible]]
[[fr:GuiSetVisible]]

Latest revision as of 21:06, 21 February 2021

This function changes the visibility state of a GUI element.

Syntax

bool guiSetVisible ( element guiElement, bool state )

OOP Syntax Help! I don't understand this!

Method: GuiElement:setVisible(...)
Variable: .visible
Counterpart: guiGetVisible


Required Arguments

  • guiElement: the GUI element whose visibility is to be changed
  • state: the new visibility state

Returns

Returns true if the element's visibility could be changed, false otherwise.

Example

This example creates a GUI window and changes its visibility every 2 seconds, indefinitely. 

-- Create a GUI window called 'myWindow'
myWindow = guiCreateWindow( 0.3, 0.3, 0.5, 0.60, "GUI window title", true )

-- Set a timer to change the window's visibility every 2 seconds, indefinitely
setTimer( function( )
	-- We toggle the visibility here by taking the opposite result of guiGetVisible (false => true, true => false), hence toggling its visibility
	guiSetVisible( myWindow, not guiGetVisible( myWindow ) )
end, 2000, 0 )

This example creates a GUI window with yes and no buttons and you can toggle its visibility with the x key. 

addEventHandler( "onClientResourceStart", resourceRoot,
	function( )
		newgui.wind[ 1 ] = guiCreateWindow( 434, 304, 280, 123, "New Window", false )
		guiWindowSetSizable( newgui.wind[ 1 ], false )

		newgui.button[ 1 ] = guiCreateButton( 35, 46, 87, 40, "yes", false, newgui.wind[ 1 ] )
		newgui.button[ 2 ] = guiCreateButton( 166, 49, 92, 37, "no", false, newgui.wind[ 1 ] )

		showCursor( true )
	end
)

bindKey( "x", "down",
	function( )
		local state = not guiGetVisible( newgui.wind[ 1 ] )
		guiSetVisible( newgui.wind[ 1 ], state )
		showCursor( state )
	end
)

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

Input

GUI

Retrieved from "https://wiki.multitheftauto.com/wiki/GuiSetVisible?oldid=69324"