如何在unreal engine 运行时使用python
- User
如何在unreal engine 运行时使用python
Assistant
在 Unreal Engine (UE) 运行时使用 Python 是一个非常常见且强大的需求,可以用于自动化任务、工具开发、游戏逻辑、甚至是与外部系统集成。
核心概念:
- UE Python API: Unreal Engine 提供了一个 Python API,允许你直接访问和操作引擎的功能、对象、蓝图、资产等。
- 运行时与编辑器时:
- 编辑器时 (Editor Time): 在 Unreal Editor 界面中运行 Python 脚本,通常用于自动化内容创建、批量修改资产、编辑器工具等。这是最常见的用法。
- 运行时 (Runtime): 在游戏运行时(Play In Editor, Standalone Game, 打包后的游戏)执行 Python 脚本。这通常用于游戏逻辑、AI 行为、动态内容生成、热重载等。
如何在运行时使用 Python?
在 UE 5 中,实现运行时 Python 主要有以下几种方法:
方法一:通过
PythonScriptPlugin的ExecutePythonCommand(主要且推荐)这是最直接和推荐的方法,特别适用于从蓝图或 C++ 调用 Python。
-
启用插件:
- 确保你的项目启用了
PythonScriptPlugin。前往Edit -> Plugins,搜索 "Python" 并启用它。 - 如果需要打包,请确保在打包设置中将
PythonScriptPlugin包含进去。
- 确保你的项目启用了
-
蓝图调用:
- 在蓝图(例如,Actor 蓝图、GameMode 蓝图等)中,右键搜索
Execute Python Command节点。 - 这个节点有一个
Command输入引脚,你可以输入任何 Python 代码字符串。 - 它还有一个
Execution Mode选项,通常设置为Execute File(执行一个 Python 文件)或Execute Statement(执行一行或多行代码)。 - 示例 (执行语句):
Command:print("Hello from Python in Blueprint!")- 这会在运行时在输出日志中打印消息。
- 示例 (执行文件):
- 首先,将你的 Python 脚本文件(例如
my_runtime_script.py)放在项目的Content/Python文件夹下(或任何你方便访问的地方)。 Command:import my_runtime_script; my_runtime_script.run_my_logic()(假设my_runtime_script.py中有一个run_my_logic函数)Execution Mode:Execute Statement(因为你是在执行一个导入和函数调用语句) 或Execute File(如果你只是想运行整个文件而不需要特定函数)。- 注意路径: 如果你使用
Execute File模式,通常需要提供相对路径或绝对路径。对于Content/Python下的文件,直接import应该可以工作。
- 首先,将你的 Python 脚本文件(例如
- 在蓝图(例如,Actor 蓝图、GameMode 蓝图等)中,右键搜索
-
C++ 调用:
- 在 C++ 代码中,你可以包含
PythonScriptPlugin.h并使用UPythonScriptLibrary::ExecutePythonCommand函数。 - 示例:
#include "PythonScriptLibrary.h" // 包含头文件 void AMyActor::BeginPlay() { Super::BeginPlay(); // 执行一行 Python 代码 UPythonScriptLibrary::ExecutePythonCommand(TEXT("print('Hello from Python in C++!')"), EPythonCommandExecutionMode::ExecuteStatement); // 执行 Python 文件中的函数 // 确保你的 Python 文件位于Content/Python等可被UE识别的路径 // 比如 Content/Python/my_runtime_logic.py, 里面有 def do_something(): UPythonScriptLibrary::ExecutePythonCommand(TEXT("import my_runtime_logic; my_runtime_logic.do_something()"), EPythonCommandExecutionMode::ExecuteStatement); } - 在 C++ 代码中,你可以包含
方法二:注册 Python 回调函数到 UE 事件 (高级)
这种方法允许 Python 脚本监听 UE 的特定事件,并在这些事件发生时自动执行。
-
从 Python 注册:
- 你可以在编辑器启动时运行一个 Python 脚本,该脚本会注册一个在运行时调用的回调函数。
- 例如,注册一个在
BeginPlay时调用的函数:
import unreal import sys # 确保在编辑器启动时运行这个脚本,例如通过init_unreal_engine.py # 或者从编辑器手动执行一次 def on_game_started(): # 这个函数会在游戏开始时被调用 print("Python: Game has started! From runtime callback.") # 你可以在这里执行任何运行时 Python 逻辑 # 注册一个在游戏开始时被调用的委托 # unreal.GameViewportSubsystem().on_game_viewport_created 是一个常用的委托 # 但是对于游戏开始,通常是在蓝图/C++中调用Python来启动你的主循环或注册事件 # 更直接的运行时事件注册可能需要通过 C++ 或更复杂的 Python-C++ 绑定。 # 对于在游戏运行时能够“监听”的事件,通常还是需要从蓝图或C++触发Python。 # 例如,你可以创建一个蓝图函数,暴露给Python,然后在Python中调用这个蓝图函数来触发UE事件。 # 更实用的是:如果你有一个在运行时需要执行的 Python 函数, # 把它放在一个模块里 (例如 `my_game_logic.py`)。 # 然后在你的蓝图或 C++ 中,在 `BeginPlay` 时调用 `UPythonScriptLibrary::ExecutePythonCommand(TEXT("import my_game_logic; my_game_logic.start_game_loop()"))`更实际的运行时回调场景: 通常,Python 脚本在运行时更像一个“服务”或“模块”,而不是直接监听 UE 的原生事件。你会从蓝图/C++ 端调用 Python 来执行任务,或者通过蓝图/C++ 将 UE 事件转发给 Python。
蓝图/C++ 转发示例:
- 蓝图: 创建一个自定义事件
Python_OnEnemyKilled。在敌人死亡时调用这个事件。 - 在
Python_OnEnemyKilled事件中,连接一个Execute Python Command节点,命令为my_game_logic.on_enemy_killed(EnemyActor)。 - Python (
my_game_logic.py):import unreal def on_enemy_killed(enemy_actor): print(f"Python: An enemy {enemy_actor.get_actor_label()} was killed!") # 执行基于敌人死亡的Python逻辑 # 例如,更新分数,生成掉落物,记录日志
这种模式更符合运行时 Python 的使用方式:UE 是主循环,Python 是被调用的辅助逻辑。
方法三:Python 独立进程通信 (适合复杂外部集成)
如果你需要与一个复杂的、长时间运行的外部 Python 应用程序进行通信,可以考虑独立进程通信(IPC)。
- Python 作为独立进程:
- 你的 Python 脚本在一个独立的进程中运行,与 UE 引擎进程是分开的。
- 这对于执行耗时任务、调用外部库(例如数据科学库、HTTP 服务)、或者与自定义的服务器进行通信非常有用。
- 通信机制:
- TCP/UDP Sockets: 最常见和灵活的方式。Python 和 UE 都可以创建 Socket 连接并发送/接收数据。
- Named Pipes (Windows) / Unix Domain Sockets (Linux/Mac): 进程间通信的另一种高效方式。
- Shared Memory: 更复杂,但性能最高。
- HTTP/WebSockets: 如果你的 Python 服务是一个 Web API,UE 可以作为客户端发出请求。
- 在 UE 中触发:
- 在蓝图或 C++ 中,你可以使用
Launch Process节点(蓝图)或FPlatformProcess::CreateProc(C++)来启动你的独立 Python 脚本。 - 然后通过 Socket 或其他 IPC 机制进行通信。
- 注意: 这需要你在打包游戏时,确保你的 Python 解释器和脚本文件也被包含在打包内容中,或者在目标机器上已预装 Python。
- 在蓝图或 C++ 中,你可以使用
运行时 Python 脚本的位置
Content/Python文件夹 (推荐):- 将你的 Python 脚本
.py文件放在这个文件夹或其子文件夹中。 - UE 会自动将这些文件识别为 Python 模块,可以在
ExecutePythonCommand中直接import。 - 这个路径在打包时通常也会被包含进去。
- 将你的 Python 脚本
- 其他路径:
- 你也可以将脚本放在项目根目录下的
Scripts文件夹或其他自定义文件夹。 - 如果这样,你可能需要手动修改
sys.path来让 Python 找到这些模块,或者在ExecutePythonCommand中使用完整的相对/绝对路径。 - 对于打包后的游戏,你必须确保这些文件确实被打包进了游戏目录,并且 Python 解释器能够找到它们。
- 你也可以将脚本放在项目根目录下的
注意事项和最佳实践
- 性能: Python 代码的执行速度通常比 C++ 慢。对于性能敏感的游戏逻辑,尽量用 C++ 或蓝图实现。Python 更适合非性能关键的逻辑、数据处理、工具和集成。
- 错误处理: 确保你的 Python 脚本有适当的错误处理(
try-except块)。当 Python 脚本出错时,错误信息会显示在 UE 的输出日志中。 - 打包:
- 确保
PythonScriptPlugin在打包设置中是启用的。 - 确保所有依赖的 Python 脚本和模块都正确地包含在打包的游戏中。
- 嵌入式 Python:
PythonScriptPlugin默认会打包一个嵌入式 Python 解释器到你的游戏中,所以用户不需要预装 Python。这是非常方便的。
- 确保
- 日志: 使用
print()函数在 Python 脚本中输出调试信息,它们会出现在 Unreal Editor 的Output Log或打包游戏的日志文件中。你也可以使用unreal.log(),unreal.log_warning(),unreal.log_error()来使用 UE 的日志系统。 - 异步操作: 对于长时间运行的 Python 任务,考虑使用线程(如果 Python 内部支持)或将任务分解,并通过事件或回调与 UE 异步通信,避免阻塞游戏主线程。
- 版本兼容性: 确保你使用的 Python API 和引擎版本兼容。
- UE API 访问: 在运行时,你仍然可以访问
unreal模块,例如unreal.GameplayStatics,unreal.find_object,unreal.get_all_actors_of_class等,但要注意这些 API 主要是为编辑器时设计的,某些在运行时可能不可用或行为不同。
通过以上方法,你可以在 Unreal Engine 运行时有效地利用 Python 的灵活性和强大的生态系统。
Other models, same or similar prompt
Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.