GuiGetInputMode: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Client function}} __NOTOC__ This function returns the current input mode as set by guiSetInputMode. ==Syntax== <syntaxhighlight lang="lua"> string guiGetInputMode ( ) </syntaxhighlight> ===Return...")
 
 
(6 intermediate revisions by 2 users not shown)
Line 2: Line 2:
__NOTOC__
__NOTOC__
This function returns the current input mode as set by [[guiSetInputMode]].
This function returns the current input mode as set by [[guiSetInputMode]].
Default mode is ''"allow_binds"''.


==Syntax==  
==Syntax==  
Line 7: Line 8:
string guiGetInputMode ( )
string guiGetInputMode ( )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[GUI widgets|GuiElement]].getInputMode|inputMode|guiSetInputMode}}


===Returns===
===Returns===
Returns a string defining the current input mode, potential values are:
Returns a string defining the current input mode, potential values are:
** '''"allow_binds":''' binds are enabled, hence using a key such as t in an editbox will still activate the chatbox
* '''"allow_binds":''' binds are enabled, hence using a key such as t in an editbox will still activate the chatbox
** '''"no_binds":''' binds are disabled, hence using a key such as t in an editbox will still activate the chatbox
* '''"no_binds":''' binds are disabled, hence using a key such as t in an editbox will not activate the chatbox
** '''"no_binds_when_editing":''' binds are always enabled except when an editable editbox or memo has input focus
* '''"no_binds_when_editing":''' binds are always enabled except when an editable editbox or memo has input focus


==Example==  
==Example==  
Line 25: Line 27:


==Note==
==Note==
This function, introduced in 1.1, is '''not''' a replacement of [[guiGetInputEnabled]], indeed for the mode "no_binds_when_editing" the actual state of binds depends on the currently focused GUI widget. However:
This function, introduced in 1.1, is '''not''' a replacement of [[guiGetInputEnabled]], indeed for the mode ''"no_binds_when_editing"'' the actual state of binds depends on the currently focused GUI widget. However:
* when ''guiGetInputMode ( )'' returns ''"allow_binds"'' you can be sure that ''guiGetInputEnabled ()'' will return ''false''
* when ''guiGetInputMode ( )'' returns ''"allow_binds"'' you can be sure that ''guiGetInputEnabled ()'' will return ''false''
* when ''guiGetInputMode ( )'' returns ''"no_binds"'' you can be sure that ''guiGetInputEnabled ()'' will return ''true''
* when ''guiGetInputMode ( )'' returns ''"no_binds"'' you can be sure that ''guiGetInputEnabled ()'' will return ''true''
Line 31: Line 33:
==See Also==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
{{GUI_events}}

Latest revision as of 17:16, 21 November 2018

This function returns the current input mode as set by guiSetInputMode. Default mode is "allow_binds".

Syntax

string guiGetInputMode ( )

OOP Syntax Help! I don't understand this!

Method: GuiElement.getInputMode(...)
Variable: .inputMode
Counterpart: guiSetInputMode


Returns

Returns a string defining the current input mode, potential values are:

  • "allow_binds": binds are enabled, hence using a key such as t in an editbox will still activate the chatbox
  • "no_binds": binds are disabled, hence using a key such as t in an editbox will not activate the chatbox
  • "no_binds_when_editing": binds are always enabled except when an editable editbox or memo has input focus

Example

Click to collapse [-]
Client
addCommandHandler( "checkmode", 
function ()
    outputChatBox( string.format( "The current input mode is: '%s'", guiGetInputMode () ) )
end )

Note

This function, introduced in 1.1, is not a replacement of guiGetInputEnabled, indeed for the mode "no_binds_when_editing" the actual state of binds depends on the currently focused GUI widget. However:

  • when guiGetInputMode ( ) returns "allow_binds" you can be sure that guiGetInputEnabled () will return false
  • when guiGetInputMode ( ) returns "no_binds" you can be sure that guiGetInputEnabled () will return true

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/GuiGetInputMode?oldid=60847"