最常用的编辑器API

编辑器API中的MVP

我在的实际的某个工程中统计了EditorAPIs的出现次数，下面这100个API绝对是Unreal Python中的MVP

TIP
下面这些API中，以unreal.Python...Lib和unreal.ChameleonData开头的为TAPython的扩展API，其他的为UE内置的API

交互¶

我们在写编辑器工具的时候，交互相关的API是最常用的，比如弹窗，消息提示，日志，通知，文件对话框等等。

API前的数字表明使用的频率，数字越大则使用越频繁。

• 199：unreal.log_warning

在控制台输出警告信息

• 94: unreal.PythonBPLib.notification

弹出式的通知信息，是这对非开发者用户很友好的通知形式

• 43: unreal.PythonBPLib.get_chameleon_data

通过工具路径找到对应的ChameleonData，用于在A工具中找到B工具的实例。修改其中的内容等等

• 34: unreal.log
• 32: unreal.log_error

在控制台输出Log和出错信息

• 28: unreal.PythonBPLib.confirm_dialog

弹出确认对话框

• 13: unreal.PythonBPLib.open_file_dialog

打开文件对话框

• 8: unreal.PythonBPLib.message_dialog

弹出消息对话框

• 6: unreal.ChameleonData.get_chameleon_window_size

获取Chameleon窗口的大小

• 4: unreal.PythonBPLib.set_clipboard_content

设置剪贴板内容

• 3: unreal.PythonBPLib.open_directory_dialog

打开目录对话框

• 3: unreal.ChameleonData.set_chameleon_window_size

设置Chameleon窗口的大小

• 2: unreal.ChameleonData.request_close

关闭Chameleon窗口，用于在主工具中，关闭其他的Chameleon工具，其他

• 2: unreal.ChameleonData.snapshot_chameleon_window

截图Chameleon窗口中的界面内容，将其保存为png图片

Assets¶

下面包含了和资源相关的API，比如加载资源，获取指定类型的资源，保存资源，删除资源，导入资源等等。

• 105: unreal.load_asset

从路径加载资源

• 26: unreal.EditorAssetLibrary.does_asset_exist

判断资源是否存在

• 25: unreal.EditorAssetLibrary.save_asset

保存指定路径的资源

• 11: unreal.AssetToolsHelpers.get_asset_tools

获取unreal的AssetTools,很多和资源相关的操作都是通过这个AssetTools来完成。例如create_asset,duplicate_asset,export_assets和rename_assets等等

• 5: unreal.PythonBPLib.get_assets_data_by_class

获取特定类型的资源的AssetDatas，比如获取所有关卡资源("World"),或者获取所有的材质实例("MaterialInstance")

• 4: unreal.EditorAssetLibrary.delete_asset

删除指定位置的资源

• 3: unreal.EditorLoadingAndSavingUtils.save_dirty_packages

保存所有已经标脏(已修改,未保存)的资源

• 3: unreal.AssetToolsHelpers.get_asset_tools().import_asset_tasks

其他一个导入资源的task

• 3: unreal.PythonBPLib.get_selected_assets_paths

获取当前选中的资源的路径

• 3: unreal.EditorAssetLibrary.duplicate_loaded_asset

复制已经加载的资源资源

Level/World¶

关卡Level和World也是我们在编辑器经常需要操作的对象，比如获取当前的关卡，获取当前的World，保存当前的关卡，加载关卡等等。

• 24: unreal.EditorLevelLibrary.get_editor_world

获取当前的编辑器World，UE4中使用

• 23: unreal.EditorLevelLibrary.set_selected_level_actors

获取当前选中的所有Actors

• 14: unreal.get_editor_subsystem(unreal.UnrealEditorSubsystem).get_editor_world

获取当前的编辑器World，UE5中使用

• 11: unreal.EditorLevelLibrary.save_current_level

保存当前的关卡

• 10: unreal.EditorLevelLibrary.load_level

通过路径加载关卡

• 9: unreal.EditorLevelLibrary.save_all_dirty_levels

保存所有已标脏(已修改,未保存)的关卡

• 8: unreal.PythonLevelLib.get_levels

获得指定World中的所有level

• 7: unreal.SystemLibrary.get_project_directory

获取当前项目的路径

• 4: unreal.EditorLevelUtils.add_level_to_world

为当前world添加一个关卡

• 4: unreal.EditorLevelLibrary.set_current_level_by_name

通过名字指定当前激活的关卡。我们可以通过get_levels获取所有的关卡，然后通过set_current_level_by_name来激活指定的某一个关卡

Viewport¶

视窗相关的API，可以让我们修改当前视窗中的相机等

• 10: unreal.PythonBPLib.get_level_viewport_camera_info

获取当前场景相机的位置和旋转

• 9: unreal.PythonBPLib.get_viewport_pixels

获取当前视窗中的像素内容,例如将视窗中的内容发送给stable-diffusion等其他工具，就用到了这个API

• 7: unreal.PythonBPLib.viewport_redraw

强制重绘当前视窗，例如我们修改了视窗中的相机观察的对象，并想要截取视窗内容，在截取之前，我们需要确保视窗中的内容是新的，就需要调用这个viewport_redraw

• 4: unreal.PythonBPLib.set_level_viewport_is_in_game_view

将视窗的显示设置为'游戏模式'，等同于在编辑器状态下的快捷键G

• 4: unreal.PythonBPLib.set_level_viewport_camera_info

设置当前场景相机的位置和旋转

Selections¶

下面这些API都是和选中相关的，比如获取当前选中的Actor，获取当前选中的资源，设置当前选中的资源等等。

• 13: unreal.PythonBPLib.select_actor

在编辑中选中指定的Actor

• 9: unreal.PythonBPLib.set_selected_assets_by_paths

在Content Browser中选中指定路径的资源

• 6: unreal.PythonBPLib.set_selected_folder_path

将World Outliner中选择的物体指定到特定Folder.注意这里的Folder是Outliner中的Folder，而不是Content Browser中的

• 5: unreal.get_editor_subsystem(unreal.EditorActorSubsystem).get_selected_level_actors

在编辑中选中指定的Actor, UE5中使用

• 5: unreal.PythonBPLib.select_none

取消选中所有的Actor

• 4: unreal.EditorLevelLibrary.get_selected_level_actors

在编辑中选中指定的Actor, UE4中使用

TIP
在这里,我们会发现有多个API功能比较类似, 例如:unreal.PythonBPLib.select_actor,unreal.get_editor_subsystem(unreal.EditorActorSubsystem).get_selected_level_actors,unreal.EditorLevelLibrary.get_selected_level_actors都是选中指定的Actor。
原因是TAPython最早是在UE4.21的版本开始开发的，陆续添加了一些当时引擎中没有（或者我不知道）的API，同时UE5在逐渐将各个EditorLibrary迁移成各个Subsystem的时候，也造成了重复的API。

Actor/Component¶

场景中的Actor和Component相关的API

• 13: unreal.PythonBPLib.get_objects_by_class

获取编辑器中指定类型的所有对象

• 19: unreal.PythonBPLib.spawn_actor_from_class

通过指定的类创建一个Actor，比如在创建中Spawn一个unreal.StaticMeshActor

• 19: unreal.EditorLevelLibrary.get_all_level_actors

获取当前编辑器中的所有Actor

• 10: unreal.PythonPhysicsAssetLib.get_selected_bodies_indexes

获取当前选中的物理Asset中的所有形体(Body)的索引

• 10: unreal.PythonBPLib.add_component

为指定的Actor添加一个Component。例如给一个Actor添加一个unreal.StaticMeshComponent组件

• 8: unreal.PythonBPLib.find_actor_by_name

获取指定名称（ID Name）的Actor。注意这里是ID Name，不是Actor的Label Name

• 7: unreal.PythonBPLib.spawn_actor_from_object

创建（复制）一个指定的Actor到场景中

• 5: unreal.PythonBPLib.get_selected_components

获取当前选中的所有Component

Query/Modify¶

UE 对象中的编辑器，很大一部分都通过get_editor_property和set_editor_property来获取和设置。各个EditingLibrary也提供了对资源、Object等对象的修改操作。除了这些以外，TAPython也提供了一些API来获取和设置。当然，如果需要更多或者特定的API，也可以自己添加。

• 37: unreal.MaterialEditingLibrary.connect_material_expressions

在材质中连接两个节点

• 22: unreal.MaterialEditingLibrary.create_material_expression

• 17: unreal.MaterialEditingLibrary.create_material_expression_in_function

在材质/材质函数中添加一个材质节点

• 15: unreal.MaterialEditingLibrary.set_material_instance_scalar_parameter_value

• 13: unreal.MaterialEditingLibrary.set_material_instance_texture_parameter_value

• 12: unreal.MaterialEditingLibrary.get_texture_parameter_names

设置/获取材质实例的scalar和texture参数

• 10: unreal.PythonStructLib.add_variable

为UserDefinedStruct添加一个变量

• 10: unreal.MaterialEditingLibrary.get_scalar_parameter_names

获取材质中所有Scalar参数的名称

• 8: unreal.PythonStructLib.get_variable_names

获取UserDefinedStruct中所有变量的名称

• 7: unreal.PythonTextureLib.set_render_target_data

填充RenderTarget中的数据（修改RenderTarget）

• 6: unreal.PythonDataTableLib.get_row_names

获取DataTable中所有行的名称

• 6: unreal.PythonMaterialLib.set_static_switch_parameters_values

设置材质中指定StaticSwitch中的值

• 5: unreal.MaterialEditingLibrary.get_material_instance_texture_parameter_value

获取材质实例中指定Texture参数的值

• 4: unreal.PythonPhysicsAssetLib.get_bodies_from_bone

获取物理资源中指定骨骼上的所有形体（Bodies）

• 4: unreal.PythonStructLib.remove_variable_by_name

移除UserDefinedStruct中指定名称的变量

• 4: unreal.PythonStructLib.add_directory_variable

给User Defined Struct中添加一个字典类型的新变量

• 4: unreal.MaterialEditingLibrary.get_used_textures

获取材质中所有使用的纹理（不会获得在材质中存在，但未连接的贴图）

• 4: unreal.PythonMaterialLib.get_static_switch_parameter_values

获取指定材质的静态开关info，包括是否override等

• 4: unreal.PythonDataTableLib.set_property_by_string_at

设置DataTable中指定位置的内容

• 4: unreal.PythonDataTableLib.get_shape

获取指定DataTable的“行列”信息，不包括标题和行名称，Get the Shape of the given datatable. The title and the row names are not included.

• 4: unreal.PythonDataTableLib.get_column_names

获取指定DataTable中所有列的名称

• 4: unreal.MaterialLibrary.set_scalar_parameter_value

设置材质中指定Scalar参数的值

• 3: unreal.MaterialEditingLibrary.layout_material_expressions

在材质中自动布局节点

• 3: unreal.MaterialEditingLibrary.recompile_material

重新编译材质

• 3: unreal.PythonPhysicsAssetLib.set_body_rotation

设置物理材质中指定的形体（Body）的旋转值

• 3: unreal.PythonStructLib.get_guid_from_property_name

通过PropertyName获取User Defined Struct中指定变量的GUID，在unreal.PythonStructLib.rename_variable等API中，需要使用这个GUID来指定要修改的变量

• 3: unreal.MaterialEditingLibrary.set_material_instance_vector_parameter_value

设置材质实例中指定的Vector参数的值

• 3: unreal.MaterialLibrary.set_vector_parameter_value

• 3: unreal.MaterialEditingLibrary.get_vector_parameter_names

获取/设置材质中所有Vector参数的名称

• 3: unreal.MaterialEditingLibrary.get_material_instance_scalar_parameter_value

获取材质实例中指定的Scalar参数的值

• 3: unreal.PythonDataTableLib.add_row

在DataTable中添加一行

• 3: unreal.PythonDataTableLib.set_property_by_string

设置DataTable中指定位置的内容

• 3: unreal.PythonEnumLib.get_enum_len

获取指定Enum的长度

• 3: unreal.MaterialEditingLibrary.set_material_instance_parent

指定材质实例的父材质

• 3: unreal.MathLibrary.make_rot_from_yz

通过y轴和z轴构造一个旋转值(Rotator)

• 3: unreal.PythonLandscapeLib.add_adjacent_landscape_proxy

在地形的指定方向上创建新的LandscapeProxy

Misc¶

下面是一些杂项API，在我们编写编辑器工具的时候也是非常有用的

• 51: unreal.ScopedSlowTask

用于为耗时任务添加进度条

• 12: unreal.PythonBPLib.exec_python_command

通过字符串，执行Python命令，可在子线程中指定这些python命令是否强制在GameThread中执行

• 10: unreal.get_editor_subsystem

获取Editor Subsystem，常用的SubSystem有：EditorActorSubsystem, AssetEditorSubsystem, LayersSubsystem, UnrealEditorSubsystem, ImportSubsystem, EditorValidatorSubsystem等等

• 8: unreal.ScopedEditorTransaction

用于使得后续操作支持编辑器中Undo，Redo功能

• 6: unreal.PythonBPLib.execute_console_command

通过字符串，执行Cmd中的调试命令

• 5: unreal.PythonBPLib.gc

强制触发UE的垃圾回收

• 5: unreal.GuidLibrary.parse_string_to_guid

将字符串转换为Guid格式。例如"A92FC5D4442EF780C79EB49C16F7250E"转换为Guid

• 4: unreal.PythonBPLib.get_all_deps

• 3: unreal.PythonBPLib.get_all_refs

获取指定对象的所有依赖和引用

• 3: unreal.PythonBPLib.get_modifier_keys_state

获取当前按下的修饰键，例如Shift, Ctrl, Alt等

• 3: unreal.register_slate_post_tick_callback

注册一个Slate Post Tick回调，这个回调会在Slate的Post Tick中执行

参考¶

How to manipulate User Defined ENum, Struct, DataTable with Python in Unreal Engine

Manipulate Material Expression Nodes of Material with Python in Unreal Engine

Modify SImage content and Set Pixels to RenderTarget in Unreal Engine