Plugin:MirLua/Module/m core/en - Revision history

FuzzyBot: Updating to match new version of source page

2022-02-09T23:02:26Z

Updating to match new version of source page

@@ Line 23: / Line 23: @@
 | style="text-align:center" | <code>number</code>
 | Result of service call when service does not exist.
 |}
 == Named events ==
 === CreateHookableEvent ===
 Creates a hookable event.
@@ Line 93: / Line 98: @@
 end)
 }}
 ----
@@ Line 157: / Line 191: @@
 == Named service functions ==
 === CreateServiceFunction ===
 Creates a service function ("service").
@@ Line 274: / Line 309: @@
 ==== {{Ls|MirLua/Modules/example}} ====
 {{Content:MirLua/Example|code=m.DestroyServiceFunction(hService)}}
 == Other ==
 === IsPluginLoaded ===
 Checks using UUID of the plugin whether it is loaded.
@@ Line 303: / Line 348: @@
 end
 }}
 ----
@@ Line 350: / Line 399: @@
 ==== {{Ls|MirLua/Modules/example}} ====
 {{Content:MirLua/Example|code=local profileName = m.ReplaceVariables('%miranda_profilename%')}}

FuzzyBot: Updating to match new version of source page

2018-06-02T11:02:07Z

Updating to match new version of source page

← Older revision		Revision as of 14:02, 2 June 2018
Line 44:		Line 44:

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: <code>light userdata</code>		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>light userdata</code>

	{{nbsp\|5}}Returns event handle if event was created successfully, otherwise <code>nil</code>.		{{nbsp\|5}}Returns event handle if event was created successfully, otherwise <code>nil</code>.
Line 84:		Line 84:

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: <code>light userdata</code>		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>light userdata</code>

	{{nbsp\|5}}Returns hook handle if hook was created successfully, otherwise <code>nil</code>.		{{nbsp\|5}}Returns hook handle if hook was created successfully, otherwise <code>nil</code>.
Line 113:		Line 113:

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: <code>boolean</code>		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>boolean</code>

	{{nbsp\|5}}Returns <code>true</code> if hook function was removed successfully, otherwise <code>false</code>.		{{nbsp\|5}}Returns <code>true</code> if hook function was removed successfully, otherwise <code>false</code>.
Line 149:		Line 149:

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: <code>boolean</code>		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>boolean</code>

	{{nbsp\|5}}Returns <code>true</code> if all hooks were called, otherwise <code>false</code>.		{{nbsp\|5}}Returns <code>true</code> if all hooks were called, otherwise <code>false</code>.
Line 175:		Line 175:

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: <code>light userdata</code>		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>light userdata</code>

	{{nbsp\|5}}Returns service handle if service was created successfully, otherwise <code>nil</code>.		{{nbsp\|5}}Returns service handle if service was created successfully, otherwise <code>nil</code>.
Line 214:		Line 214:

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: <code>number</code>		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>number</code>

	{{nbsp\|5}}Returns result of service execution or [[#CALLSERVICE_NOTFOUND\|CALLSERVICE_NOTFOUND]].		{{nbsp\|5}}Returns result of service execution or [[#CALLSERVICE_NOTFOUND\|CALLSERVICE_NOTFOUND]].
Line 245:		Line 245:

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: <code>boolean</code>		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>boolean</code>

	{{nbsp\|5}}Returns <code>true</code> if service exists, otherwise <code>false</code>.		{{nbsp\|5}}Returns <code>true</code> if service exists, otherwise <code>false</code>.
Line 294:		Line 294:

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: <code>boolean</code>		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>boolean</code>

	{{nbsp\|5}}Returns <code>true</code> if plugin is loaded, otherwise <code>false</code>.		{{nbsp\|5}}Returns <code>true</code> if plugin is loaded, otherwise <code>false</code>.
Line 323:		Line 323:

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: <code>string</code>		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>string</code>

	==== {{Ls\|MirLua/Modules/example}} ====		==== {{Ls\|MirLua/Modules/example}} ====
Line 346:		Line 346:

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: <code>string</code>		{{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%')}}

FuzzyBot: Updating to match new version of source page

2018-06-02T10:26:16Z

Updating to match new version of source page

New page

<languages/>
This module is imported into global table and available in any module through variable '''<var>m</var>'''. It allows you to access basic features of Miranda NG core.

__TOC__

== Constants ==

{| class="wikitable"
|-
!
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" style="text-align:left" | {{Anchor|NULL}} NULL
| style="text-align:center" | <code>light userdata</code>
| Null pointer.
|-
! scope="row" style="text-align:left" | {{Anchor|INVALID_HANDLE_VALUE}} INVALID_HANDLE_VALUE
| style="text-align:center" | <code>light userdata</code>
| Invalid handle.
|-
! scope="row" style="text-align:left" | {{Anchor|CALLSERVICE_NOTFOUND}} CALLSERVICE_NOTFOUND
| style="text-align:center" | <code>number</code>
| Result of service call when service does not exist.
|}

== Named events ==
=== CreateHookableEvent ===
Creates a hookable event.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | name
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Event name.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: <code>light userdata</code>

{{nbsp|5}}Returns event handle if event was created successfully, otherwise <code>nil</code>.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=
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: <code>function (wParam, lParam) return 0 end</code>.

Correct result for a hook is <code>0</code>. When <code>1</code> is returned, the following hooks in a sequence won't be called.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | name
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Event name.
|-
! scope="row" class="MirLuaParametersTable-parameter" | hook
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>function</code>
| Hook function to be called when event occurs.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: <code>light userdata</code>

{{nbsp|5}}Returns hook handle if hook was created successfully, otherwise <code>nil</code>.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=local hHook = m.HookEvent('MyEvent', function(w, l)
print('MyEvent is raised!')
end)
}}
----

=== UnhookEvent ===
Removes hook from event call sequence.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | hEvent
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: <code>boolean</code>

{{nbsp|5}}Returns <code>true</code> if hook function was removed successfully, otherwise <code>false</code>.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=m.UnhookEvent(hHook)}}
----

=== NotifyEventHooks ===
Calls all hooks of event call sequence one by one.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | hEvent
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.
|-
! scope="row" class="MirLuaParametersTable-parameter" | wParam
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" |
|
|-
! scope="row" class="MirLuaParametersTable-parameter" | lParam
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" |
|
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: <code>boolean</code>

{{nbsp|5}}Returns <code>true</code> if all hooks were called, otherwise <code>false</code>.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=m.NotifyEventHooks(hEvent)}}

== Named service functions ==
=== CreateServiceFunction ===
Creates a service function ("service").

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | name
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Service name.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: <code>light userdata</code>

{{nbsp|5}}Returns service handle if service was created successfully, otherwise <code>nil</code>.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=local hService = m.CreateServiceFunction('MyService', function(w, l)
print('MyServiceis called!')
end)
}}
----

=== CallService ===
Calls service with parameters.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | name
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Service name.
|-
! scope="row" class="MirLuaParametersTable-parameter" | wParam
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" |
|
|-
! scope="row" class="MirLuaParametersTable-parameter" | lParam
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" |
|
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: <code>number</code>

{{nbsp|5}}Returns result of service execution or [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]].

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=
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.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | name
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Service name.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: <code>boolean</code>

{{nbsp|5}}Returns <code>true</code> if service exists, otherwise <code>false</code>.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=if m.ServiceExists('MyService') then
m.CallService('MyService')
end}}
----

=== DestroyServiceFunction ===
Destroys a service function.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | hService
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| Service handle received on [[#CreateServiceFunction|CreateServiceFunction]] call.
|}

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=m.DestroyServiceFunction(hService)}}

== Other ==
=== IsPluginLoaded ===
Checks using UUID of the plugin whether it is loaded.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | uuid
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Plugin UUID in format ''<code>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</code>''.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: <code>boolean</code>

{{nbsp|5}}Returns <code>true</code> if plugin is loaded, otherwise <code>false</code>.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=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.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | text
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
|
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: <code>string</code>

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=m.Translate('Exit')}}
----

=== Parse ===
Replaces Miranda NG variables in a string.

{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | text
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
|
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: <code>string</code>

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=local profileName = m.ReplaceVariables('%miranda_profilename%')}}