Automatización con Python en Unreal Engine: activa el plugin y ejecuta tu primer script

Qué aprenderás en esta guía

Para empezar a usar Python en Unreal Editor, primero hay que activar el plugin correspondiente en el proyecto y, después, ejecutar el código con el método adecuado. Esta guía explica cómo configurar el plugin, ejecutar código desde la consola, ejecutar un archivo Python y usar opciones para que la automatización pueda repetirse más adelante. Epic Games presenta Python en el editor como una herramienta para gestionar assets, colocar contenido en niveles y automatizar algunas tareas que llevan tiempo.

Es importante tener en cuenta el alcance: este entorno de Python es para Unreal Editor. El código Python no se puede utilizar mientras el proyecto se ejecuta en el modo Play In Editor, como juego independiente o como aplicación empaquetada. Por tanto, lo que se explica aquí sirve como punto de partida para automatizar el editor y el pipeline de producción, no para implementar la lógica de gameplay.

Requisitos

• Un proyecto de Unreal Engine y Unreal Editor.

• Python Editor Script Plugin, que debe activarse en el proyecto.

• El plugin Editor Scripting Utilities, recomendado en la guía para acceder a API comunes de operaciones del editor.

• No hace falta instalar Python por separado: según la documentación de Epic Games, Python Editor Script Plugin incluye Python 3.11.8.

La documentación de Unreal Python API está marcada como “5.8 (Experimental)”. Epic Games también advierte que esta función es experimental y que debe usarse con precaución, especialmente en proyectos que se acercan a su lanzamiento. Por eso, conviene probar primero estos pasos en una copia del proyecto de producción o en un proyecto de prueba. Las fuentes tampoco indican que se necesite una cuenta.

Paso a paso: activa Python y ejecuta código

1. Activa los plugins en el proyecto

Abre el proyecto correspondiente en Unreal Editor y ve a Edit > Plugins en el menú principal. En la sección Scripting de la ventana de plugins, busca Python Editor Script Plugin y activa la opción Enabled. Epic Games también recomienda activar Editor Scripting Utilities, que ofrece API simplificadas para operaciones habituales del editor.

Esta configuración se debe realizar por separado en cada proyecto. Reinicia el editor después de activar los plugins. No omitas este paso: la guía indica que hay que reiniciar el editor tras instalar el plugin.

2. Usa el modo Python de la consola

Para probar código línea por línea o ejecutar inmediatamente un fragmento breve, cambia la entrada de la consola del panel Output Log al modo Python. También puedes abrir la barra de entrada de la consola con la tecla ~. Las líneas que escribas en modo Python se ejecutan de inmediato; para introducir varias líneas, puedes usar Shift+Enter o pegar un bloque de varias líneas desde un editor de texto.

Este método es adecuado para hacer pruebas interactivas. El resultado de la función print también se muestra en el panel Output Log. Si la consola de comandos está en modo Cmd, puedes ejecutar el resto de la línea como Python con el comando py. Este es un ejemplo para llamar a un archivo de script existente:

py "C:\MyScripts\my_script.py"

La ruta del archivo es un ejemplo de la guía que indica dónde está el script que se va a ejecutar; tendrás que cambiarla por la ruta de tu propio archivo.

3. Ejecuta un archivo de script desde el menú File

Para seleccionar un archivo que aún no hayas ejecutado, usa File > Execute Python Script en la ventana principal. Los archivos ejecutados anteriormente se pueden volver a seleccionar desde la lista Recent Python scripts. Como el editor vuelve a leer el archivo desde el disco, también se ejecutarán los últimos cambios realizados en el script.

Este método permite ejecutar código desde un archivo sin tener que pegarlo repetidamente en la consola. La fuente no menciona ningún paso automático de seguridad o validación del contenido del archivo; por eso, revisa el script y el proyecto de destino antes de ejecutarlo.

4. Ejecuta el editor completo desde la línea de comandos

Si el script interactúa con el contenido del proyecto o con un nivel cuya carga puede llevar tiempo, puedes utilizar el método que inicia Unreal Editor completo. El editor abre el proyecto, carga el nivel de inicio predeterminado y ejecuta el script cuando el entorno está listo. Este es el ejemplo de línea de comandos de Windows incluido en la guía de origen:

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

Para utilizar esta opción, Editor Scripting Utilities debe estar activado en el proyecto; Python Scripting Plugin también debe haberse activado previamente en el proyecto especificado en el comando. Según la guía, el editor se cierra cuando termina el script.

5. Considera la opción de commandlet sin interfaz

El método de commandlet permite ejecutar scripts rápidamente y sin abrir la interfaz del editor, es decir, en modo headless. La guía muestra cómo usar UnrealEditor-Cmd.exe con los argumentos -run=pythonscript y -script:

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

Este método no carga niveles automáticamente. Si el script necesita un nivel, la fuente indica que la llamada para cargarlo debe ser la primera tarea del script:

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

Las rutas del proyecto, del script y del nivel en los ejemplos de commandlet son valores de muestra de la documentación; no deben usarse sin adaptarlas a las ubicaciones del proyecto real.

6. Ejecuta tareas repetitivas al iniciar

Puedes utilizar init_unreal.py cuando un equipo que trabaja con el mismo proyecto o plugin necesita ejecutar el mismo código de preparación cada vez que se inicia el editor. Si el editor encuentra un archivo con ese nombre en las rutas de Python configuradas, lo ejecuta automáticamente. La guía indica que el archivo se puede colocar en la carpeta Content/Python del proyecto o del plugin.

Para asignar uno o varios archivos que se ejecuten cada vez que se abra un proyecto, ve a Edit > Project Settings, entra en Plugins > Python y añade los scripts al campo Startup scripts. Reinicia el editor después de cambiar la configuración; los scripts se ejecutarán la próxima vez que se inicie, una vez que se haya cargado por completo el nivel de inicio predeterminado.

Errores frecuentes

• Pensar que basta con activar el plugin una sola vez: Python Editor Script Plugin se activa por separado en cada proyecto.

• Intentar usar Python durante la ejecución del juego: esta función es para el editor; no se puede utilizar en Play In Editor, Standalone Game ni durante la ejecución de una aplicación empaquetada.

• Suponer que el commandlet cargará el nivel automáticamente: la fuente señala específicamente que el commandlet no carga niveles por sí solo.

• Iniciar el script antes de que esté listo: la guía no recomienda ejecutar scripts con el comando py en el parámetro de inicio ExecCmd; puede que el entorno del editor o el nivel de inicio aún no estén listos.

• Pasar por alto que es una función experimental: la compatibilidad con Python se describe como experimental. Conviene probarla en un entorno controlado, sobre todo si el proyecto se va a entregar o publicar.

Efectos en los flujos de trabajo de arquitectura y visualización

Para arquitectos, diseñadores de interiores y equipos de archviz que crean escenas en Unreal Engine, Python puede servir de base para automatizar tareas repetitivas en el editor, gestionar contenido y colocar elementos en niveles mediante scripts. Sin embargo, las fuentes no proporcionan un script específico de automatización arquitectónica; su adaptación al flujo de trabajo depende del contenido del proyecto y del código que se escriba. La consola es un buen punto de partida para pruebas breves, mientras que ejecutar un archivo resulta más adecuado para scripts reutilizables.

Las fuentes tampoco mencionan como requisito una tarjeta gráfica potente, una licencia de pago o una cuenta. Por tanto, no es posible concluir nada concreto sobre ventajas de hardware o costes. Para los equipos, los principales aspectos que deben comprobarse son si los plugins están activados en el proyecto, en qué contexto del editor se ejecuta el script y si el carácter experimental de la función es adecuado para el proceso de entrega.

Próximos pasos

Empieza por activar los plugins en un proyecto de prueba y comparar los métodos de ejecución desde la consola y el menú File. Después, pasa las tareas puntuales a archivos; para las tareas de preparación que deban ejecutarse con regularidad, considera usar scripts de inicio del proyecto. Si necesitas integrarlos con Blueprint, recuerda que los nodos de Python solo se pueden utilizar en clases del editor como Editor Utility Widget y Editor Utility Blueprint. Según la fuente, el nodo Execute Python Script ejecuta un fragmento de código, no un archivo; la opción Execute Python Command permite ejecutar un archivo o código. Los mensajes de error se pueden consultar en el panel Output Log.

Fuentes y licencia

Esta guía se elaboró a partir de la documentación de Epic Games sobre cómo empezar a usar Python en Unreal Editor y la documentación de Python API. Las páginas de origen se proporcionaron con licencia libre para este contenido; el texto se reescribió y adaptó al turco.