Plugin:MirLua/Module/m core/de: Difference between revisions
Wishmaster (talk | contribs) (Created page with "Ereignisname.") |
(Updating to match new version of source page) |
||
(33 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
<languages/> | <languages/> | ||
Dieses Modul wird global importiert und ist in jedem Modul über die Variable '''<var>m</var>''' verfügbar. Sie erlaubt den Zugriff auf grundliegende Funktionen im Miranda-NG-Kern. | |||
__TOC__ | __TOC__ | ||
Line 23: | Line 23: | ||
| style="text-align:center" | <code>number</code> | | style="text-align:center" | <code>number</code> | ||
| Ergebnis eines Serviceaufrufes wenn Service nicht existiert. | | Ergebnis eines Serviceaufrufes wenn Service nicht existiert. | ||
|- | |||
! scope="row" style="text-align:left" | Version | |||
| style="text-align:center" | <code>string</code> | |||
| | |||
|} | |} | ||
== Benannte Ereignisse == | == Benannte Ereignisse == | ||
=== CreateHookableEvent === | === CreateHookableEvent === | ||
Erzeugt ein hookbares Ereignis. | |||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
Line 44: | Line 49: | ||
==== {{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}} | {{nbsp|5}}Gibt ein Event-Handle zurück falls das Event erfolgreich erzeugt wurde, sonst <code>nil</code>. | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
Line 58: | Line 63: | ||
=== HookEvent === | === HookEvent === | ||
Setzt eine Callback-Funktion ("hook"), die bei diesem Ereignis aufgerufen wird. Hooks werden in der Reihenfolge aufgerufen in der sie zur Sequenz hinzugefügt wurden. | |||
Hook | Hook-Signatur: <code>function (wParam, lParam) return 0 end</code> | ||
Korrekte Rückgabe für einen Hook ist <code>0</code>. Wenn <code>1</code> zurückgegeben wird dann werden die folgenden Hooks in der Sequenz nicht mehr aufgerufen. | |||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
Line 80: | Line 85: | ||
| style="text-align:center" | {{Ls|YesNo/yes}} | | style="text-align:center" | {{Ls|YesNo/yes}} | ||
| style="text-align:center" | <code>function</code> | | style="text-align:center" | <code>function</code> | ||
| Hook | | Hook-Funktion, die aufgerufen wird wenn das Ereignis eintritt. | ||
|} | |} | ||
==== {{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}} | {{nbsp|5}}Gibt ein Hook-Handle zurück falls der Hook erfolgreich erzeugt wurde, sonst <code>nil</code>. | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
Line 93: | Line 98: | ||
end) | end) | ||
}} | }} | ||
---- | |||
=== HookTemporaryEvent === | |||
… | |||
==== {{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}} ==== | |||
… | |||
==== {{Ls|MirLua/Modules/example}} ==== | |||
… | |||
---- | ---- | ||
=== UnhookEvent === | === UnhookEvent === | ||
Entfernt Hook aus der Ereignis-Aufrufsequenz. | |||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
Line 109: | Line 143: | ||
| style="text-align:center" | {{Ls|YesNo/yes}} | | style="text-align:center" | {{Ls|YesNo/yes}} | ||
| style="text-align:center" | <code>light userdata</code> | | style="text-align:center" | <code>light userdata</code> | ||
| | | Von [[#CreateHookableEvent|CreateHookableEvent]] zurückgegebenes Event-Handle. | ||
|} | |} | ||
==== {{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}} | {{nbsp|5}}Gibt <code>true</code> zurück wenn die Hook-Funktion erfolgreich entfernt wurde, sonst <code>false</code>. | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
Line 122: | Line 156: | ||
=== NotifyEventHooks === | === NotifyEventHooks === | ||
Ruft alle Hooks aus der Ereignis-Aufrufsequenz nacheinander auf. | |||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
Line 135: | Line 169: | ||
| style="text-align:center" | {{Ls|YesNo/yes}} | | style="text-align:center" | {{Ls|YesNo/yes}} | ||
| style="text-align:center" | <code>light userdata</code> | | style="text-align:center" | <code>light userdata</code> | ||
| | | Von [[#CreateHookableEvent|CreateHookableEvent]] zurückgegebenes Event-Handle. | ||
|- | |- | ||
! scope="row" class="MirLuaParametersTable-parameter" | wParam | ! scope="row" class="MirLuaParametersTable-parameter" | wParam | ||
Line 149: | Line 183: | ||
==== {{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}} | {{nbsp|5}}Gibt <code>true</code> zurück wenn alle Hooks aufgerufen wurden, sonst <code>false</code>. | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
Line 157: | Line 191: | ||
== Benannte Servicefunktionen == | == Benannte Servicefunktionen == | ||
=== CreateServiceFunction === | === CreateServiceFunction === | ||
Erzeugt eine Service-Funktion ("service"). | |||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
Line 171: | Line 206: | ||
| style="text-align:center" | {{Ls|YesNo/yes}} | | style="text-align:center" | {{Ls|YesNo/yes}} | ||
| style="text-align:center" | <code>string</code> | | style="text-align:center" | <code>string</code> | ||
| | | Dienstname. | ||
|} | |} | ||
==== {{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}} | {{nbsp|5}}Gibt ein Service-Handle zurück falls der Service erfolgreich erzeugt wurde, sonst <code>nil</code>. | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
Line 187: | Line 222: | ||
=== CallService === | === CallService === | ||
Service mit Parametern aufrufen. | |||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
Line 200: | Line 235: | ||
| style="text-align:center" | {{Ls|YesNo/yes}} | | style="text-align:center" | {{Ls|YesNo/yes}} | ||
| style="text-align:center" | <code>string</code> | | style="text-align:center" | <code>string</code> | ||
| | | Dienstname. | ||
|- | |- | ||
! scope="row" class="MirLuaParametersTable-parameter" | wParam | ! scope="row" class="MirLuaParametersTable-parameter" | wParam | ||
Line 214: | Line 249: | ||
==== {{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}} | {{nbsp|5}}Gibt das Ergebnis des Service-Aufrufes zurück oder [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]. | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
Line 228: | Line 263: | ||
=== ServiceExists === | === ServiceExists === | ||
Prüft ob ein Service mit dem angegebenen Namen existiert. | |||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
Line 241: | Line 276: | ||
| style="text-align:center" | {{Ls|YesNo/yes}} | | style="text-align:center" | {{Ls|YesNo/yes}} | ||
| style="text-align:center" | <code>string</code> | | style="text-align:center" | <code>string</code> | ||
| | | Dienstname. | ||
|} | |} | ||
==== {{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}} | {{nbsp|5}}Gibt <code>true</code> zurück wenn der Service existiert, sonst <code>false</code>. | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
Line 256: | Line 291: | ||
=== DestroyServiceFunction === | === DestroyServiceFunction === | ||
Zerstört eine Servicefunktion. | |||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
Line 269: | Line 304: | ||
| style="text-align:center" | {{Ls|YesNo/yes}} | | style="text-align:center" | {{Ls|YesNo/yes}} | ||
| style="text-align:center" | <code>light userdata</code> | | style="text-align:center" | <code>light userdata</code> | ||
| | | Von [[#CreateServiceFunction|CreateServiceFunction]] zurückgegebenes Service-Handle. | ||
|} | |} | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
{{Content:MirLua/Example|code=m.DestroyServiceFunction(hService)}} | {{Content:MirLua/Example|code=m.DestroyServiceFunction(hService)}} | ||
== Threads == | |||
=== ForkThread === | |||
… | |||
---- | |||
=== TerminateThread === | |||
… | |||
== Andere == | == Andere == | ||
=== IsPluginLoaded === | === IsPluginLoaded === | ||
Prüft ob ein Plugin geladen ist anhand der UUID des Plugins. | |||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
Line 290: | Line 335: | ||
| style="text-align:center" | {{Ls|YesNo/yes}} | | style="text-align:center" | {{Ls|YesNo/yes}} | ||
| style="text-align:center" | <code>string</code> | | style="text-align:center" | <code>string</code> | ||
| Plugin UUID | | Plugin-UUID im Format ''<code>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</code>''. | ||
|} | |} | ||
==== {{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}} | {{nbsp|5}}Gibt <code>true</code> zurück wenn das Plugin geladen ist, sonst <code>false</code>. | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
Line 303: | Line 348: | ||
end | end | ||
}} | }} | ||
---- | |||
=== Free === | |||
… | |||
---- | ---- | ||
=== Translate === | === Translate === | ||
Übersetzt einen String in die Sprache der aktuellen Sprachdatei. | |||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
Line 323: | Line 372: | ||
==== {{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 330: | Line 379: | ||
=== Parse === | === Parse === | ||
Ersetzt Miranda-NG-Variablen in einem String. | |||
{| class="wikitable" | {| class="wikitable" | ||
Line 346: | Line 395: | ||
==== {{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%')}} | ||
---- | |||
=== GetFullPath === | |||
… |
Latest revision as of 02:03, 10 February 2022
Dieses Modul wird global importiert und ist in jedem Modul über die Variable m verfügbar. Sie erlaubt den Zugriff auf grundliegende Funktionen im Miranda-NG-Kern.
Konstanten
Typ | Beschreibung | |
---|---|---|
NULL | light userdata
|
Null-Pointer. |
INVALID_HANDLE_VALUE | light userdata
|
Ungültiger Handle. |
CALLSERVICE_NOTFOUND | number
|
Ergebnis eines Serviceaufrufes wenn Service nicht existiert. |
Version | string
|
Benannte Ereignisse
CreateHookableEvent
Erzeugt ein hookbares Ereignis.
Parameter
Parametername | Benötigt | Typ | Beschreibung |
---|---|---|---|
name | Ja | string
|
Ereignisname. |
Ergebnis
Typ: light userdata
Gibt ein Event-Handle zurück falls das Event erfolgreich erzeugt wurde, sonst nil
.
Beispiel
local hEvent = m.CreateHookableEvent('MyEvent')
if hEvent == m.NULL then
print('Event handle is empty!')
end
HookEvent
Setzt eine Callback-Funktion ("hook"), die bei diesem Ereignis aufgerufen wird. Hooks werden in der Reihenfolge aufgerufen in der sie zur Sequenz hinzugefügt wurden.
Hook-Signatur: function (wParam, lParam) return 0 end
Korrekte Rückgabe für einen Hook ist 0
. Wenn 1
zurückgegeben wird dann werden die folgenden Hooks in der Sequenz nicht mehr aufgerufen.
Parameter
Parametername | Benötigt | Typ | Beschreibung |
---|---|---|---|
name | Ja | string
|
Ereignisname. |
hook | Ja | function
|
Hook-Funktion, die aufgerufen wird wenn das Ereignis eintritt. |
Ergebnis
Typ: light userdata
Gibt ein Hook-Handle zurück falls der Hook erfolgreich erzeugt wurde, sonst nil
.
Beispiel
local hHook = m.HookEvent('MyEvent', function(w, l)
print('MyEvent is raised!')
end)
HookTemporaryEvent
…
Parameter
Parametername | Benötigt | Typ | Beschreibung |
---|---|---|---|
name | Ja | string
|
Event name. |
hook | Ja | function
|
Hook function to be called when event occurs. |
Ergebnis
…
Beispiel
…
UnhookEvent
Entfernt Hook aus der Ereignis-Aufrufsequenz.
Parameter
Parametername | Benötigt | Typ | Beschreibung |
---|---|---|---|
hEvent | Ja | light userdata
|
Von CreateHookableEvent zurückgegebenes Event-Handle. |
Ergebnis
Typ: boolean
Gibt true
zurück wenn die Hook-Funktion erfolgreich entfernt wurde, sonst false
.
Beispiel
m.UnhookEvent(hHook)
NotifyEventHooks
Ruft alle Hooks aus der Ereignis-Aufrufsequenz nacheinander auf.
Parameter
Parametername | Benötigt | Typ | Beschreibung |
---|---|---|---|
hEvent | Ja | light userdata
|
Von CreateHookableEvent zurückgegebenes Event-Handle. |
wParam | Nein | ||
lParam | Nein |
Ergebnis
Typ: boolean
Gibt true
zurück wenn alle Hooks aufgerufen wurden, sonst false
.
Beispiel
m.NotifyEventHooks(hEvent)
Benannte Servicefunktionen
CreateServiceFunction
Erzeugt eine Service-Funktion ("service").
Parameter
Parametername | Benötigt | Typ | Beschreibung |
---|---|---|---|
name | Ja | string
|
Dienstname. |
Ergebnis
Typ: light userdata
Gibt ein Service-Handle zurück falls der Service erfolgreich erzeugt wurde, sonst nil
.
Beispiel
local hService = m.CreateServiceFunction('MyService', function(w, l)
print('MyServiceis called!')
end)
CallService
Service mit Parametern aufrufen.
Parameter
Parametername | Benötigt | Typ | Beschreibung |
---|---|---|---|
name | Ja | string
|
Dienstname. |
wParam | Nein | ||
lParam | Nein |
Ergebnis
Typ: number
Gibt das Ergebnis des Service-Aufrufes zurück oder CALLSERVICE_NOTFOUND.
Beispiel
local result = m.CallService('MyService')
if result == m.CALLSERVICE_NOTFOUND then
print('Service is not found!')
end
ServiceExists
Prüft ob ein Service mit dem angegebenen Namen existiert.
Parameter
Parametername | Benötigt | Typ | Beschreibung |
---|---|---|---|
name | Ja | string
|
Dienstname. |
Ergebnis
Typ: boolean
Gibt true
zurück wenn der Service existiert, sonst false
.
Beispiel
if m.ServiceExists('MyService') then
m.CallService('MyService')
end
DestroyServiceFunction
Zerstört eine Servicefunktion.
Parameter
Parametername | Benötigt | Typ | Beschreibung |
---|---|---|---|
hService | Ja | light userdata
|
Von CreateServiceFunction zurückgegebenes Service-Handle. |
Beispiel
m.DestroyServiceFunction(hService)
Threads
ForkThread
…
TerminateThread
…
Andere
IsPluginLoaded
Prüft ob ein Plugin geladen ist anhand der UUID des Plugins.
Parameter
Parametername | Benötigt | Typ | Beschreibung |
---|---|---|---|
uuid | Ja | string
|
Plugin-UUID im Format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx .
|
Ergebnis
Typ: boolean
Gibt true
zurück wenn das Plugin geladen ist, sonst false
.
Beispiel
if m.IsPluginLoaded('{F0FDF73A-753D-499d-8DBA-336DB79CDD41}') then
print('Advanced auto away plugin is loaded!')
end
Free
…
Translate
Übersetzt einen String in die Sprache der aktuellen Sprachdatei.
Parameter
Parametername | Benötigt | Typ | Beschreibung |
---|---|---|---|
text | Ja | string
|
Ergebnis
Typ: string
Beispiel
m.Translate('Exit')
Parse
Ersetzt Miranda-NG-Variablen in einem String.
Parametername | Benötigt | Typ | Beschreibung |
---|---|---|---|
text | Ja | string
|
Ergebnis
Typ: string
Beispiel
local profileName = m.ReplaceVariables('%miranda_profilename%')
GetFullPath
…