6,833
edits
bindKey: Difference between revisions
no edit summary
No edit summary |
No edit summary |
||
| 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 | |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 | |parameter3 = function handler The scripting function to call when the specified key is pressed, released, or either pressed/released. | ||
| | |callback3SyntaxSS = KeyEvent event, Client client | ||
| | |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 | ||