Difference between revisions of "GuiSetInputMode"

From Multi Theft Auto: Wiki
Jump to: navigation, search
(Required Arguments)
m (Example: No point of the section as it's already a client function.)
Line 22: Line 22:
  
 
==Example==  
 
==Example==  
<section name="Client" class="client" show="true">
 
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()),
 
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()),
Line 29: Line 28:
 
end)
 
end)
 
</syntaxhighlight>
 
</syntaxhighlight>
</section>
 
  
 
==Note==
 
==Note==

Revision as of 06:25, 27 August 2013

This function controls the input mode to define whether or not (and when) keybinds or MTA binds are overridden (disabled) so that text can be input into an editbox, for example. The binds can be either:

  • never disabled (hence using a key such as t in an editbox will still activate the chatbox)
  • always disabled (hence using a key such as t in an editbox will not activate the chatbox)
  • only disabled when actually editing an editbox or a memo (binds are always enabled except when an editbox or memo has input focus)

Syntax

bool guiSetInputMode ( string mode )

Required Arguments

  • mode: a string representing the desired input mode. Accepted values are:
    • "allow_binds": binds are enabled, hence using a key such as t in an editbox will still activate the chatbox (default)
    • "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

Returns

Returns true if input mode could be changed, false if invalid parameters are passed.

Example

addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()),
function()
	guiSetInputMode("no_binds_when_editing") --Calls guiSetInputMode once and for all to not have to handle binds state dynamically
end)

Note

This function, introduced in 1.1, can be used as a replacement of guiSetInputEnabled since it provides the same functionality with one added feature.

  • guiSetInputEnabled ( false ) is the same as guiSetInputMode ( "allow_binds" )
  • guiSetInputEnabled ( true ) is the same as guiSetInputMode ( "no_binds" )

See Also

General functions

FROM VERSION 1.5.6 r16361 ONWARDS

Browsers

Buttons

Checkboxes

Comboboxes

Edit Fields

Gridlists

FROM VERSION 1.5.6 r16204 ONWARDS

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows