Plugin:MirLua/Module/m core
This module is imported into global table from the very beginning and is available in any module through variable m. It allows to access basic features of Miranda NG core.
Parameters written in bold italics are obligatory.
Named events
CreateHookableEvent
Creates a hookable event.
- Parameters
- name
- Type: string
- Event name.
- Result
- Type: light userdata
- Returns event descriptor if event was created successfully, else nil.
- Example
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.
- Parameters
- 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.
- Example
local hHook = m.HookEvent('MyEvent', function(w, l)
print('MyEvent is raised!')
end)
UnhookEvent
Removes "trap" from event call sequence.
- Parameters
- hEvent
- Type: light userdata
- Event descriptor received on CreateHookableEvent call.
- Result
- Type: boolean
- Returns true if trap function was removed successfully, else false.
- Example
m.UnhookEvent(hHook)
NotifyEventHooks
Calls all "traps" of event call sequence one by one.
- Parameters
- 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.
- Example
m.NotifyEventHooks(hEvent)
Named service functions
CreateServiceFunction
Creates a service function ("service")
- Parameters
- name
- Type: string
- Service name.
- Result
- Type: light userdata
- Returns service descriptor if service was created successfully, else nil.
- Example
local hService = m.CreateServiceFunction('MyService', function(w, l)
print('MyServiceis called!')
end)
CallService
Calls service with parameters.
- Parameters
- name
- Type: string
- Service name.
- wParam
- lParam
- Result
- Type: number
- Returns result of service execution or CALLSERVICE_NOTFOUND
- Example
m.CallService('MyService', 0, 0)
ServiceExists
Checks if service exists by its name.
- Parameters
- name
- Type: string
- Service name.
- Result
- Type: boolean
- Returns true if service exists, else false
- Example
if m.ServiceExists('MyService') then
m.CallService('MyService')
end
DestroyServiceFunction
Destroys a service function.
- Parameters
- hService
- Type: light userdata
- Service descriptor received on CreateServiceFunction call.
- Example
m.DestroyServiceFunction(hService)
Others
IsPluginLoaded
Checks if plugin is loaded by its UUID.
- Parameters
- uuid
- Type: string
- Plugin UUID in format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
- Result
- Type: boolean
- Returns true if plugin is loaded, else false.
- Example
if m.IsPluginLoaded('{F0FDF73A-753D-499d-8DBA-336DB79CDD41}') then
print('Advanced auto away plugin is loaded!')
end
Utf8DecodeA
Converts Lua string contents to ANSI (codepage of the current langpack is used).
- text
- Type: string
- Result
- Type: string
- Example
m.CallService("Quotes/Import", 0, Utf8DecodeA('c:\\quotes.xml'))
Utf8DecodeW
Converts Lua string contents to Unicode (UTF-16).
- text
- Type: string
- Result
- Type: string
- Example
m.CallService("Popup/ShowMessageW", m.Utf8DecodeW('Hello, World!'), 2)
Translate
Translates a string into the language of the current langpack.
- text
- Type: string
- Result
- Type: string
- Example
m.Translate('Exit')
ReplaceVariables
Replaces Miranda NG variables in a string.
- text
- Result
- Type: string
- Example
local profileName = m.ReplaceVariables('%miranda_profilename%')
Constants
NULL
Null pointer.
- Type: light userdata
- Example
if hEvent == m.NULL then
print('Event handle is empty!')
end
INVALID_HANDLE_VALUE
Invalid descriptor.
- Type: light userdata
- Example
if hEvent == m.NULL then
print('Event handle is invalid!')
end
CALLSERVICE_NOTFOUND
Result of service call when service does not exist.
- Type: number
- Example
local result = m.CallService('MyService')
if result == m.CALLSERVICE_NOTFOUND then
print('Service is not found!')
end