GuiSetInputMode - Revision history

Fernando187: Move unncessary note section to desc

2025-11-11T17:10:23Z

Move unncessary note section to desc

← Older revision		Revision as of 17:10, 11 November 2025
Line 6:		Line 6:
	* '''no_binds:''' always disabled (hence using a key such as t will never open the chatbox)		* '''no_binds:''' always disabled (hence using a key such as t will never open the chatbox)
	* '''no_binds_when_editing:''' only disabled when editing an editbox or a memo (binds are enabled except when an editbox or memo has input focus)		* '''no_binds_when_editing:''' only disabled when editing an editbox or a memo (binds are enabled except when an editbox or memo has input focus)

			This function 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" )''

	==Syntax==		==Syntax==
Line 29:		Line 33:
	addEventHandler("onClientResourceStart", resourceRoot, onClientResourceStartSetGUIInputMode)		addEventHandler("onClientResourceStart", resourceRoot, onClientResourceStartSetGUIInputMode)
	</syntaxhighlight>		</syntaxhighlight>

	~~==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==		==See Also==
	{{GUI_functions}}		{{GUI_functions}}
	{{GUI_events}}		{{GUI_events}}

FeaturedPro: Improve input mode descriptions

2024-05-31T18:30:18Z

Improve input mode descriptions

← Older revision		Revision as of 18:30, 31 May 2024
Line 2:		Line 2:
	__NOTOC__		__NOTOC__
	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.		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~~:		Available input modes are:
	* never disabled (hence using a key such as t in an editbox will still ~~activate~~ the chatbox)		* '''allow_binds:''' never disabled (hence using a key such as t in an editbox will still open the chatbox)
	* always disabled (hence using a key such as t ~~in an editbox~~ will ~~not activate~~ the chatbox)		* '''no_binds:''' always disabled (hence using a key such as t will never open 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)		* '''no_binds_when_editing:''' only disabled when editing an editbox or a memo (binds are enabled except when an editbox or memo has input focus)

	==Syntax==		==Syntax==
Line 15:		Line 15:
	===Required Arguments===		===Required Arguments===
	* '''mode:''' a string representing the desired input mode. Accepted values are:		* '''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)		** '''"allow_binds":''' binds are enabled, hence using a key such as t in an editbox will still open 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":''' binds are disabled, hence using a key such as t will never open 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 enabled except when an editbox or memo has input focus

	===Returns===		===Returns===

Srslyyyy: Improve example.

2022-04-30T06:29:14Z

Improve example.

← Older revision		Revision as of 06:29, 30 April 2022
Line 24:		Line 24:
	==Example==		==Example==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~addEventHandler("onClientResourceStart", getResourceRootElement(),~~		function onClientResourceStartSetGUIInputMode()
	function()		guiSetInputMode("no_binds_when_editing") -- Calls guiSetInputMode once and for all to not have to handle binds state dynamically
	guiSetInputMode("no_binds_when_editing") --Calls guiSetInputMode once and for all to not have to handle binds state dynamically		end
	end)		addEventHandler("onClientResourceStart", resourceRoot, onClientResourceStartSetGUIInputMode)
	</syntaxhighlight>		</syntaxhighlight>

LordHenry: Undo revision 74480 by Srslyyyy (talk)

2022-04-28T04:39:49Z

Undo revision 74480 by Srslyyyy (talk)

← Older revision		Revision as of 04:39, 28 April 2022
Line 24:		Line 24:
	==Example==		==Example==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ~~onClientResourceStart~~()		addEventHandler("onClientResourceStart", getResourceRootElement(),
	guiSetInputMode("no_binds_when_editing") -- Calls guiSetInputMode once and for all to not have to handle binds state dynamically		function()
	end		guiSetInputMode("no_binds_when_editing") --Calls guiSetInputMode once and for all to not have to handle binds state dynamically
	~~addEventHandler("onClientResourceStart", resourceRoot, onClientResourceStart~~)		end)
	</syntaxhighlight>		</syntaxhighlight>

Srslyyyy: Improve example.

2022-04-25T11:42:56Z

Improve example.

← Older revision		Revision as of 11:42, 25 April 2022
Line 24:		Line 24:
	==Example==		==Example==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~addEventHandler("~~onClientResourceStart~~", getResourceRootElement(),~~		function onClientResourceStart()
	~~function~~()		guiSetInputMode("no_binds_when_editing") -- Calls guiSetInputMode once and for all to not have to handle binds state dynamically
	guiSetInputMode("no_binds_when_editing") --Calls guiSetInputMode once and for all to not have to handle binds state dynamically		end
	end)		addEventHandler("onClientResourceStart", resourceRoot, onClientResourceStart)
	</syntaxhighlight>		</syntaxhighlight>

LordHenry: /* See Also */

2018-11-21T17:20:06Z

StrixG at 16:27, 7 November 2018

2018-11-07T16:27:22Z

← Older revision		Revision as of 16:27, 7 November 2018
Line 11:		Line 11:
	bool guiSetInputMode ( string mode )		bool guiSetInputMode ( string mode )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|GuiElement.setInputMode\|inputMode\|guiGetInputMode}}		{{OOP\|\|[[GUI widgets\|GuiElement]].setInputMode\|inputMode\|guiGetInputMode}}

	===Required Arguments===		===Required Arguments===

StrixG at 15:56, 7 November 2018

2018-11-07T15:56:58Z

← Older revision		Revision as of 15:56, 7 November 2018
Line 11:		Line 11:
	bool guiSetInputMode ( string mode )		bool guiSetInputMode ( string mode )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|~~\|[[GUI widgets~~\|GuiElement~~]]:~~setInputMode\|inputMode\|guiGetInputMode}}		{{OOP\|\|GuiElement.setInputMode\|inputMode\|guiGetInputMode}}

	===Required Arguments===		===Required Arguments===

StrixG: OOP syntax

2018-11-07T15:52:57Z

OOP syntax

← Older revision		Revision as of 15:52, 7 November 2018
Line 11:		Line 11:
	bool guiSetInputMode ( string mode )		bool guiSetInputMode ( string mode )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[GUI widgets\|GuiElement]]:setInputMode\|inputMode\|guiGetInputMode}}

	===Required Arguments===		===Required Arguments===

Ccw: /* Example */

2015-02-11T16:35:27Z

Example

← Older revision		Revision as of 16:35, 11 February 2015
Line 23:		Line 23:
	==Example==		==Example==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler("onClientResourceStart", getResourceRootElement(~~getThisResource()~~),		addEventHandler("onClientResourceStart", getResourceRootElement(),
	function()		function()
	guiSetInputMode("no_binds_when_editing") --Calls guiSetInputMode once and for all to not have to handle binds state dynamically		guiSetInputMode("no_binds_when_editing") --Calls guiSetInputMode once and for all to not have to handle binds state dynamically

← Older revision		Revision as of 17:20, 21 November 2018
Line 37:		Line 37:
	==See Also==		==See Also==
	{{GUI_functions}}		{{GUI_functions}}
			{{GUI_events}}