bindKey - Revision history

Mex at 23:49, 20 April 2021

2021-04-20T23:49:18Z

← Older revision		Revision as of 23:49, 20 April 2021
Line 4:		Line 4:
	\|name = bindKey		\|name = bindKey
	\|usage = bind a handler to be called when a specific key is pressed, released, or either pressed/released		\|usage = bind a handler to be called when a specific key is pressed, released, or either pressed/released
	\|parameters = int keyCode, int keyState, function ~~callback~~		\|parameters = int keyCode, int keyState, function handler
	\|parameter1 = int keyCode The key code to bind the event for.		\|parameter1 = int keyCode The key code to bind the event for.
	\|parameter2 = int keyState The key state to bind the event for. KEYSTATE_DOWN, KEYSTATE_UP, or KEYSTATE_BOTH.		\|parameter2 = int keyState The key state to bind the event for. KEYSTATE_DOWN, KEYSTATE_UP, or KEYSTATE_BOTH.
	\|parameter3 = function ~~callback~~ The scripting function to call when the specified key is pressed, released, or either pressed/released.		\|parameter3 = function handler The scripting function to call when the specified key is pressed, released, or either pressed/released.
	\|~~callbackParametersSS~~ = KeyEvent event, Client client		\|callback3SyntaxSS = KeyEvent event, Client client
	\|~~callbackParametersCS~~ = KeyEvent event		\|callback3ParameterSS1 = KeyEvent event The KeyEvent object for the event.
			\|callback3ParameterSS2 = Client client The Client who triggered the key event.
			\|callback3SyntaxCS = KeyEvent event
			\|callback3ParameterCS1 = KeyEvent event The KeyEvent object for the event.
	\|return1 = void		\|return1 = void
	\|returnFail1 = void		\|returnFail1 = void

Mex at 21:00, 20 April 2021

2021-04-20T21:00:52Z

← Older revision		Revision as of 21:00, 20 April 2021
Line 6:		Line 6:
	\|parameters = int keyCode, int keyState, function callback		\|parameters = int keyCode, int keyState, function callback
	\|parameter1 = int keyCode The key code to bind the event for.		\|parameter1 = int keyCode The key code to bind the event for.
	\|parameter2 = int keyState The key state to bind the event for.		\|parameter2 = int keyState The key state to bind the event for. KEYSTATE_DOWN, KEYSTATE_UP, or KEYSTATE_BOTH.
	\|parameter3 = function callback The scripting function to call when the specified key is pressed, released, or either pressed/released.		\|parameter3 = function callback The scripting function to call when the specified key is pressed, released, or either pressed/released.
	\|callbackParametersSS = KeyEvent event, Client client		\|callbackParametersSS = KeyEvent event, Client client

Mex at 20:15, 20 April 2021

2021-04-20T20:15:11Z

← Older revision		Revision as of 20:15, 20 April 2021
Line 3:		Line 3:
	\|type = function		\|type = function
	\|name = bindKey		\|name = bindKey
	\|usage = bind a handler to be called when a specific key is pressed or released		\|usage = bind a handler to be called when a specific key is pressed, released, or either pressed/released
	\|parameters = int keyCode, int keyState, function callback		\|parameters = int keyCode, int keyState, function callback
	\|parameter1 = int keyCode The key code to bind the event for.		\|parameter1 = int keyCode The key code to bind the event for.
	\|parameter2 = int keyState The key state to bind the event for.		\|parameter2 = int keyState The key state to bind the event for.
	\|parameter3 = function callback The scripting function to call when the ~~event occurs~~.		\|parameter3 = function callback The scripting function to call when the specified key is pressed, released, or either pressed/released.
	\|callbackParametersSS = KeyEvent event, Client client		\|callbackParametersSS = KeyEvent event, Client client
	\|callbackParametersCS = KeyEvent event		\|callbackParametersCS = KeyEvent event

Mex at 20:13, 20 April 2021

2021-04-20T20:13:45Z

← Older revision		Revision as of 20:13, 20 April 2021
Line 7:		Line 7:
	\|parameter1 = int keyCode The key code to bind the event for.		\|parameter1 = int keyCode The key code to bind the event for.
	\|parameter2 = int keyState The key state to bind the event for.		\|parameter2 = int keyState The key state to bind the event for.
	\|parameter3 = function callback The scripting ~~fucntion~~ to call when the event occurs.		\|parameter3 = function callback The scripting function to call when the event occurs.
	\|callbackParametersSS = KeyEvent event, Client client		\|callbackParametersSS = KeyEvent event, Client client
	\|callbackParametersCS = KeyEvent event		\|callbackParametersCS = KeyEvent event

Mex at 14:44, 15 February 2020

2020-02-15T14:44:19Z

New page

{{ScriptItem
|endpoint = shared
|type = function
|name = bindKey
|usage = bind a handler to be called when a specific key is pressed or released
|parameters = int keyCode, int keyState, function callback
|parameter1 = int keyCode The key code to bind the event for.
|parameter2 = int keyState The key state to bind the event for.
|parameter3 = function callback The scripting fucntion to call when the event occurs.
|callbackParametersSS = KeyEvent event, Client client
|callbackParametersCS = KeyEvent event
|return1 = void
|returnFail1 = void
|notes = See also: [[Client/Functions#KeyEvent_Functions|KeyEvent Functions]]
|exampleJS = bindKey(SDLK_g, KEYSTATE_DOWN, function(e)
{
console.log("g key pressed down.");
})
}}