Content:MirLua/NamedEvents

Function	Description	Extended description	Settings	Example
CreateHookableEvent	Creates a hookable event.		name Type: string Event name. Result Type: light userdata Returns event descriptor if event was created successfully, else nil.	local hEvent = m.CreateHookableEvent('MyEvent')
HookEvent	Sets a callback function ("trap") to react to event call.	Traps are called one by one in the order they were added to the sequence. Trap signature: function (wParam, lParam) return 0 end. Correct result for a trap is 0. When 1 is returned, the following traps in a sequence won't be called.	name Type: string Event name. hook Type: function Trap function to be called when event occurs. Result Type: light userdata Returns trap descriptor if trap was created successfully, else nil.	local hHook = m.HookEvent('MyEvent', function(w, l) print('MyEvent is raised!') end)
UnhookEvent	Removes "trap" from event call sequence.		hEvent Type: light userdata Event descriptor received on CreateHookableEvent call. Result Type: boolean Returns true if trap function was removed successfully, else false.	m.UnhookEvent(hHook)
NotifyEventHooks	Calls all "traps" of event call sequence one by one.		hEvent Type: light userdata Event descriptor received on CreateHookableEvent call. wParam lParam Result Type: boolean Returns true if all trap functions were called, else false.	m.NotifyEventHooks(hEvent)

Documentation

<translate> Important</translate>
This was made to test how things from Plugin:MirLua subpages will look as a table. It's not ready to use yet.

Todo: (1) Not to forget to use it when creating multilingual content for MirLua (sub)pages; (2) column "Setting" should be renamed to "Parameters".

Automatic, localized test table for MirLua named event functions of m_core module.