Python-Automatisierung in Unreal Engine: Plugin aktivieren und erstes Skript ausführen

Was erfahren Sie in diesem Leitfaden?

Um Python im Unreal Editor zu verwenden, müssen Sie zunächst das entsprechende Plugin im Projekt aktivieren und anschließend den Code auf geeignete Weise ausführen. Dieser Leitfaden erklärt die Plugin-Installation, das Ausführen von Code über die Konsole und von Python-Dateien sowie Optionen, mit denen sich die Automatisierung später wiederholbar gestalten lässt. Epic Games sieht Python im Editor beispielsweise für die Asset-Verwaltung, die Platzierung von Inhalten in Levels und die Automatisierung zeitaufwendiger Aufgaben vor.

Wichtig ist der Einsatzbereich: Diese Python-Umgebung ist für den Unreal Editor gedacht. Python-Code lässt sich nicht ausführen, während das Projekt im Play-In-Editor-Modus, als eigenständiges Spiel oder als gepackte Anwendung läuft. Die folgenden Schritte sind daher ein Einstieg in die Automatisierung des Editors und der Produktionspipeline, nicht in die Gameplay-Logik.

Voraussetzungen

• Ein Unreal-Engine-Projekt und der Unreal Editor.

• Das Python Editor Script Plugin, das für das Projekt aktiviert werden muss.

• Das Plugin Editor Scripting Utilities für die von der Anleitung empfohlenen, allgemeinen APIs für Editor-Aufgaben.

• Eine separate Python-Installation ist nicht erforderlich: Laut Dokumentation von Epic Games enthält das Python Editor Script Plugin Python 3.11.8 als eingebettete Version.

Die Unreal-Python-API-Dokumentation ist als „5.8 (Experimental)“ gekennzeichnet. Epic Games weist außerdem darauf hin, dass die Funktion experimentell ist und insbesondere bei Projekten, die veröffentlicht werden sollen, mit Vorsicht eingesetzt werden sollte. Testen Sie die beschriebenen Schritte daher zunächst in einer Projektkopie oder einem Testprojekt. In den Quellen wird keine Kontoanforderung genannt.

Schritt für Schritt: Python aktivieren und Code ausführen

1. Plugins im Projekt aktivieren

Öffnen Sie das gewünschte Projekt im Unreal Editor und wählen Sie im Hauptmenü Edit > Plugins. Suchen Sie im Bereich Scripting des Plugin-Fensters nach Python Editor Script Plugin und aktivieren Sie die Option Enabled. Epic Games empfiehlt außerdem, Editor Scripting Utilities zu aktivieren. Dieses Plugin stellt vereinfachte APIs für häufige Editor-Aufgaben bereit.

Die Einstellung muss für jedes Projekt separat vorgenommen werden. Starten Sie den Editor nach dem Aktivieren der Plugins neu. Überspringen Sie diesen Schritt nicht: Laut Anleitung muss der Editor nach der Plugin-Installation neu gestartet werden.

2. Den Python-Modus der Konsole verwenden

Für Tests Zeile für Zeile oder zum sofortigen Ausführen eines kurzen Codeabschnitts stellen Sie die Konsoleneingabe im Bereich Output Log auf den Python-Modus um. Die Konsolenleiste lässt sich auch mit der Taste ~ öffnen. Im Python-Modus werden eingegebene Zeilen sofort ausgeführt. Für mehrere Zeilen können Sie Shift+Enter verwenden oder einen mehrzeiligen Block aus einem Texteditor einfügen.

Diese Methode eignet sich für interaktive Tests. Ausgaben der Funktion print erscheinen ebenfalls im Bereich Output Log. Wenn die Befehlskonsole auf Cmd steht, können Sie mit dem Befehl py den Rest der Zeile als Python ausführen. So lässt sich eine vorhandene Skriptdatei aufrufen:

py "C:\MyScripts\my_script.py"

Der Dateipfad ist ein Beispiel aus der Anleitung und verweist auf den Speicherort des auszuführenden Skripts. Passen Sie ihn für Ihre eigene Datei entsprechend an.

3. Eine Skriptdatei über das File-Menü ausführen

Um eine Datei auszuwählen, die Sie noch nicht ausgeführt haben, wählen Sie im Hauptfenster File > Execute Python Script. Bereits ausgeführte Dateien lassen sich erneut aus der Liste Recent Python scripts auswählen. Da der Editor die Datei erneut von der Festplatte einliest, werden dabei auch die zuletzt vorgenommenen Änderungen am Skript ausgeführt.

So können Sie Code aus einer Datei ausführen, ohne ihn wiederholt in die Konsole einfügen zu müssen. Die Quellen erwähnen keine automatische Sicherheits- oder Validierungsprüfung des Dateiinhalts. Prüfen Sie daher das Skript und das Zielprojekt, bevor Sie es ausführen.

4. Das vollständige Editor-Setup über die Kommandozeile starten

Wenn ein Skript mit Projektinhalten oder einem Level interagiert, dessen Laden einige Zeit dauern kann, eignet sich die Methode, die den vollständigen Unreal Editor startet. Der Editor öffnet das Projekt, lädt das Standard-Startlevel und führt das Skript aus, sobald die Umgebung bereit ist. Das Beispiel für die Windows-Kommandozeile aus der Anleitung:

UnrealEditor-Cmd.exe "C:\projects\MyProject.uproject" -ExecutePythonScript="c:\my_script.py"

Für diese Option muss im Projekt das Plugin Editor Scripting Utilities aktiviert sein. Auch das Python Scripting Plugin muss zuvor in dem in der Anweisung angegebenen Projekt aktiviert worden sein. Laut Anleitung wird der Editor geschlossen, nachdem das Skript ausgeführt wurde.

5. Die headless-Option mit Commandlet prüfen

Die Commandlet-Methode ermöglicht eine schnelle Ausführung ohne geöffnete Editor-Oberfläche, also headless. In der Anleitung werden UnrealEditor-Cmd.exe sowie die Argumente -run=pythonscript und -script gezeigt:

UnrealEditor-Cmd.exe "C:\projects\MyProject.uproject" -run=pythonscript -script="c:\my_script.py"

Bei dieser Methode werden Levels nicht automatisch geladen. Benötigt das Skript ein Level, muss laut Quelle der Aufruf zum Laden des Levels die erste Aktion im Skript sein:

unreal.get_editor_subsystem(unreal.LevelEditorSubsystem).load_level("/Game/maps/UVlayoutTest.UVlayoutTest")

Die Projekt-, Skript- und Levelpfade in den Commandlet-Beispielen sind Beispielwerte aus der Dokumentation. Verwenden Sie sie nicht unverändert, sondern passen Sie sie an die tatsächlichen Pfade Ihres Projekts an.

6. Wiederkehrende Aufgaben beim Start ausführen

Wenn ein Team bei jedem Öffnen desselben Projekts oder Plugins denselben vorbereitenden Code benötigt, lässt sich init_unreal.py verwenden. Findet der Editor eine Datei mit diesem Namen in den konfigurierten Python-Pfaden, führt er sie automatisch aus. Laut Anleitung kann die Datei im Ordner Content/Python des Projekts oder Plugins abgelegt werden.

Um einem Projekt eine oder mehrere Dateien zuzuweisen, die bei jedem Start ausgeführt werden, öffnen Sie unter Edit > Project Settings die Python-Einstellungen unter Plugins > Python und fügen Sie die Skripte im Feld Startup scripts hinzu. Starten Sie den Editor nach der Änderung der Einstellung neu. Die Skripte werden beim nächsten Start ausgeführt, nachdem das Standard-Startlevel vollständig geladen wurde.

Häufige Fehler

• Annehmen, dass die einmalige Aktivierung des Plugins genügt: Das Python Editor Script Plugin muss in jedem Projekt separat aktiviert werden.

• Python zur Laufzeit des Spiels verwenden wollen: Die Funktion ist für den Editor vorgesehen und steht während Play In Editor, Standalone Game und in gepackten Anwendungen nicht zur Verfügung.

• Davon ausgehen, dass das Commandlet das Level automatisch lädt: Die Quelle weist ausdrücklich darauf hin, dass das Commandlet Levels nicht selbstständig lädt.

• Ein Skript zu früh starten: Laut Anleitung sollte ein Skript nicht über den py-Befehl im Startparameter ExecCmd ausgeführt werden, da die Editor-Umgebung oder das Startlevel möglicherweise noch nicht bereit ist.

• Den experimentellen Status außer Acht lassen: Python-Unterstützung wird als experimentell beschrieben. Bei Projekten, die insbesondere vor der Auslieferung oder Veröffentlichung stehen, sollten Sie zuerst kontrollierte Tests durchführen.

Auswirkungen auf Workflows in Architektur und Visualisierung

Für Architektinnen und Architekten, Innenarchitektinnen und Innenarchitekten sowie Archviz-Teams, die Szenen in Unreal Engine erstellen, kann Python die Grundlage für Aufgaben wie die Automatisierung wiederkehrender Arbeitsschritte im Editor, die Verwaltung von Inhalten und deren Platzierung in Levels bilden. Die Quellen enthalten jedoch kein konkretes Skript für die Architekturautomatisierung. Die Anpassung an den eigenen Workflow hängt von den Projektinhalten und dem zu schreibenden Code ab. Die Konsole bietet sich für kurze Tests an; das Ausführen aus einer Datei ist ein geeigneterer Einstieg für wiederverwendbare Skripte.

In den Quellen werden außerdem weder eine leistungsstarke Grafikkarte noch eine kostenpflichtige Lizenz oder ein Konto als Voraussetzung genannt. Daher lässt sich keine eindeutige Aussage zu Hardware- oder Kostenvorteilen treffen. Für Teams sind vor allem drei Punkte entscheidend: ob die Plugins im Projekt aktiviert sind, in welchem Editor-Kontext das Skript läuft und ob sich die experimentelle Funktion für den Auslieferungsprozess eignet.

Nächste Schritte

Aktivieren Sie die Plugins zunächst in einem Testprojekt und vergleichen Sie die Ausführung über die Konsole mit der Methode über das File-Menü. Übertragen Sie danach einmalige Arbeitsschritte in eine Datei und prüfen Sie, ob sich regelmäßig benötigte Vorbereitungsaufgaben als Projekt-Startskripte eignen. Wenn Sie die Funktion über Blueprint nutzen möchten, beachten Sie, dass Python-Knoten nur in Editor-Klassen wie Editor Utility Widget und Editor Utility Blueprint verfügbar sind. Laut Quelle führt der Knoten Execute Python Script einen Codeausschnitt aus, aber keine Datei; für Dateien oder Code gibt es die Option Execute Python Command. Fehlermeldungen erscheinen im Bereich Output Log.

Quelle und Lizenz

Dieser Leitfaden wurde auf Grundlage der Anleitungen von Epic Games zum Einstieg in Python im Unreal Editor und der Python-API-Dokumentation erstellt. Die Quellseiten wurden für diesen Inhalt unter einer freien Lizenz bereitgestellt; der Text wurde ins Türkische übertragen und neu formuliert.