OnKeyDown: Difference between revisions

Latest revision as of 20:28, 19 November 2022

Event Client Only Online and Offline Not Cancellable

Available since Client 1.0.0

onKeyDown(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.

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.

const	This event cannot be cancelled.

There aren't any examples for this event.

There isn't any compatibility information for this event.

@@ Line 1: / Line 1: @@
-{{ScriptItem
+{{ScriptItem2
-|endpoint = client
+|name = onKeyDown
+|side = client
 |type = event
-|name = onKeyDown
+|games = iii vc sa iv
-|usage = a key is pressed down
+|desc = 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
+|arg1 = 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.
+|arg2 = int physicalKey The physical key code for the key that was pressed down.
-|parameter2 = int physicalKey The physical key code for the key that was pressed down.
+|arg3 = int keyModifiers The key modifiers that were active when the key was pressed down.
-|parameter3 = int keyModifiers The key modifiers that were active when the key was pressed down.
+|note = See [https://wiki.libsdl.org/SDL_Keysym SDL Key Information].
-|cancellable = false
+|cancel = false
-|notes = See [https://wiki.libsdl.org/SDL_Keysym SDL Key Information].
 }}