Plugin:MirLua/Module/m core/de: Difference between revisions
Wishmaster (talk | contribs) (Created page with "Plugin-UUID im Format $uuid_format") |
Wishmaster (talk | contribs) (Created page with "Prüft ob ein Plugin geladen ist anhand der UUID des Plugins.") |
||
Line 277: | Line 277: | ||
== Andere == | == Andere == | ||
=== IsPluginLoaded === | === IsPluginLoaded === | ||
Prüft ob ein Plugin geladen ist anhand der UUID des Plugins. | |||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== |
Revision as of 14:25, 2 June 2018
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. |
Benannte Ereignisse
CreateHookableEvent
Erzeugt ein hookbares Ereignis.
Parameter
Parametername | Benötigt | Typ | Beschreibung |
---|---|---|---|
name | Ja | string
|
Ereignisname. |
Ergebnis
Typ: light userdata
Returns event handle if event was created successfully, otherwise nil
.
Beispiel
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-Signatur: 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.
Parameter
Parametername | Benötigt | Typ | Beschreibung |
---|---|---|---|
name | Ja | string
|
Ereignisname. |
hook | Ja | function
|
Hook function to be called when event occurs. |
Ergebnis
Typ: light userdata
Returns hook handle if hook was created successfully, otherwise nil
.
Beispiel
local hHook = m.HookEvent('MyEvent', function(w, l)
print('MyEvent is raised!')
end)
UnhookEvent
Removes hook from event call sequence.
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
Calls all hooks of event call sequence one by one.
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)
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
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%')