Event Handler

Definition

An Event Handler is a function registered in a special way to be called when certain things (events) happen.

Official Documentation

Official Events Documentation: [Events]

Registering an EventHandler

• Registering a function as EventHandler in its general abstract form is:

RegisterEventHandler( (EventType)mEvent, (string)mEventIdentifier, (function)mEventHandler) 

The registered function can also be declared inline:

RegisterEventHandler( (EventType)mEvent, (string)mEventIdentifier, 
         function(...) 
              -- Do Stuff -- 
         end
) 

mEvent can be one of the following events:

EventType. + LoadedFromBackup, Destroyed,  CreatedObject,  ModuleAttached,  Timer,  Message,  EnterView,  LeaveView,  RequestPickUp,  RequestDrop,  RequestEquip,  ContainerItemAdded,  ContainerItemRemoved,  ItemEquipped,  ItemUnequipped,  StartMoving,  Arrived,  Use, PlayerSpeech, ClientUserCommand,  ClientObjectCommand,  ClientTargetAnyObjResponse, ClientTargetGameObjResponse,  ClientTargetLocResponse,  ContextMenuResponse, DynamicWindowResponse, UserLogout, GlobalVarUpdateResult

Example:

RegisterEventHandler(EventType.Timer, "MyCoolestTimer", HandleTick)

Explanation: This Registers the Function "HandleTick" as Handler for the Timer named "MyCoolestTimer", and it is called whenever this specific timer fires.

An inline function definition for this timer would look like this:

RegisterEventHandler(EventType.Timer, "MyCoolestTimer", 
     function()
          print("MyCoolestTimer just fired")
     end
)

E.G. this:FireTimer("MyCoolestTimer") would fire the timer and thus call the "HandleTick" function. You can optionally pass data to an event when triggering it and thus give this data to the Event Handler.
E.G: in the last Example we could have called this:FireTimer("MyCoolestTimer",{name="MyData",content="Stuff"}) which would pass a table to the timer and the handler. If the handler can handle this data depends on its definition.
Also: Some events pass default data to the handlers, it is necessary to know which events pass which data. You can find this information in the official documentation.

Declaring EventHandlers

As you could see above, the functions handling the triggered events can be declared externally or inline inside the RegisterEventHandler function.
Whatever you do: To let these functions do something meaningful they usually need to get some data and thus the following rule applies:

A function definition for an EventHandler, be it declared inline or externally must declare its parameters in a way which is predefined by the type of the event it is handling. Handlers for Timer Events have different parameters than Handlers for Message or CreatedObject events. Otherwise errors occur or the function simply has no data available.

Check the official documentation to find out about these parameters If we want to use a timer like this:

 this:FireTimer("MyCoolTimer", {name="Stuff", data = "Moar Stuff"} )

we have to declare the Handler accordingly either inline:

RegisterEventHandler(EventType.Timer, "MyCoolTimer", 
   function(data) 
      -- tostring is used for handling nil values and numbers or table data properly
      print(tostring(data.name).." is the name and "..tostring(data.data).." is the data")
   end
)

Or externally:

function HandleCoolTimer(data)
      -- tostring is used for handling nil values and numbers or table data properly
      print(tostring(data.name).." is the name and "..tostring(data.data).." is the data")
end

RegisterEventHandler(EventType.Timer, "MyCoolTimer", HandleCoolTimer )

Overriding and Modding EventHandlers

The Problem:
Building upon functions defined within event handlers
In an attempt to avoid excessive code maintenance when the base code changes between versions, I am trying to write all my mods as stand alone methods which override existing methods (and sometimes refer to the super method). This is working in most cases, but I have hit a few snags in which the base script defines a method directly within an EventHandler. For these situations I have been using OverrideEventHandler and then copying the entire base function and putting in my changes. Is there a better way to do this so I can avoid copying base code (in case of future changes)?
[Forum Link]

- A -

<syntaxhighlight lang="lua"> -- OriginalScript.lua RegisterEventHandler(EventType.Message,"TestMessage",

   function()
       DebugMessage("Just a test")
   end

) <syntaxhighlight>

The situation above has to be resolved by copying the code.
Your override would look like:

<syntaxhighlight lang="lua"> -- OriginalScript.lua - modded version in mods/mymod/scripts require 'default:OriginalScript' OverrideEventHandler("default:OriginalScript",EventType.Message,"TestMessage",

   function()
       DebugMessage("Just a test")
       DebugMessage("Modded additional Info")
   end

) <syntaxhighlight>

- B -

<syntaxhighlight lang="lua"> -- AnotherOriginalScript.lua function HandleTestMessage()

   DebugMessage("Just a test")

end RegisterEventHandler(EventType.Message,"TestMessage", HandleTestMessage) <syntaxhighlight>

This is better code. Still not optimal, since it requires to override the eventhandler if you alter the function or it will use the old function, despite your override. Your override would look like:

<syntaxhighlight lang="lua"> -- AnotherOriginalScript.lua -- modded version require 'default:AnotherOriginalScript' OldHandleTestMessage = HandleTestMessage function HandleTestMessage()

   OldHandleTestMessage()
   DebugMessage("Modded additional Info")

end OverrideEventHandler("AnotherOriginalScript",EventType.Message,"TestMessage", HandleTestMessage) <syntaxhighlight>

- C - <syntaxhighlight lang="lua"> -- AndFinallyAThirdScript.lua function FinallyDoTheTestMessage() DebugMessage("Just a test") end function HandleTestMessage() FinallyDoTheTestMessage() end RegisterEventHandler(EventType.Message,"TestMessage", HandleTestMessage) <syntaxhighlight> Most convenient solution: You can safely override FinallyDoTheTestMessage() without touching the event handler, but it adds another function call. Your modded script would look like: <syntaxhighlight lang="lua"> -- AndFinallyAThirdScript.lua -- modded version require 'AndFinallyAThirdScript' OldFinallyDoTheTestMessage = FinallyDoTheTestMessage function FinallyDoTheTestMessage()

   OldFinallyDoTheTestMessage()
   DebugMessage("Modded additional Info")

end <syntaxhighlight>