OnKeyDown: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 3: | Line 3: | ||
|type = event | |type = event | ||
|name = onKeyDown | |name = onKeyDown | ||
|usage = a key is pressed down | |usage = a key is pressed down. If the key is held down, the event is triggered repeatedly. | ||
|callbackParameters = Event event, int virtualKey, int physicalKey, int keyModifiers | |callbackParameters = Event event, int virtualKey, int physicalKey, int keyModifiers | ||
|parameter1 = int virtualKey The virtual key code for the key that was pressed down. | |parameter1 = int virtualKey The virtual key code for the key that was pressed down. |
Revision as of 22:08, 11 March 2021
Event
Client Only
Online and Offline
Not Cancellable
Available since Client 1.0.0
function(Event event, int virtualKey, int physicalKey, int keyModifiers)
The onKeyDown event is invoked when a key is pressed down. If the key is held down, the event is triggered repeatedly.
Parameters
1) | Event | event | The event object for this event. |
2) | int | virtualKey | The virtual key code for the key that was pressed down. |
3) | int | physicalKey | The physical key code for the key that was pressed down. |
4) | int | keyModifiers | The key modifiers that were active when the key was pressed down. |
Attributes
const | This event cannot be cancelled. |
Notes
- See SDL Key Information.
Examples
There aren't any examples for this event.
Compatibility
There isn't any compatibility information for this event.
Related
Client Related
OnCharacter
OnKeyDown
OnKeyUp