bindKey
Jump to navigation
Jump to search
Function
Server and Client
Online and Offline
Available since Server 1.0.0, Client 1.0.0
void bindKey(int keyCode, int keyState, function handler)
The bindKey function is used to bind a handler to be called when a specific key is pressed, released, or either pressed/released.
Parameters
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 | handler | The scripting function to call when the specified key is pressed, released, or either pressed/released. |
Return
void | This function doesn't return a value. |
Callbacks
Server-Side Callbacks
function handler(KeyEvent event, Client client)
1) | KeyEvent | event | The KeyEvent object for the event. |
2) | Client | client | The Client who triggered the key event. |
Client-Side Callbacks
function handler(KeyEvent event)
1) | KeyEvent | event | The KeyEvent object for the event. |
Notes
- See also: KeyEvent Functions.
Examples
Example 1 - JavaScript:
bindKey(SDLK_g, KEYSTATE_DOWN, function(e) {
console.log("g key pressed down.");
})
Compatibility
There isn't any compatibility information for this function.
Related
Server Related
bindKey
unbindAllKeys
unbindKey
Client Related
bindKey
isKeyDown
isScancodePressed
unbindAllKeys
unbindKey