PyCharm与Unreal Engine集成进行开发-CSDN博客

本文链接：https://blog.csdn.net/testManger/article/details/147559655

以下是将PyCharm与Unreal Engine集成的详细方案，结合开发流程和实战案例，帮助您高效完成Python脚本开发与调试：

一、环境配置与工具链搭建

1. 基础环境准备

Unreal Engine版本：推荐使用UE5.1及以上（Python API更完善）
Python解释器：
- 路径：{UE_Install_Path}/Engine/Binaries/ThirdParty/Python/Win64/Python.exe
- 版本：UE5默认使用Python 3.9（需与PyCharm解释器版本一致）

PyCharm配置：

# 项目结构示例
ProjectRoot/
├── PythonScripts/         # 存放Python脚本
├── Plugins/
│   └── UnrealEnginePython # UnrealEnginePython插件目录
└── .env                   # 环境变量配置

2. 插件安装与启用

UnrealEnginePython插件：
1. 克隆仓库：git clone https://github.com/20tab/UnrealEnginePython.git
2. 移动到项目目录：{ProjectRoot}/Plugins/UnrealEnginePython
3. 启用插件：在UE编辑器中进入Edit > Plugins > Scripting，勾选UnrealEnginePython
Python Editor Script插件：
1. 在UE编辑器中启用Python Editor Script Plugin
2. 生成API文件：Generate Python API（路径：{ProjectRoot}/Intermediate/Python）

3. PyCharm配置

解释器设置：

选择UE内置Python：File > Settings > Project > Python Interpreter

添加搜索路径：

# 右键项目根目录 > Mark Directory as > Sources Root
{ProjectRoot}/PythonScripts
{UE_Install_Path}/Engine/Plugins/Marketplace/UnrealEnginePython/Content/Scripts

虚拟环境：

# 创建虚拟环境（推荐使用conda）
conda create -n ue_python python=3.9
conda activate ue_python

安装依赖：

pip install pydevd pyyaml unreal-engine

二、核心功能开发与调试

1. 脚本开发流程

# PythonScripts/LevelGenerator.py
import unreal

def generate_level():
    # 创建地形
    terrain = unreal.TerrainSubsystem.get_terrain_subsystem().create_terrain("MyTerrain")
    terrain.set_landscape_size(1024, 1024, 100)
    
    # 生成植被
    for _ in range(50):
        location = unreal.Vector(
            unreal.random_float(-500, 500),
            unreal.random_float(-500, 500),
            50
        )
        actor = unreal.EditorLevelLibrary.spawn_actor_from_class(
            unreal.StaticMeshActor, location
        )
        actor.static_mesh_component.set_static_mesh(
            unreal.EditorAssetLibrary.load_asset("/Game/StarterContent/Shapes/Shape_Cube")
        )

if __name__ == "__main__":
    generate_level()

2. 远程调试配置

PyCharm调试配置：

# 1. 添加远程调试配置
# 2. 设置Host为localhost，Port为5678
# 3. 映射本地路径到UE项目路径

UE脚本插入调试代码：

# PythonScripts/LevelGenerator.py
import pydevd_pycharm
pydevd_pycharm.settrace('localhost', port=5678, stdoutToServer=True, stderrToServer=True)

启动调试：
1. 在PyCharm中点击Debug按钮
2. 在UE控制台执行：py run PythonScripts/LevelGenerator.py

3. 性能优化技巧

批量操作：

with unreal.ScopedSlowTask(100, "Generating Level") as task:
    task.make_dialog(True)
    for i in range(100):
        if task.should_cancel():
            break
        task.enter_progress_frame(1, f"Generating object {i}")
        # 生成对象逻辑

异步执行：

unreal.ThreadingUtilities.run_on_sequencer_thread(
    lambda: unreal.log("This runs on the main thread!")
)

三、典型应用场景与案例

1. 自动化关卡生成

需求：快速生成包含地形、植被和建筑的游戏关卡

实现：

# PythonScripts/ProceduralLevel.py
import unreal

class ProceduralLevelGenerator:
    def __init__(self):
        self.terrain_size = 1024
        self.vegetation_density = 0.1
        self.building_count = 5

    def generate(self):
        self.create_terrain()
        self.place_vegetation()
        self.spawn_buildings()

    def create_terrain(self):
        # 地形生成逻辑（省略）

    def place_vegetation(self):
        # 植被分布算法（省略）

    def spawn_buildings(self):
        # 建筑布局逻辑（省略）

if __name__ == "__main__":
    generator = ProceduralLevelGenerator()
    generator.generate()

2. 材质参数批量修改

需求：统一调整场景中所有材质的金属度参数

实现：

# PythonScripts/MaterialUpdater.py
import unreal

def update_material_metallic(metallic_value):
    asset_registry = unreal.AssetRegistryHelpers.get_asset_registry()
    materials = asset_registry.get_assets_by_class(unreal.Material)
    
    with unreal.ScopedEditorTransaction("Update Material Metallic"):
        for material in materials:
            material.set_editor_property("metallic", metallic_value)
            unreal.EditorAssetLibrary.save_asset(material.get_path_name())

if __name__ == "__main__":
    update_material_metallic(0.5)

3. 性能分析与优化

需求：分析场景中Draw Call过高的问题

实现：

# PythonScripts/PerformanceAnalyzer.py
import unreal

def analyze_draw_calls():
    stats = unreal.EditorPerformanceLibrary.get_level_drawcall_stats()
    for stat in stats:
        if stat.draw_count > 10000:
            unreal.log_warning(f"High draw calls: {stat.object_name} - {stat.draw_count}")

if __name__ == "__main__":
    analyze_draw_calls()

四、常见问题与解决方案

问题描述	解决方案
无法导入unreal模块	检查Python解释器路径是否正确，确保UE插件已启用
调试时断点不触发	确认调试端口未被占用，UE脚本中已插入`pydevd_pycharm.settrace()`
打包后脚本失效	将Python脚本目录添加到`项目设置 > 打包 > 额外非资产目录`
性能瓶颈	使用`unreal.ScopedSlowTask`进行进度条显示，避免主线程阻塞
跨版本兼容性问题	检查UE版本对应的Python API文档，使用条件编译处理版本差异

五、进阶技巧与工具链

热重载功能：

# 安装reload包
pip install reload
# 在UE控制台执行
exec(open("PythonScripts/Reloader.py").read())

与蓝图交互：

# 调用蓝图函数
blueprint = unreal.EditorAssetLibrary.load_blueprint('/Game/Blueprints/BP_Test')
unreal.EditorUtilityLibrary.call_blueprint_function(blueprint, 'MyFunction')

CI/CD集成：

# 自动化打包脚本
unrealcli build WindowsNoEditor -project="MyProject.uproject" -script="PythonScripts/BuildScript.py"

通过以上方案，您可以在PyCharm中高效开发Unreal Engine的Python脚本，结合远程调试、性能分析和自动化工具，显著提升开发效率。实际项目中建议采用版本控制（如Git）管理代码，并定期备份UE项目资源。