GuiEditIsMasked: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Client function}} __NOTOC__ {{New feature/item|3.0156|1.5.5||This function checks if an edit field is masked.}} ==Syntax== <syntaxhighlight lang="lua"> bool guiEditIsMaske...")
 
mNo edit summary
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
{{New feature/item|3.0156|1.5.5||This function checks if an edit field is masked.}}
{{New feature/item|3.0156|1.5.5||This function checks if an edit box is masked.}}


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool guiEditIsMasked ( gui-edit editField )
bool guiEditIsMasked ( gui-edit guiEdit )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''editField:''' The gui-edit to check masked flag of.
*'''guiEdit:''' the edit box to check masked flag of.


===Returns===
===Returns===
Returns ''true'' if the edit field is masked, ''false'' if not, ''nil'' if an invalid edit field was provided.
Returns ''true'' if the edit box is masked, ''false'' if not, ''nil'' if an invalid edit box was provided.


==Example==  
==Example==  
Line 18: Line 18:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function createPasswordEdit( )
function createPasswordEdit( )
     local password = guiCreateEdit( 0.845, 0.94, 0.15, 0.05, "password", true ) -- create edit field for the advert
     local password = guiCreateEdit( 0.845, 0.94, 0.15, 0.05, "password", true ) -- create edit box for a password
     if password then -- if it was successfully created
     if password then -- if it was successfully created
         guiEditSetMasked( password, true ) -- make it masked
         guiEditSetMasked( password, true ) -- make it masked
Line 24: Line 24:
     addCommandHandler( "isMasked",
     addCommandHandler( "isMasked",
         function( )
         function( )
             local masked = guiEditIsMasked( advert ) -- check edit field masked flag
             local masked = guiEditIsMasked( advert ) -- check the edit box masked flag
             outputChatBox( "Edit field is " .. ( masked and "masked" or "not masked" ) ) -- show info about edit field
             outputChatBox( "Edit field is " .. ( masked and "masked" or "not masked" ) ) -- show info about edit box
         end
         end
     )
     )

Revision as of 17:48, 24 July 2018

This function checks if an edit box is masked.

Syntax

bool guiEditIsMasked ( gui-edit guiEdit )

Required Arguments

  • guiEdit: the edit box to check masked flag of.

Returns

Returns true if the edit box is masked, false if not, nil if an invalid edit box was provided.

Example

function createPasswordEdit( )
    local password = guiCreateEdit( 0.845, 0.94, 0.15, 0.05, "password", true ) -- create edit box for a password
    if password then -- if it was successfully created
        guiEditSetMasked( password, true ) -- make it masked
    end
    addCommandHandler( "isMasked",
        function( )
            local masked = guiEditIsMasked( advert ) -- check the edit box masked flag
            outputChatBox( "Edit field is " .. ( masked and "masked" or "not masked" ) ) -- show info about edit box
        end
    )
end
addEventHandler( "onClientResourceStart", resourceRoot, createPasswordEdit )

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/GuiEditIsMasked?oldid=56952"