Global Command: registerEventHandler - Revision history

EK at 11:58, 24 January 2025

2025-01-24T11:58:06Z

2025-01-24T11:46:58Z

2023-09-13T10:09:31Z

2023-08-11T09:18:51Z

2023-08-11T09:10:33Z

2023-08-11T08:58:12Z

2023-08-11T08:57:48Z

2023-08-11T08:54:56Z

2023-05-12T07:51:10Z

2023-05-12T07:49:36Z

@@ Line 254: / Line 254: @@
 '''Example 5:''' Register an event handler function for the "textStarted" event. It keeps the user from skipping texts accidentally.
 <syntaxhighlight lang="lua">
 function delaySkipText(text)
    if not text.Background then

@@ Line 99: / Line 99: @@
 | colspan="2" | The engine event which triggered the function. Supported values:
 * "LoadingSavegameSuccess"
 |-
-| path (str)
+| data (str)
-| colspan="2" | The full path to the loaded savegame file.
+| colspan="2" | In case of the "LoadingSavegameSuccess" event, the full path to the loaded savegame file.
 ''Example (Windows): "C:\Users\USERNAME\AppData\Local/DEVELOPER/GAME/Savegames/savegame00.dat"''
 |-

@@ Line 119: / Line 119: @@
 |-
 | keycode (int)
-| Unicode/ASCII keycode of the pressed key (only valid for "eEvtKeyDown" and "eEvtKeyUp" events). Use it to query special keys like the following:
+| Keycode of the pressed key (only valid for "eEvtKeyDown" and "eEvtKeyUp" events). Refer to the [[Keycodes_%26_Modifiers|list of keycodes]].
 |-
 | modifiers (int)
-| The currently active key modifiers (only valid for "eEvtKeyDown" and "eEvtKeyUp" events):
+| The currently active key modifiers (only valid for "eEvtKeyDown" and "eEvtKeyUp" events). Refer to the [[Keycodes_%26_Modifiers#Modifiers|list of modifiers]].
 |-
 | "mainLoop"

@@ Line 10: / Line 10: @@
 == Syntax ==
 <syntaxhighlight lang="lua">
-registerEventHandler(eventtype, handler [, flags])
+registerEventHandler(eventType, handler [, flags])
 </syntaxhighlight>
@@ Line 23: / Line 23: @@
 ! colspan="2" | Description
 |-
-| rowspan="9" | eventtype
+| rowspan="9" | eventType
 | rowspan="9" | string
 | "actionArea"
@@ Line 61: / Line 61: @@
 | table of integers
 | ''see the list of mouse events in the table below''
-| colspan="2" | A list of mouse events upon which the event handler is called. Only applicable if eventtype = "mouseEvent". If no mouse event is specified, the event handler is registered for all mouse events.
+| colspan="2" | A list of mouse events upon which the event handler is called. Only applicable if eventType = "mouseEvent". If no mouse event is specified, the event handler is registered for all mouse events.
 |}

@@ Line 176: / Line 176: @@
 | colspan="2" | Only valid for "eEvtMultiGesture" and "eEvtDollarGesture" events:
 * for "eEvtMultiGesture": the amount that the fingers pinched during the motion
-* for "eEvtDollarGesture": the difference between the gesture template and the actual performed gesture (a lower error is a better match)
+* for "eEvtDollarGesture": the difference between the gesture template and the actual performed gesture (the lower the number, the better the match)
 |-
 | fingers2 (int)

@@ Line 45: / Line 45: @@
 |-
 | "mouseEvent"
-| Event fires when the user uses the mouse or fingers/gestures.
+| Event fires when the user uses the mouse or fingers/gestures on touch devices.
 |-
 | "textStarted"

@@ Line 148: / Line 148: @@
 | colspan="2" |
 |-
-| rowspan="2" | "mouseEvent"
+| rowspan="5" | "mouseEvent"
 | eventType (int)
 | colspan="2" | The mouse event which triggered the function. Supported values:
@@ Line 170: / Line 170: @@
 * eEvtTouchMove (18)
 |-
-| mousePosition (t_point)
+| position (t_point)
-| colspan="2" | A table (associative array) containing the elements '''x (int)''' and '''y (int)'''.
+| colspan="2" | The mouse position or the normalized center of the gesture (for "eEvtMultiGesture" and "eEvtDollarGesture" events), respectively. A table (associative array) containing the elements '''x (int)''' and '''y (int)'''.
 |-
 | "textStarted"
@@ Line 203: / Line 218: @@
 '''Example 2:''' Register an event handler function for mouse events which is called when the user uses the scroll wheel.
 <syntaxhighlight lang="lua">
-function onMouseEvent(eventType, mousePosition)
+function onMouseEvent(eventType, position)
    if eventType == eEvtMouseWheelUp then
      print("User scrolled up.")

@@ Line 245: / Line 245: @@
 '''Example 4:''' Register an event handler function which gets executed after loading a savegame (be aware that this is only an example; the "read_ini()" function doesn't exist unless you created it).
 <syntaxhighlight lang="lua">
 function onEngineEvent(event, path)
    if event == "LoadingSavegameSuccess" then
      read_ini()
    end
 end
 registerEventHandler("engineEvent", "onEngineEvent")
 </syntaxhighlight>

@@ Line 27: / Line 27: @@
 | "actionArea"
 | Event fires when a character enters or leaves an action area.
-| rowspan="9" style="width:15%" | The type of event which triggers the event handler to be called. Only one event handler per event type can be registered, except for the "mainLoop" event.
+| rowspan="9" style="width:15%" | The type of event which triggers the event handler to be called.
 |-
 | "animationStarted"