Plugin:MirLua/Module/m core: Difference between revisions
Jump to navigation
Jump to search
Marked this version for translation |
remove untranslatable colons |
||
| Line 51: | Line 51: | ||
==== {{Ls|MirLua/Modules/result}} ==== | ==== {{Ls|MirLua/Modules/result}} ==== | ||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} | {{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>light userdata</code> | ||
{{nbsp|5}}<translate><!--T:9--> Returns event handle if event was created successfully, otherwise <tvar|nil><code>nil</code></>.</translate> | {{nbsp|5}}<translate><!--T:9--> Returns event handle if event was created successfully, otherwise <tvar|nil><code>nil</code></>.</translate> | ||
| Line 91: | Line 91: | ||
==== {{Ls|MirLua/Modules/result}} ==== | ==== {{Ls|MirLua/Modules/result}} ==== | ||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} | {{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>light userdata</code> | ||
{{nbsp|5}}<translate><!--T:15--> Returns hook handle if hook was created successfully, otherwise <tvar|nil><code>nil</code></>.</translate> | {{nbsp|5}}<translate><!--T:15--> Returns hook handle if hook was created successfully, otherwise <tvar|nil><code>nil</code></>.</translate> | ||
| Line 120: | Line 120: | ||
==== {{Ls|MirLua/Modules/result}} ==== | ==== {{Ls|MirLua/Modules/result}} ==== | ||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} | {{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code> | ||
{{nbsp|5}}<translate><!--T:18--> Returns <tvar|true><code>true</code></> if hook function was removed successfully, otherwise <tvar|false><code>false</code></>.</translate> | {{nbsp|5}}<translate><!--T:18--> Returns <tvar|true><code>true</code></> if hook function was removed successfully, otherwise <tvar|false><code>false</code></>.</translate> | ||
| Line 156: | Line 156: | ||
==== {{Ls|MirLua/Modules/result}} ==== | ==== {{Ls|MirLua/Modules/result}} ==== | ||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} | {{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code> | ||
{{nbsp|5}}<translate><!--T:21--> Returns <tvar|true><code>true</code></> if all hooks were called, otherwise <tvar|false><code>false</code></>.</translate> | {{nbsp|5}}<translate><!--T:21--> Returns <tvar|true><code>true</code></> if all hooks were called, otherwise <tvar|false><code>false</code></>.</translate> | ||
| Line 184: | Line 184: | ||
==== {{Ls|MirLua/Modules/result}} ==== | ==== {{Ls|MirLua/Modules/result}} ==== | ||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} | {{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>light userdata</code> | ||
{{nbsp|5}}<translate><!--T:25--> Returns service handle if service was created successfully, otherwise <tvar|nil><code>nil</code></>.</translate> | {{nbsp|5}}<translate><!--T:25--> Returns service handle if service was created successfully, otherwise <tvar|nil><code>nil</code></>.</translate> | ||
| Line 223: | Line 223: | ||
==== {{Ls|MirLua/Modules/result}} ==== | ==== {{Ls|MirLua/Modules/result}} ==== | ||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} | {{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>number</code> | ||
{{nbsp|5}}<translate><!--T:28--> Returns result of service execution or <tvar|CALLSERVICE_NOTFOUND>[[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]</>.</translate> | {{nbsp|5}}<translate><!--T:28--> Returns result of service execution or <tvar|CALLSERVICE_NOTFOUND>[[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]</>.</translate> | ||
| Line 254: | Line 254: | ||
==== {{Ls|MirLua/Modules/result}} ==== | ==== {{Ls|MirLua/Modules/result}} ==== | ||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} | {{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code> | ||
{{nbsp|5}}<translate><!--T:31--> Returns <tvar|true><code>true</code></> if service exists, otherwise <tvar|false><code>false</code></>.</translate> | {{nbsp|5}}<translate><!--T:31--> Returns <tvar|true><code>true</code></> if service exists, otherwise <tvar|false><code>false</code></>.</translate> | ||
| Line 305: | Line 305: | ||
==== {{Ls|MirLua/Modules/result}} ==== | ==== {{Ls|MirLua/Modules/result}} ==== | ||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} | {{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code> | ||
{{nbsp|5}}<translate><!--T:37--> Returns <tvar|true><code>true</code></> if plugin is loaded, otherwise <tvar|false><code>false</code></>.</translate> | {{nbsp|5}}<translate><!--T:37--> Returns <tvar|true><code>true</code></> if plugin is loaded, otherwise <tvar|false><code>false</code></>.</translate> | ||
| Line 334: | Line 334: | ||
==== {{Ls|MirLua/Modules/result}} ==== | ==== {{Ls|MirLua/Modules/result}} ==== | ||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} | {{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>string</code> | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
| Line 357: | Line 357: | ||
==== {{Ls|MirLua/Modules/result}} ==== | ==== {{Ls|MirLua/Modules/result}} ==== | ||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} | {{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>string</code> | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
{{Content:MirLua/Example|code=local profileName = m.ReplaceVariables('%miranda_profilename%')}} | {{Content:MirLua/Example|code=local profileName = m.ReplaceVariables('%miranda_profilename%')}} | ||
Revision as of 14:01, 2 June 2018
This module is imported into global table and available in any module through variable m. It allows you to access basic features of Miranda NG core.
Constants
| Type | Description | |
|---|---|---|
| NULL | light userdata
|
Null pointer. |
| INVALID_HANDLE_VALUE | light userdata
|
Invalid handle. |
| CALLSERVICE_NOTFOUND | number
|
Result of service call when service does not exist. |
Named events
CreateHookableEvent
Creates a hookable event.
Parameters
| Parameter name | Required | Type | Description |
|---|---|---|---|
| name | Yes | string
|
Event name. |
Result
Type: light userdata
Returns event handle if event was created successfully, otherwise nil.
Example
local hEvent = m.CreateHookableEvent('MyEvent')
if hEvent == m.NULL then
print('Event handle is empty!')
end
HookEvent
Sets a callback function ("hook") to react to event call. Hooks are called one by one in the order they were added to the sequence.
Hook signature: function (wParam, lParam) return 0 end.
Correct result for a hook is 0. When 1 is returned, the following hooks in a sequence won't be called.
Parameters
| Parameter name | Required | Type | Description |
|---|---|---|---|
| name | Yes | string
|
Event name. |
| hook | Yes | function
|
Hook function to be called when event occurs. |
Result
Type: light userdata
Returns hook handle if hook was created successfully, otherwise nil.
Example
local hHook = m.HookEvent('MyEvent', function(w, l)
print('MyEvent is raised!')
end)
UnhookEvent
Removes hook from event call sequence.
Parameters
| Parameter name | Required | Type | Description |
|---|---|---|---|
| hEvent | Yes | light userdata
|
Event handle received on CreateHookableEvent call. |
Result
Type: boolean
Returns true if hook function was removed successfully, otherwise false.
Example
m.UnhookEvent(hHook)
NotifyEventHooks
Calls all hooks of event call sequence one by one.
Parameters
| Parameter name | Required | Type | Description |
|---|---|---|---|
| hEvent | Yes | light userdata
|
Event handle received on CreateHookableEvent call. |
| wParam | No | ||
| lParam | No |
Result
Type: boolean
Returns true if all hooks were called, otherwise false.
Example
m.NotifyEventHooks(hEvent)
Named service functions
CreateServiceFunction
Creates a service function ("service").
Parameters
| Parameter name | Required | Type | Description |
|---|---|---|---|
| name | Yes | string
|
Service name. |
Result
Type: light userdata
Returns service handle if service was created successfully, otherwise nil.
Example
local hService = m.CreateServiceFunction('MyService', function(w, l)
print('MyServiceis called!')
end)
CallService
Calls service with parameters.
Parameters
| Parameter name | Required | Type | Description |
|---|---|---|---|
| name | Yes | string
|
Service name. |
| wParam | No | ||
| lParam | No |
Result
Type: number
Returns result of service execution or CALLSERVICE_NOTFOUND.
Example
local result = m.CallService('MyService')
if result == m.CALLSERVICE_NOTFOUND then
print('Service is not found!')
end
ServiceExists
Checks if service exists by its name.
Parameters
| Parameter name | Required | Type | Description |
|---|---|---|---|
| name | Yes | string
|
Service name. |
Result
Type: boolean
Returns true if service exists, otherwise false.
Example
if m.ServiceExists('MyService') then
m.CallService('MyService')
end
DestroyServiceFunction
Destroys a service function.
Parameters
| Parameter name | Required | Type | Description |
|---|---|---|---|
| hService | Yes | light userdata
|
Service handle received on CreateServiceFunction call. |
Example
m.DestroyServiceFunction(hService)
Other
IsPluginLoaded
Checks using UUID of the plugin whether it is loaded.
Parameters
| Parameter name | Required | Type | Description |
|---|---|---|---|
| uuid | Yes | string
|
Plugin UUID in format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
|
Result
Type: boolean
Returns true if plugin is loaded, otherwise false.
Example
if m.IsPluginLoaded('{F0FDF73A-753D-499d-8DBA-336DB79CDD41}') then
print('Advanced auto away plugin is loaded!')
end
Translate
Translates a string into the language of the current langpack.
Parameters
| Parameter name | Required | Type | Description |
|---|---|---|---|
| text | Yes | string
|
Result
Type: string
Example
m.Translate('Exit')
Parse
Replaces Miranda NG variables in a string.
| Parameter name | Required | Type | Description |
|---|---|---|---|
| text | Yes | string
|
Result
Type: string
Example
local profileName = m.ReplaceVariables('%miranda_profilename%')