unreal.EditorUtilityLibrary

class unreal.EditorUtilityLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

Expose editor utility functions to Blutilities

C++ Source:

  • Module: Blutility

  • File: EditorUtilityLibrary.h

classmethod add_source_widget(widget_blueprint, widget_class, widget_name, widget_parent_name) → Widget

Create a new widget and add to the specific widget blueprint’s widget tree

Parameters:

  • widget_blueprint (WidgetBlueprint) – The widget blueprint to add a widget to

  • widget_class (type(Class)) – The widget class to add to the widget blueprint

  • widget_name (Name) – The name to give the new widget

  • widget_parent_name (Name) – The name of the existing widget that will hold the new widget. Must be an existing Panel Widget or none of if the widget tree is empty and the new widget will become the RootWidget.

Returns:

The widget that was created and added to the widget blueprint

Return type:

Widget

classmethod cast_to_widget_blueprint(object) -> (branches=CastToWidgetBlueprintCases, as_widget_blueprint=WidgetBlueprint)

Cast to Widget Blueprint

Parameters:

object (Object)

Returns:

branches (CastToWidgetBlueprintCases):

as_widget_blueprint (WidgetBlueprint):

Return type:

tuple

classmethod convert_to_editor_utility_widget(widget_bp) → None

Convert to Editor Utility Widget

Parameters:

widget_bp (WidgetBlueprint)

classmethod find_source_widget_by_name(widget_blueprint, widget_name) → Widget

Searches the blueprint’s widget hierarchy for a widget with the specified name

Parameters:
Return type:

Widget

get_actor_reference(path_to_actor) → Actor

Attempts to find the actor specified by PathToActor in the current editor world

Parameters:

path_to_actor (str) – The path to the actor (e.g. PersistentLevel.PlayerStart)

Returns:

A reference to the actor, or none if it wasn’t found

Return type:

Actor

classmethod get_current_content_browser_item_path() → ContentBrowserItemPath

Gets the current content browser path if one is open, whether it is internal or virtual.

Return type:

ContentBrowserItemPath

classmethod get_current_content_browser_path() → str or None

Attempts to get the path for the active content browser, returns false if there is no active content browser or if it was a virtual path

Returns:

Whether a path was successfully returned

out_path (str): The returned path if successfully found

Return type:

str or None

classmethod get_selected_asset_data() → Array[AssetData]

Gets the set of currently selected asset data

Return type:

Array[AssetData]

classmethod get_selected_assets() → Array[Object]

Gets the set of currently selected assets

Return type:

Array[Object]

classmethod get_selected_assets_of_class(asset_class) → Array[Object]

Get Selected Assets Of Class

Parameters:

asset_class (type(Class))

Return type:

Array[Object]

classmethod get_selected_blueprint_classes() → Array[type(Class)]

Gets the set of currently selected classes

Return type:

Array[type(Class)]

classmethod get_selected_folder_paths() → Array[str]

Gets the path to the currently selected folder in the content browser

Return type:

Array[str]

classmethod get_selected_path_view_folder_paths() → Array[str]

Returns the folders that are selected in the path view for the content browser

Return type:

Array[str]

classmethod get_selection_bounds() -> (origin=Vector, box_extent=Vector, sphere_radius=float)

Get Selection Bounds

Returns:

origin (Vector):

box_extent (Vector):

sphere_radius (float):

Return type:

tuple

classmethod get_selection_set() → Array[Actor]

Get Selection Set

Return type:

Array[Actor]

classmethod rename_asset(asset, new_name) → None

Renames an asset (cannot move folders)

Parameters:
classmethod sync_browser_to_folders(folder_list) → None

Sync the Content Browser to the given folder(s)

Parameters:

folder_list (Array[str]) – The list of folders to sync to in the Content Browser