GuiGetInputMode: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Move unnecessary note section to desc)
 
Line 3: Line 3:
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"''.
Default mode is ''"allow_binds"''.
This function 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''


==Syntax==  
==Syntax==  
Line 25: Line 29:
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>
==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==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
{{GUI_events}}
{{GUI_events}}

Latest revision as of 17:11, 11 November 2025

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

This function 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

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 )

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=82607"