GetKeyState - Revision history

Skully: /* Removed unrequired boolean comparison and fixed punctuation. */

2020-07-26T03:22:55Z

Removed unrequired boolean comparison and fixed punctuation.

← Older revision		Revision as of 03:22, 26 July 2020
Line 21:		Line 21:
	-- define a function that outputs a message if control is pressed, and a different one if it isn't		-- define a function that outputs a message if control is pressed, and a different one if it isn't
	function printMessageFunction()		function printMessageFunction()
	-- if the left or right control keys are pressed, the user has pressed the "~~control~~+p" combo		-- if the left or right control keys are pressed, the user has pressed the "lctrl + p" combo.
	if getKeyState( "lctrl" ) ~~== true~~ or getKeyState( "rctrl" ) ~~== true~~ then		if getKeyState("lctrl") or getKeyState("rctrl") then
	outputChatBox ( "You have pressed '~~control~~+p'." )		outputChatBox ("You have pressed 'Left Control + P'.")
	-- if none of those were pressed, he just pressed the "p" key		-- if none of those were pressed, the player just pressed the "p" key.
	else		else
	outputChatBox ( "You have pressed 'p'." )		outputChatBox ("You have pressed 'p'.")
	end		end
	end		end
	-- bind the "p" key to our function		-- bind the "p" key to our function
	bindKey( "p", "down", printMessageFunction )		bindKey("p", "down", printMessageFunction)
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Client_input_functions}}		{{Client_input_functions}}

2016-10-10T11:03:31Z

← Older revision		Revision as of 11:03, 10 October 2016
Line 30:		Line 30:
	end		end
	-- bind the "p" key to our function		-- bind the "p" key to our function
	bindKey( "p", "down~~", "Print message~~", printMessageFunction )		bindKey( "p", "down", printMessageFunction )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Client_input_functions}}		{{Client_input_functions}}

2016-10-10T05:35:43Z

Undo revision 49434 by AkaBlue (talk)

← Older revision		Revision as of 05:35, 10 October 2016
Line 22:		Line 22:
	function printMessageFunction()		function printMessageFunction()
	-- if the left or right control keys are pressed, the user has pressed the "control+p" combo		-- if the left or right control keys are pressed, the user has pressed the "control+p" combo
	if getKeyState( "lctrl" ) == true or getKeyState( "p" ) == true then		if getKeyState( "lctrl" ) == true or getKeyState( "rctrl" ) == true then
	outputChatBox ( "You have pressed 'control+p'." )		outputChatBox ( "You have pressed 'control+p'." )
	-- if none of those were pressed, he just pressed the "p" key		-- if none of those were pressed, he just pressed the "p" key

2016-10-07T19:18:54Z

rctrl changed by p for the example

← Older revision		Revision as of 19:18, 7 October 2016
Line 22:		Line 22:
	function printMessageFunction()		function printMessageFunction()
	-- if the left or right control keys are pressed, the user has pressed the "control+p" combo		-- if the left or right control keys are pressed, the user has pressed the "control+p" combo
	if getKeyState( "lctrl" ) == true or getKeyState( "~~rctrl~~" ) == true then		if getKeyState( "lctrl" ) == true or getKeyState( "p" ) == true then
	outputChatBox ( "You have pressed 'control+p'." )		outputChatBox ( "You have pressed 'control+p'." )
	-- if none of those were pressed, he just pressed the "p" key		-- if none of those were pressed, he just pressed the "p" key

2015-12-09T04:05:54Z

← Older revision		Revision as of 04:05, 9 December 2015
Line 3:		Line 3:
	This function determines if a certain key is pressed or not.		This function determines if a certain key is pressed or not.

	'ralt' may trigger both 'ralt' and 'lctrl', this is due to AltGr		'''Note:''' 'ralt' may trigger both 'ralt' and 'lctrl', this is due to AltGr


	==Syntax==		==Syntax==

2012-02-16T23:05:11Z

← Older revision		Revision as of 23:05, 16 February 2012
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	This function determines if a certain key is pressed or not.		This function determines if a certain key is pressed or not.

			'ralt' may trigger both 'ralt' and 'lctrl', this is due to AltGr


	==Syntax==		==Syntax==

2008-02-28T11:46:49Z

2007-08-04T22:07:32Z

Added description, return info, proper tested example

← Older revision		Revision as of 22:07, 4 August 2007
Line 1:		Line 1:
			__NOTOC__
			{{Client function}}
			This function determines if a certain key is pressed or not.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool getKeyState ( ~~player thePlayer,~~ string keyName ) </syntaxhighlight>		<syntaxhighlight lang="lua">
			bool getKeyState ( string keyName )
			</syntaxhighlight>

			===Required Arguments===
			*'''keyName:''' The name of the key you're checking state of. See [[Key names]].

			===Returns===
			Returns ''true'' if the specified key is pressed, ''false'' if it isn't or if an invalid key name is passed.

			==Example==
			This clientside example prints a message when "p" is pressed, and a different one for the "control+p" combination.
			<syntaxhighlight lang="lua">
			-- define a function that outputs a message if control is pressed, and a different one if it isn't
			function printMessageFunction()
			-- if the left or right control keys are pressed, the user has pressed the "control+p" combo
			if getKeyState( "lctrl" ) == true or getKeyState( "rctrl" ) == true then
			outputChatBox ( "You have pressed 'control+p'." )
			-- if none of those were pressed, he just pressed the "p" key
			else
			outputChatBox ( "You have pressed 'p'." )
			end
			end
			-- bind the "p" key to our function
			bindKey( "p", "down", "Print message", printMessageFunction )
			</syntaxhighlight>

			==See Also==
			{{Client_world_functions}}

2007-04-02T17:14:37Z

New page

==Syntax==
<syntaxhighlight lang="lua">bool getKeyState ( player thePlayer, string keyName ) </syntaxhighlight>