1. Epic GamesDeveloper
  3. UEditorLevelLibrary

UEditorLevelLibrary

Utility class to do most of the common functionalities in the World Editor.

API > API/Plugins > API/Plugins/EditorScriptingUtilities

Utility class to do most of the common functionalities in the World Editor. The editor should not be in play in editor mode.

   
Name UEditorLevelLibrary
Type class
Header File /Engine/Plugins/Editor/EditorScriptingUtilities/Source/EditorScriptingUtilities/Public/EditorLevelLibrary.h
Include Path #include "EditorLevelLibrary.h"

Syntax

UCLASS (MinimalAPI)  
class UEditorLevelLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static void ClearActorSelectionSet()

 Remove all actors from the selection set EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Development|Editor"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Editor Actor Utilities Subsystem")

static TArray< class AActor * > ConvertActors ( const TArray< class AActor* >& Actors,
TSubclassOf< class AActor > ActorClass,
const FString& StaticMeshPackagePath
)

 Replace in the level all Actors provided with a new actor of type ActorClass. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep"
  • Meta=(DeterminesOutputType="ActorClass", DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Editor Actor Utilities Subsystem")

static bool CreateProxyMeshActor ( const TArray< class AStaticMeshActor* >& ActorsToMerge,
const FCreateProxyMeshActorOptions& MergeOptions,
AStaticMeshActor*& OutMergedActor
)

 Build a proxy mesh actor that can replace a set of mesh actors. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Static Mesh Editor Subsystem")

static bool CreateProxyMeshActor ( const TArray< class AStaticMeshActor* >& ActorsToMerge,
const FEditorScriptingCreateProxyMeshActorOptions_Deprecated& MergeOptions,
AStaticMeshActor*& OutMergedActor
)

 Build a proxy mesh actor that can replace a set of mesh actors. EditorLevelLibrary.h  

static bool DestroyActor ( AActor* ActorToDestroy
)

 Destroy the actor from the world editor. Notify the Editor that the actor got destroyed. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Editor Actor Utilities Subsystem")

static void EditorEndPlay()

   EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DevelopmentOnly)

static void EditorInvalidateViewports()

   EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DevelopmentOnly, DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Level Editor Subsystem")

static void EditorPlaySimulate()

   EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DevelopmentOnly, DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Level Editor Subsystem")

static void EditorSetGameView ( bool bGameView
)

   EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DevelopmentOnly, DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Level Editor Subsystem")

static void EjectPilotLevelActor()

   EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DevelopmentOnly, DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Level Editor Subsystem")

static AActor * GetActorReference ( FString PathToActor
)

 Attempts to find the actor specified by PathToActor in the current editor world EditorLevelLibrary.h
  • BlueprintPure
  • Category="Development|Editor"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Editor Actor Utilities Subsystem")

static TArray< class AActor * > GetAllLevelActors ()

 Find all loaded Actors in the world editor. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Editor Actor Utilities Subsystem")
Find all loaded ActorComponent own by an actor in the world editor. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Editor Actor Utilities Subsystem")

static UWorld * GetEditorWorld ()

 Find the World in the world editor. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Unreal Editor Subsystem")

static UWorld * GetGameWorld()

   EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Unreal Editor Subsystem")

static bool GetLevelViewportCameraInfo ( FVector& CameraLocation,
FRotator& CameraRotation
)

 Gets information about the camera position for the primary level editor viewport. EditorLevelLibrary.h
  • BlueprintPure
  • Category="Development|Editor"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Unreal Editor Subsystem")

static TArray< UWorld * > GetPIEWorlds ( bool bIncludeDedicatedServer
)

   EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"

static TArray< class AActor * > GetSelectedLevelActors ()

 Find all loaded Actors that are selected in the world editor. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Editor Actor Utilities Subsystem")

static AActor * JoinStaticMeshActors ( const TArray< class AStaticMeshActor* >& ActorsToJoin,
const FJoinStaticMeshActorsOptions& JoinOptions
)

 The functions below are BP exposed copies of functions that use deprecated structs, updated to the new structs in StaticMeshEditorSubsytem The old structs redirect to the new ones, so this makes blueprints that use the old structs still work The old functions are still available as an overload, which makes old code that uses them compatible Create a new Actor in the level that contains a duplicate of all the Actors Static Meshes Component. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Static Mesh Editor Subsystem")

static AActor * JoinStaticMeshActors ( const TArray< class AStaticMeshActor* >& ActorsToJoin,
const FEditorScriptingJoinStaticMeshActorsOptions_Deprecated& JoinOptions
)

 Create a new Actor in the level that contains a duplicate of all the Actors Static Meshes Component. EditorLevelLibrary.h  

static bool LoadLevel ( const FString& AssetPath
)

 Close the current Persistent Level (without saving it). Loads the specified level. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Level Editor Subsystem")

static bool MergeStaticMeshActors ( const TArray< class AStaticMeshActor* >& ActorsToMerge,
const FMergeStaticMeshActorsOptions& MergeOptions,
AStaticMeshActor*& OutMergedActor
)

 Merge the meshes into a unique mesh with the provided StaticMeshActors. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Static Mesh Editor Subsystem")

static bool MergeStaticMeshActors ( const TArray< class AStaticMeshActor* >& ActorsToMerge,
const FEditorScriptingMergeStaticMeshActorsOptions_Deprecated& MergeOptions,
AStaticMeshActor*& OutMergedActor
)

 Merge the meshes into a unique mesh with the provided StaticMeshActors. EditorLevelLibrary.h  

static bool NewLevel ( const FString& AssetPath
)

 Close the current Persistent Level (without saving it). EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Level Editor Subsystem")

static bool NewLevelFromTemplate ( const FString& AssetPath,
const FString& TemplateAssetPath
)

 Close the current Persistent Level (without saving it). EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Level Editor Subsystem")

static void PilotLevelActor ( AActor* ActorToPilot
)

   EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DevelopmentOnly, DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Level Editor Subsystem")

static void ReplaceMeshComponentsMaterials ( const TArray< class UMeshComponent* >& MeshComponents,
UMaterialInterface* MaterialToBeReplaced,
UMaterialInterface* NewMaterial
)

 Find the references of the material MaterialToReplaced on all the MeshComponents provided and replace it by NewMaterial. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Static Mesh Editor Subsystem")

static void ReplaceMeshComponentsMaterialsOnActors ( const TArray< class AActor* >& Actors,
UMaterialInterface* MaterialToBeReplaced,
UMaterialInterface* NewMaterial
)

 Find the references of the material MaterialToReplaced on all the MeshComponents of all the Actors provided and replace it by NewMaterial. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Static Mesh Editor Subsystem")

static void ReplaceMeshComponentsMeshes ( const TArray< class UStaticMeshComponent* >& MeshComponents,
UStaticMesh* MeshToBeReplaced,
UStaticMesh* NewMesh
)

 Find the references of the mesh MeshToBeReplaced on all the MeshComponents provided and replace it by NewMesh. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Static Mesh Editor Subsystem")

static void ReplaceMeshComponentsMeshesOnActors ( const TArray< class AActor* >& Actors,
UStaticMesh* MeshToBeReplaced,
UStaticMesh* NewMesh
)

 Find the references of the mesh MeshToBeReplaced on all the MeshComponents of all the Actors provided and replace it by NewMesh. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Static Mesh Editor Subsystem")

static void ReplaceSelectedActors ( const FString& InAssetPath
)

 Replaces the selected Actors with the same number of a different kind of Actor using the specified factory to spawn the new Actors note that only Location, Rotation, Drawscale, Drawscale3D, Tag, and Group are copied from the old Actors EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"

static bool SaveAllDirtyLevels()

 Saves all Level currently loaded by the World Editor. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Level Editor Subsystem")

static bool SaveCurrentLevel()

 Saves the specified Level. Must already be saved at lease once to have a valid path. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Level Editor Subsystem")

static void SelectNothing()

 Selects nothing in the editor (another way to clear the selection) EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Development|Editor"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Editor Actor Utilities Subsystem")

static void SetActorSelectionState ( AActor* Actor,
bool bShouldBeSelected
)

 Set the selection state for the selected actor EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Development|Editor"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Editor Actor Utilities Subsystem")

static bool SetCurrentLevelByName ( FName LevelName
)

 Set the current level used by the world editor. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Level Editor Subsystem")

static void SetLevelViewportCameraInfo ( FVector CameraLocation,
FRotator CameraRotation
)

 Sets information about the camera position for the primary level editor viewport. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Development|Editor"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Unreal Editor Subsystem")

static void SetSelectedLevelActors ( const TArray< class AActor* >& ActorsToSelect
)

 Clear the current world editor selection and select the provided actors. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DeprecatedFunction, DeprecationMessage="The Editor Scripting Utilities Plugin is deprecated - Use the function in Editor Actor Utilities Subsystem")

static AActor * SpawnActorFromClass ( TSubclassOf< class AActor > ActorClass,
FVector Location,
FRotator Rotation,
bool bTransient
)

 Create an actor and place it in the world editor. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(DeterminesOutputType="ActorClass", KeyWords="Transient")

static AActor * SpawnActorFromObject ( UObject* ObjectToUse,
FVector Location,
FRotator Rotation,
bool bTransient
)

 Create an actor and place it in the world editor. EditorLevelLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Level Utility"
  • Meta=(KeyWords="Transient")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page