EK at 09:19, 11 August 2023

2023-08-11T09:19:16Z

EK: Created page with "Unregister an event handler for a specific engine event which had been registered before. {| class="ts" |- | style="width:15%" | Related functions | Global Command: registe..."

2023-05-11T20:40:52Z

Created page with "Unregister an event handler for a specific engine event which had been registered before. {| class="ts" |- | style="width:15%" | Related functions | Global Command: registe..."

New page

Unregister an event handler for a specific engine event which had been registered before.

{| class="ts"
|-
| style="width:15%" | Related functions
| [[Global Command: registerEventHandler|registerEventHandler]]
|}

== Syntax ==
<syntaxhighlight lang="lua">
unregisterEventHandler(eventtype, handler)
</syntaxhighlight>

== Parameters ==

{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" | Type
! style="width:15%" | Supported values
! Description
|-
| rowspan="9" | eventtype
| rowspan="9" | string
| "actionArea"
| rowspan="9" | The type of event which triggers the event handler.
|-
| "animationStarted"
|-
| "animationStopped"
|-
| "engineEvent"
|-
| "keyEvent"
|-
| "mainLoop"
|-
| "mouseEvent"
|-
| "textStarted"
|-
| "textStopped"
|-
| handler
| string
|
| The name of the function which is called when the event occurs.
|}

== Return values ==

none

== Examples ==

'''Example 1:''' Register and unregister an event handler function for the main loop.
<syntaxhighlight lang="lua">
local counter = 1

function onMainLoop()
print(counter)

if counter == 100 then
unregisterEventHandler("mainLoop", "onMainLoop")
else
counter = counter + 1
end
end

registerEventHandler("mainLoop", "onMainLoop")
</syntaxhighlight>
{{toc}}

@@ Line 10: / Line 10: @@
 == Syntax ==
 <syntaxhighlight lang="lua">
-unregisterEventHandler(eventtype, handler)
+unregisterEventHandler(eventType, handler)
 </syntaxhighlight>
@@ Line 23: / Line 23: @@
 ! Description
 |-
-| rowspan="9" | eventtype
+| rowspan="9" | eventType
 | rowspan="9" | string
 | "actionArea"

Global Command: unregisterEventHandler - Revision history

EK at 09:19, 11 August 2023

EK: Created page with "Unregister an event handler for a specific engine event which had been registered before. {| class="ts" |- | style="width:15%" | Related functions | Global Command: registe..."