DgsSetVisible: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(table syntax)
 
(3 intermediate revisions by 2 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dgsSetVisible ( element dgsElement, bool state )
bool dgsSetVisible ( element/table dgsElement, bool state )
</syntaxhighlight>  
</syntaxhighlight>
{{DGS/OOP|
    Method = DGSElement:setVisible|
    Variable = visible|
    Counterpart = dgsGetVisible
}}


===Required Arguments===  
===Required Arguments===  
Line 23: Line 28:
function changeVisibility ( )
function changeVisibility ( )
-- we check if the dgs element is visible
-- we check if the dgs element is visible
DGS:dgsSetVisible (myWindow, not dgsGetVisible ( myWindow ) )
DGS:dgsSetVisible (myWindow, not DGS:dgsGetVisible ( myWindow ) )
end
end


Line 52: Line 57:
</syntaxhighlight></section>
</syntaxhighlight></section>


==See Also==
=See Also=
{{DGSFUNCTIONS}}
 
==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Functions</span>==
{{DGS General Functions}}
 
==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Events</span>==
{{DGS Events/General}}

Latest revision as of 17:51, 13 January 2023

This function changes the visibility state of a DGS element.

Syntax

bool dgsSetVisible ( element/table dgsElement, bool state )

DGS OOP Syntax Help! I don't understand this!

Method: DGSElement:setVisible(...)
Variable: .visible
Counterpart: dgsGetVisible

Required Arguments

  • dgsElement: the DGS 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 dgs window and changes its visibility every 2 seconds, infinite times.

DGS = exports.dgs

function changeVisibility ( )
	-- we check if the dgs element is visible
	DGS:dgsSetVisible (myWindow, not DGS:dgsGetVisible ( myWindow ) )
end

--Create a dgs window called 'myWindow'
myWindow = DGS:dgsCreateWindow ( 0.3, 0.3, 0.5, 0.60, "DGS window title", true )
--Set a timer to change the window's visibility every 2 seconds, infinite times
setTimer ( changeVisibility, 2000, 0 )

This example creates a dgs window with yes and no buttons and make it visible/invisible with the bindkey 'x'.

Click to collapse [-]
Client
DGS = exports.dgs

newdgs = { button = {}, wind= {} }

addEventHandler("onClientResourceStart", resourceRoot,function()
	newdgs.wind[1] = DGS:dgsDxCreateWindow(434, 304, 280, 123, "New Window", false)
	DGS:dgsDxWindowSetSizable(newdgs.wind[1], false)
	newdgs.button[1] = DGS:dgsDxCreateButton(35, 46, 87, 40, "yes", false, newdgs.wind[1])
	newdgs.button[2] = DGS:dgsDxCreateButton(166, 49, 92, 37, "no", false, newdgs.wind[1])    
end)

bindKey ( "x", "down", function ( )
		local state = ( not DGS:dgsGetVisible( newdgs.wind[1] ) )
		DGS:dgsSetVisible( newdgs.wind[1], state )
		showCursor ( state )
	end)

See Also

General Functions

General Events