bindKey: Difference between revisions

Revision as of 21:00, 20 April 2021

Function Server and Client Online and Offline

Available since Server 1.0.0, Client 1.0.0

void bindKey(int keyCode, int keyState, function callback)

The bindKey function is used to bind a handler to be called when a specific key is pressed, released, or either pressed/released.

1)	int	keyCode	The key code to bind the event for.
2)	int	keyState	The key state to bind the event for. KEYSTATE_DOWN, KEYSTATE_UP, or KEYSTATE_BOTH.
3)	function	callback	The scripting function to call when the specified key is pressed, released, or either pressed/released.

void	This function doesn't return a value.

Example 1 - JavaScript:

bindKey(SDLK_g, KEYSTATE_DOWN, function(e) {

   console.log("g key pressed down.");

})

There isn't any compatibility information for this function.

@@ Line 6: / Line 6: @@
 |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.
+|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.
 |callbackParametersSS = KeyEvent event, Client client