GuiSetInputEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
 
(20 intermediate revisions by 14 users not shown)
Line 1: Line 1:
__NOTOC__  
{{Client function}}
This function enables or disables input focus for the GUI.
__NOTOC__
This function enables or disables input focus for the GUI. This means that any keybinds or MTA binds are overidden so that text can be input into an editbox, for example.  In other words, keys such as ''t'' and ''y'' which activate the chatbox are disabled.
 
{{New feature|3.0110|1.1|
[[guiSetInputMode]] can be used as an extended version of ''guiSetInputEnabled'' since it provides the same functionality with one added feature.
}}


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool guiSetInputEnabled ( bool enabled )
bool guiSetInputEnabled ( bool enabled )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[GUI widgets|GuiElement]].setInputEnabled|inputEnabled|guiGetInputEnabled}}


===Required Arguments===
===Required Arguments===
Line 14: Line 20:


==Example==  
==Example==  
This example does...
This example enables or disables the Input.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function setInputState()
blabhalbalhb --abababa
guiSetInputEnabled(not guiGetInputEnabled()) -- Disable the Input if Enabled, either Enable it.
--This line does this...
outputChatBox("The input is now ".. (guiGetInputEnabled() and "Enabled" or "Disabled") ..".") -- Output the new Input state.
mooo
end
addCommandHandler("input",setInputState) -- Add the command handler attached to the function "setInputState".
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
[[Category:Incomplete]]
{{GUI_events}}

Latest revision as of 17:19, 21 November 2018

This function enables or disables input focus for the GUI. This means that any keybinds or MTA binds are overidden so that text can be input into an editbox, for example. In other words, keys such as t and y which activate the chatbox are disabled.

guiSetInputMode can be used as an extended version of guiSetInputEnabled since it provides the same functionality with one added feature.

Syntax

bool guiSetInputEnabled ( bool enabled )

OOP Syntax Help! I don't understand this!

Method: GuiElement.setInputEnabled(...)
Variable: .inputEnabled
Counterpart: guiGetInputEnabled


Required Arguments

  • enabled: true if input should go to GUI, false if it should go to the game.

Returns

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

Example

This example enables or disables the Input. 

function setInputState()
	guiSetInputEnabled(not guiGetInputEnabled()) -- Disable the Input if Enabled, either Enable it.
	outputChatBox("The input is now ".. (guiGetInputEnabled() and "Enabled" or "Disabled") ..".") -- Output the new Input state.
end
addCommandHandler("input",setInputState) -- Add the command handler attached to the function "setInputState".

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/GuiSetInputEnabled?oldid=60859"