BindKey - Revision history

LordHenry at 19:46, 19 March 2024

2024-03-19T19:46:49Z

← Older revision		Revision as of 19:46, 19 March 2024
Line 3:		Line 3:
	Binds a player's key to a handler function or command, which will be called when the key is pressed.		Binds a player's key to a handler function or command, which will be called when the key is pressed.

	{{Note\|Using escape key will always return false. Use [[onClientKey]] event instead.}}		{{Note\|Using '''escape''' key or '''F8''' key will always return false. Use [[onClientKey]] event instead.}}
	{{Note\|Handler function won't be triggered while focused in CEGUI editbox. You can use [[guiSetInputMode]] or [[onClientKey]] in order to fix that.}}		{{Note\|Handler function won't be triggered while focused in CEGUI editbox. You can use [[guiSetInputMode]] or [[onClientKey]] in order to fix that.}}

2023-05-30T12:05:10Z

Add note about guiSetInputMode.

← Older revision		Revision as of 12:05, 30 May 2023
Line 4:		Line 4:

	{{Note\|Using escape key will always return false. Use [[onClientKey]] event instead.}}		{{Note\|Using escape key will always return false. Use [[onClientKey]] event instead.}}
			{{Note\|Handler function won't be triggered while focused in CEGUI editbox. You can use [[guiSetInputMode]] or [[onClientKey]] in order to fix that.}}
	{{Note\|Handler function ~~wont~~ be triggered while focused in ~~cegui~~ editbox. ~~Use~~ [[onClientKey]] ~~event instead~~.}}

	==Syntax==		==Syntax==

2023-05-30T11:17:54Z

← Older revision		Revision as of 11:17, 30 May 2023
Line 5:		Line 5:
	{{Note\|Using escape key will always return false. Use [[onClientKey]] event instead.}}		{{Note\|Using escape key will always return false. Use [[onClientKey]] event instead.}}

	{{Note\|~~BindKey~~ wont be triggered while focused in cegui editbox. Use [[onClientKey]] event instead.}}		{{Note\|Handler function wont be triggered while focused in cegui editbox. Use [[onClientKey]] event instead.}}

	==Syntax==		==Syntax==

2023-05-30T11:17:17Z

← Older revision		Revision as of 11:17, 30 May 2023
Line 4:		Line 4:

	{{Note\|Using escape key will always return false. Use [[onClientKey]] event instead.}}		{{Note\|Using escape key will always return false. Use [[onClientKey]] event instead.}}

			{{Note\|BindKey wont be triggered while focused in cegui editbox. Use [[onClientKey]] event instead.}}

	==Syntax==		==Syntax==

2022-11-16T09:19:16Z

Note added about non working escape button

← Older revision		Revision as of 09:19, 16 November 2022
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	__NOTOC__		__NOTOC__
	Binds a player's key to a handler function or command, which will be called when the key is pressed.		Binds a player's key to a handler function or command, which will be called when the key is pressed.

			{{Note\|Using escape key will always return false. Use [[onClientKey]] event instead.}}

	==Syntax==		==Syntax==

2020-11-04T08:42:14Z

← Older revision		Revision as of 08:42, 4 November 2020
Line 125:		Line 125:
	bindKey (source,"forwards","down",		bindKey (source,"forwards","down",
	function(player,key,state)		function(player,key,state)
	outputChatBox (getPlayerName (player) .. "#FFFF00 thinks MTA:SA is so cool.",~~getRootElement()~~,255,255,0,true)		outputChatBox (getPlayerName (player) .. "#FFFF00 thinks MTA:SA is so cool.",root,255,255,0,true)
	end		end
	)		)
	end		end
	addEventHandler ("onPlayerLogin",~~getRootElement()~~,fanFunction)		addEventHandler ("onPlayerLogin",root,fanFunction)
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

2020-08-31T18:57:39Z

Brazilian Portuguese language page indexed to this

2019-07-03T00:00:56Z

Example

← Older revision		Revision as of 00:00, 3 July 2019
Line 107:		Line 107:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function funcInput ( key, keyState )		function funcInput ( key, keyState )
	outputChatBox ( "You " .. (keyState == "down" and "pressed" or "let go of") .. " the " .. key .. " key!" )		outputChatBox( "You " .. (keyState == "down" and "pressed" or "let go of") .. " the " .. key .. " key!" )
	end		end

			function bindTheKeys ( commandName )
			bindKey( "F1", "down", funcInput ) -- bind the player's F1 down key
			bindKey( "F1", "up", funcInput ) -- bind the player's F1 up key
			bindKey( "fire", "both", funcInput ) -- bind the player's fire down and up control
			end
			addCommandHandler ( "bindme", bindTheKeys )
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

2019-07-02T23:53:32Z

Example

← Older revision		Revision as of 23:53, 2 July 2019
Line 109:		Line 109:
	outputChatBox ( "You " .. (keyState == "down" and "pressed" or "let go of") .. " the " .. key .. " key!" )		outputChatBox ( "You " .. (keyState == "down" and "pressed" or "let go of") .. " the " .. key .. " key!" )
	end		end
	w
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

2019-06-11T16:16:40Z

Improved code examples.

← Older revision		Revision as of 16:16, 11 June 2019
Line 90:		Line 90:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function funcInput ( player, key, keyState )		function funcInput ( player, key, keyState )
	~~local state =~~ "~~let go of~~"		outputChatBox ( getPlayerName ( player) .. " " .. (keyState == "down" and "pressed" or "released") .. " the " .. key .. " key!" )
	if ( keyState == "down" ~~) then~~
	~~state =~~ "pressed"
	~~end~~
	~~outputChatBox ( getPlayerName ( player) ..~~ " " ~~.. state~~ .. " the " .. key .. " key!" )
	end		end

Line 111:		Line 107:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function funcInput ( key, keyState )		function funcInput ( key, keyState )
	~~local state =~~ "~~let go of~~"		outputChatBox ( "You " .. (keyState == "down" and "pressed" or "let go of") .. " the " .. key .. " key!" )
	if ( keyState == "down" ~~) then~~
	~~state =~~ "pressed"
	~~end~~
	~~outputChatBox (~~ "~~You~~ " ~~.. state~~ .. " the " .. key .. " key!" )
	end		end
			w
	~~function bindTheKeys ()~~
	~~bindKey ( "F1", "down", funcInput ) -- bind the player's F1 down key~~
	~~bindKey ( "F1", "up", funcInput ) -- bind the player's F1 up key~~
	~~bindKey ( "fire", "both", funcInput ) -- bind the player's fire down and up control~~
	~~end~~
	~~addCommandHandler ( "bindme", bindTheKeys )~~
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>