Zum Inhalt

LUA Skriptsprache

CadnaA beinhaltet die Skriptsprache Lua, die es ermöglicht, Arbeitsabläufe in CadnaA zu automatisieren. Lua ist eine Skriptsprache, die für ihre Ausführungsgeschwindigkeit und Benutzerfreundlichkeit bekannt ist. CadnaA-Lua ermöglicht den Zugriff auf:

  • CadnaA Objektattribute (siehe Tabelle Objektattribute im Handbuch „Attribute, Variablen und Schlüsselworte“),
  • Textvariablen,
  • Punkte von Polygonen,
  • Schleifen, um Operationen auf Gruppen von Objekten anzuwenden.

Dieses Kapitel bietet eine Einführung in die Skriptsprache Lua, einschließlich einiger Beispiele, die den Zugriff auf CadnaA-Objekte in CadnaA-Lua aufzeigen. In einem Referenzabschnitt sind alle Funktionen und Objekte aufgelistet.

Hinweis

In CadnaA wird die Lua-Version 5.4.8 verwendet. Zusätzlich sind folgende math-Funktionen aus früheren Lua-Versionen verfügbar: math.atan2(), math.cosh(), math.sinh(), math.tanh(), math.pow(), math.frexp(), math.ldexp(), math.log10(). Für weitere Informationen, siehe www.lua.org/manual/5.4/.

CadnaA-Lua ermöglicht den Zugriff auf Objekte und Funktionen unter Einsatz eines einfachen, aber leistungsfähigen und schnellen Interfaces. Mit CadnaA-Lua kann der Anwender häufig benutzte Arbeitsabläufe automatisieren, womit leistungsstarke Funktionen wie ObjectScan und Objekte verändern unterstützt werden. Lua ist eine Skriptsprache mit breiter Anwenderbasis, die gleichermaßen normale Anwender, als auch Experten umfasst.

Anforderungen & Support

Grundlegende Programmierkenntnisse sind erforderlich, um die Lua-Skriptsprache richtig benutzen zu können. Bitte beachten Sie, dass der CadnaA-Wartungsvertrag die Entwicklung oder das Debuggen von Lua-Skripten nicht abdeckt. Sollten Sie weitere Hilfe benötigen, wenden Sie sich bitte an DataKustik, um ein Angebot für diese Dienstleistung zu erhalten.

Lua-Editor

Der Lua-Interpreter ist in CadnaA eingebettet, dennoch sollten Lua- Scripte außerhalb von CadnaA unter Verwendung eines geeigneten Editors oder einer Programmierumgebung mit "Syntax-Highlighting" geschrieben werden (z.B. "Notepad++", http://notepad-plus-plus.org/) sein. Es besteht keine Notwendigkeit, eine externe Lua-Umgebung zu installieren, da Lua in CadnaA implementiert ist.

Lua-Skripte laden und starten

CadnaA-Lua Skripte werden über den Befehl/Dialog Skripte ausführen im Menü Extras geladen und über diesen auch gestartet.

Dialog Skripte ausführen (Menü Extras)

Lua-Skript laden

Klicken Sie das Dateiauswahlsymbol , um ein Lua-Skript zu laden.

Lua-Skript starten

Klicken Sie auf „Ausführen“, um das geladene Lua-Skript zu starten.

Verwendung externer Bibliotheken

Externe Lua-Bibliotheken, die als .dll bereitgestellt werden und mit Lua 5.4 kompatibel sind, können im Unterordner /lua_libs des Installationsverzeichnisses abgelegt und anschließend importiert werden.

Folgende Bibliotheken sind standardmäßig in der Installation von CadnaA enthalten. Zur Verwendung in einem Lua-Skript müssen diese zu Beginn der Lua-Datei importiert werden: 

local sqlite3 = require('lsqlite3')

local iuplua = package.loadlib('iuplua54.dll', 'luaopen_iuplua') or error('Failed to load iuplua54.dll') 
iuplua()

Ergebnisanzeige

Falls über das Skript eine Datenausgabe erfolgt, werden die Ergebnisdaten in diesem Dialog angezeigt.

Hinweis

Vorhandene Lua-Skripte können auch über Symbole auf der Symbolleiste gestartet werden (siehe Symbolleiste anpassen).

LUA-Skripte-Presets

Über den Befehl LUA-Skripte-Presets im Menü Extras können LUA-Skripte ausgeführt werden, ohne diese zuvor über den Dialog Skripte ausführen auswählen und starten zu müssen.

CadnaA scannt beim Programmstart, ob im Installationsverzeichnis und/oder im Verzeichnis der Datei CADNAA.INI ein Ordner lua_presets vorhanden ist. Falls ja, werden alle darin gefundenen *.lua Dateien im Menü Extras/Lua-Skript Presets aufgelistet. Wählen Sie zum Starten den Namen des LUA-Skripts aus dem Untermenü aus.

Kopieren Sie ggf. eigene Skripte in diesen Ordner. Die Dateien mit der Dateiendung *.luax enthalten CadnaA-eigene Skripte, die vom Anwender weder geöffnet, noch editiert werden können.

Der im Menü angezeigte Name ist immer der Dateiname, außer es befindet sich in der ersten Zeile der Datei ein Kommentar (beginnend mit „--“, d.h. mit doppeltem Bindestrich) mit dem Schlüsselwort #NAME(„xxx“). In diesem Fall wird xxx angezeigt.

Folgende Lua-Skripte werden mitgeliefert:

LUA-Kommando-Datei öffnen

Bei Auswahl des Befehls Lua-Kommando-Datei öffnen im Menü Extras wird die aktuell verwendete Kommando-Datei cnacmd.lua geöffnet.

weitere Details, siehe Aktion „Lua Kommando“

LUA-Events-Datei öffnen

Für die Lua Events-Datei steht kein eigener Menüeintrag zur Auswahl, jedoch kann die Datei cnaevents.lua mit einem Klick auf Lua-Kommando-Datei im Menü Extras mit gleichzeitigem Drücken der SHIFT-Taste geöffnet werden.

weitere Details, siehe Aktion „Lua Kommando“