DgsGetVisible: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Client function}} __NOTOC__ This function determines if a DGS element is visible. ==Syntax== <syntaxhighlight lang="lua"> bool dgsDxGUIGetVisible ( element guiElement ) </...")
 
m (DGS OOP Syntax changing)
 
(4 intermediate revisions by 2 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dgsDxGUIGetVisible ( element guiElement )
bool dgsGetVisible ( element guiElement )
</syntaxhighlight>  
</syntaxhighlight>
{{DGS/OOP|
    Method = DGSElement:getVisible|
    Variable = visible|dgsSetVisible
}}


===Required Arguments===  
===Required Arguments===  
Line 15: Line 19:


==Example==  
==Example==  
DGS = exports.dgs
This example toggles the visibility of myWindow.
This example toggles the visibility of myWindow.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
DGS = exports.dgs
function guiToggleVisible ( )         
function guiToggleVisible ( )         
         if ( DGS:dgsDxGUIGetVisible ( myWindow ) == true ) then -- check if the dgs element is visible               
         if ( DGS:dgsGetVisible ( myWindow ) == true ) then -- check if the dgs element is visible               
                 DGS:dgsDxGUISetVisible ( myWindow, false ) -- if it is, we hide it
                 DGS:dgsSetVisible ( myWindow, false ) -- if it is, we hide it
         else               
         else               
                 DGS:dgsDxGUISetVisible ( myWindow, true ) -- if not, we make it visible
                 DGS:dgsSetVisible ( myWindow, true ) -- if not, we make it visible
         end
         end
end
end


myWindow = DGS:dgsDxCreateWindow ( 0, 0, .5, .5, "my window", true ) -- Create the dgs window
myWindow = DGS:dgsCreateWindow ( 0, 0, .5, .5, "my window", true ) -- Create the dgs window
bindKey ( "space", "down", guiToggleVisible ) --bind the player's spacebar to the function guiToggleVisible</syntaxhighlight>
bindKey ( "space", "down", guiToggleVisible ) --bind the player's spacebar to the function guiToggleVisible</syntaxhighlight>


==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 21:08, 3 May 2021

This function determines if a DGS element is visible.

Syntax

bool dgsGetVisible ( element guiElement )

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

Method: DGSElement:getVisible(...)
Variable: .visible

Required Arguments

  • guiElement: the DGS element to be checked

Returns

Returns true if the element is visible, false otherwise.

Example

This example toggles the visibility of myWindow. 

DGS = exports.dgs

function guiToggleVisible ( )        
        if ( DGS:dgsGetVisible ( myWindow ) == true ) then -- check if the dgs element is visible               
                DGS:dgsSetVisible ( myWindow, false ) -- if it is, we hide it
        else              
                DGS:dgsSetVisible ( myWindow, true ) -- if not, we make it visible
        end
end

myWindow = DGS:dgsCreateWindow ( 0, 0, .5, .5, "my window", true ) -- Create the dgs window
bindKey ( "space", "down", guiToggleVisible ) --bind the player's spacebar to the function guiToggleVisible

See Also

General Functions

General Events

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsGetVisible?oldid=70992"