1. Epic GamesDeveloper
  3. FEditorBuildUtils

FEditorBuildUtils

Utility class to hold functionality for building within the editor

Unreal Engine C++ API Reference > Editor > UnrealEd

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

  Type Name Description
Public function Static void Call this when an async custom build step has completed (successfully or not).
Public function Static bool

EditorAutomatedBuildAndSubmit ( const FEditorAutomatedBuildSettings& BuildSettings,
FText& OutErrorMessages
)

 Start an automated build of all current maps in the editor.
Public function Static bool

EditorBuild ( UWorld* InWorld,
FName Id,
const bool bAllowLightingDialog
)

 Perform an editor build with behavior dependent upon the specified id
Public function Static void Perform an editor build for All Landscape Data
Public function Static bool Similar to EditorBuildTextureStreaming, but attempts to rebuild TextureStreamingData for all materials in loaded package(s).
Public function Static bool

EditorBuildTextureStreaming ( UWorld* InWorld,
EViewModeIndex SelectedViewMode
)

 Perform an editor build for texture streaming
Public function Static bool Perform an editor build for virtual textures
Public function Static bool

EditorCanBuild ( UWorld* InWorld,
FName Id
)

 Validate if the editor build matching the specified id can be executed.
Public function Static void

GetBuildTypes ( TArray< FName >& RegisteredBuildTypes
)

 Fills `RegisteredBuildTypes_ with the names of all build types registered by 'RegisterCustomBuildType'.
Public function Static void

GetBuildTypesLocalizedLabels ( TArray< FText >& RegisteredBuildTypesEntryLabels,
TArray< FText >& RegisteredBuildTypesSectionLabels
)

 Fills provided arrays with localized menu entry and section labels.
Public function Static bool Is there currently an (async) build in progress?
Public function Static bool Check if navigation build was was triggered from editor as user request
Public function Static void Call it to notify that navigation builder finished building
Public function Static void

RegisterCustomBuildType ( const FName Id,
const FDoEditorBuildDelegate& DoBuild,
const FName BuildAllExtensionPoint,
const FText& MenuEntryLabel,
const FText& MenuSectionLabel
)

 Register a custom build type. Register a custom build type.
Public function Static void

RegisterCustomBuildType ( const FName Id,
const FCanDoEditorBuildDelegate& CanDoBuild,
const FDoEditorBuildDelegate& DoBuild,
const FName BuildAllExtensionPoint,
const FText& MenuEntryLabel,
const FText& MenuSectionLabel
)

 Register a custom build type. Register a custom build type.
Public function Static bool

RunWorldPartitionBuilder ( const FString& MapToLoad,
const FText& ProgressText,
const FText& CancelledText,
const FText& FailureText,
const FString& CommandLineArguments
)

 Runs another instance of the current executable with the provided command line arguments.
Public function Static void Unregister a custom build type.
Public function Static void Update every used material texture binding (see FMaterialTextureInfo::TextureIndex)

Classes

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

Enums

  Type Name Description
Public enum 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page