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

Public function Static

void

 

AsyncBuildCompleted()

Call this when an async custom build step has completed (successfully or not).

Public function Static

bool

 

EditorAutomatedBuildAndSubmit

(
    const FEditorAutomatedBuildSettings...,
    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

bool

 

EditorBuildMaterialTextureStreamingData

(
    UPackage* Package
)

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

 

IsBuildCurrentlyRunning()

Is there currently an (async) build in progress?

Public function Static

bool

 

IsBuildingNavigationFromUserRequest()

Check if navigation build was was triggered from editor as user request

Public function Static

void

 

PathBuildingFinished()

Call it to notify that navigation builder finished building

Public function Static

void

 

RegisterCustomBuildType

(
    FName Id,
    const FDoEditorBuildDelegate& DoBu...,
    FName BuildAllExtensionPoint
)

Register a custom build type.

Public function Static

void

 

UnregisterCustomBuildType

(
    FName Id
)

Unregister a custom build type.

Public function Static

void

 

UpdateTextureStreamingMaterialBindings

(
    UWorld* InWorld
)

Update every used material texture binding (see FMaterialTextureInfo::TextureIndex)

Classes

Name

Description

Public struct

FEditorAutomatedBuildSettings

Helper struct to specify settings for an automated editor build

Enums

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.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback