Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > UnrealEd > FEditorBuildUtils

Light Theme

Dark Theme

FEditorBuildUtils

Utility class to hold functionality for building within the editor

Windows

MacOS

Linux

References

Module	UnrealEd
Header	/Engine/Source/Editor/UnrealEd/Public/EditorBuildUtils.h
Include	#include "EditorBuildUtils.h"

Syntax

class FEditorBuildUtils

Remarks

Utility class to hold functionality for building within the editor

Constructors

No constructors are accessible with public or protected access.

Destructors

No destructors are accessible with public or protected access.

Functions

	Name	Description
void	AsyncBuildCompleted()	Call this when an async custom build step has completed (successfully or not).
bool	EditorAutomatedBuildAndSubmit ( const FEditorAutomatedBuildSettings..., FText& OutErrorMessages )	Start an automated build of all current maps in the editor.
bool	EditorBuild ( UWorld* InWorld, FName Id, const bool bAllowLightingDialog )	Perform an editor build with behavior dependent upon the specified id
void	EditorBuildGrassMaps ( UWorld* InWorld )	Perform an editor build for grass maps
bool	EditorBuildMaterialTextureStreamingData ( UPackage* Package )	Similar to EditorBuildTextureStreaming, but attempts to rebuild TextureStreamingData for all materials in loaded package(s).
bool	EditorBuildTextureStreaming ( UWorld* InWorld, EViewModeIndex SelectedViewMode )	Perform an editor build for texture streaming
bool	EditorBuildVirtualTexture ( UWorld* InWorld )	Perform an editor build for virtual textures
bool	IsBuildCurrentlyRunning()	Is there currently an (async) build in progress?
bool	IsBuildingNavigationFromUserRequest()	Check if navigation build was was triggered from editor as user request
void	PathBuildingFinished()	Call it to notify that navigation builder finished building
void	RegisterCustomBuildType ( FName Id, const FDoEditorBuildDelegate& DoBu..., FName BuildAllExtensionPoint )	Register a custom build type.
void	UnregisterCustomBuildType ( FName Id )	Unregister a custom build type.
void	UpdateTextureStreamingMaterialBindings ( UWorld* InWorld )	Update every used material texture binding (see FMaterialTextureInfo::TextureIndex)

Classes

	Name	Description
	FEditorAutomatedBuildSettings	Helper struct to specify settings for an automated editor build

Enums

	Name	Description
	EAutomatedBuildBehavior	Enumeration representing automated build behavior in the event of an error

Constants

Name	Description
bBuildingNavigationFromUserRequest	Static variable to cache data about user request.
CustomBuildTypes	Map of custom build types registered with us.
InProgressBuildId	Set to a valid build type if an async build is in progress.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss