Lua:Neutrino-API:checkVersion:de
Version vom 10. September 2015, 01:13 Uhr von Micha-bbg (Diskussion | Beiträge) (Kommentare im Beispiel wiederhergestellt.)
checkVersion
Überprüft die Korrektheit der übergebenen LUA-API Version.
Ist die vorhandene API Version OK, wird 1 zurückgegeben, ist sie zu alt, wird eine Fehlermeldung ausgegeben und 0 zurückgegeben. Das Script sollte dann beendet werden (siehe Beispiel).
| checkVersion(Parameter) | ab API v1.0 - Neutrino Git |
Parameter:
| Parameter | Typ | Description/Beschreibung | |
| 1 | number | major | Major Version |
| 2 | number | minor | Minor Version |
| en: Parameters with default-values are optional. If not needed, no definition is required. In case of missing parameter, default value is used.
de: Parameter mit Default-Wert sind optional. dh. sie müssen nicht angegeben werden. Falls der Parameter fehlt, wird automatisch dieser Wert angenommen. |
Rückgabewert:
| 0 | Version zu alt, Script sollte beendet werden |
| 1 | Version OK |
Example:
-- Beispiel: Die erforderliche API Version ist 1.1
-- Wenn die vorhandene Version älter ist, wird 0 zurückgegeben und das Script wird beendet.
-- 'do return end' deshalb, da os.exit(0) das übergeordnete Programm beendet. Bei einem normalen
-- LUA Script ist das der LUA Interpreter, bei einem LUA Plugin wäre das aber Neutrino, was beendet wird!
-- Ganz am Anfang des Scripts, außerhalb von irgendwelchen Funktionen, einfügen.
local n = neutrino()
local v = n:checkVersion(1, 1)
if (v == 0) then do return end end
|
