GetKeyState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(Added description, return info, proper tested example)
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}}

Revision as of 22:07, 4 August 2007

This function determines if a certain key is pressed or not.

Syntax

bool getKeyState ( string keyName )

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. 

-- 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 )

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/GetKeyState?oldid=9828"