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 > FUnrealEdMisc

Light Theme

Dark Theme

FUnrealEdMisc

The public interface for the unreal editor misc singleton.

Windows

MacOS

Linux

References

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

Syntax

class FUnrealEdMisc

Remarks

The public interface for the unreal editor misc singleton.

Constructors

	Name	Description
	FUnrealEdMisc()	Constructor, private - use Get() function

Destructors

	Name	Description
	~FUnrealEdMisc()	Destructor

Functions

	Name	Description
void	AllowSavingLayoutOnClose ( bool bIsEnabled )	Sets whether saving the layout on close is allowed.
void	BeginPerformanceSurvey()	Start the performance survey that attempts to monitor editor performance in the default or simple startup maps
void	CancelPerformanceSurvey()	End the performance survey that attempts to monitor editor performance in the default or simple startup maps
void	CB_DisplayLoadErrors()
void	CB_EditorModeWindowClosed ( const TSharedRef< SWindow >& )
void	CB_LevelActorsAdded ( AActor* InActor )
void	CB_MapChange ( uint32 InFlags )	Tells the editor that something has been done to change the map.
void	CB_PostAutomationTesting()	Called right after unit testing concludes
void	CB_PreAutomationTesting()	Called right before unit testing is about to begin
void	CB_RedrawAllViewports()
void	CB_RefreshEditor()
void	CB_SelectedProps()	Displays a property dialog based upon what is currently selected.
void	ClearConfigRestoreFilename ( FString Destination )	Clears the config restore name for restoring the specified config file
void	ClearConfigRestoreFilenames()	Clears all the restore names for restoring config files
void	ClearPendingProjectName()	Clear the project name we will use to reload the editor when switching projects
void	EditorAnalyticsHeartbeat()	Called when the heartbeat event should be sent to engine analytics
bool	EnableWorldComposition ( UWorld* InWorld, bool bEnable )	Handles "Enable World Composition" option in WorldSettings
FString	FindMapFileFromPartialName ( const FString& PartialMapName )	Finds a map using only the map name, no extension, no path, also caches it for faster lookup next time.
void	ForceDeletePreferences ( bool bIsEnabled )	Sets whether the preferences file should be deleted.
FString	GenerateURL ( const FString& InUDNPage )	Delegate for URL generation, used to generate UDN pages
FUnrealEdMis...	Get()	Singleton accessor
EAutosaveSta...	GetAutosaveState()	Fetches the current state of the autosave in progress
const TMap< ...	GetConfigRestoreFilenames()	Retrieves the map of config->backup config filenames to be used for restoring config files
FString	GetExecutableForCommandlets()	Returns the editor executable to use to execute commandlets
bool	GetMapBuildCancelled()	Whether or not the map build in progressed was cancelled by the user.
const FStrin...	GetPendingProjectName()	Get the project name we will use to reload the editor when switching projects
bool	GetURL ( const TCHAR* InKey, FString& OutURL, const bool bCheckRocket )	Fetches a URL from the config and optionally switches it to rocket if required
void	InitEngineAnalytics()	Initialize engine analytics
bool	IsDeletePreferences()	Returns true if preferences should be deleted.
bool	IsSavingLayoutOnClosedAllowed()	Returns true if saving layout on close is allowed.
void	LogAssetUpdate ( UObject* UpdatedAsset )	Logs an update to an asset
void	MountTemplateSharedPaths()	Check if this we are editing a template project, and if so mount any shared resource paths it uses
void	OnActiveTabChanged ( TSharedPtr< SDockTab > PreviouslyAc..., TSharedPtr< SDockTab > NewlyActivat... )	Called from tab manager when the tab changes
void	OnDeferCommand ( const FString& DeferredCommand )	Delegate that gets called by modules that can't directly access Engine
void	OnEditorChangeMode ( FEditorModeID NewEditorMode )
void	OnEditorPostModal()
void	OnEditorPreModal()
void	OnExit()	Cleans up various systems
FText	OnGetDisplayName ( const UObject* InObject, const bool bFullPath )	Delegate for (default) display name of UObject tokens.
void	OnGotoAsset ( const FString& InAssetPath )	Delegate used to go to assets in the content browser
void	OnInit()	Initalizes various systems
void	OnMapChanged ( UWorld* World, EMapChangeType MapChangeType )	Called when a map is changed (loaded,saved,new map, etc)
void	OnMessageSelectionChanged ( TArray< TSharedRef< class FTokenize... )	Delegate for (default) message log message selection - selects the objects that the tokens refer to (if any)
void	OnMessageTokenActivated ( const TSharedRef< class IMessageTok... )	Delegate for (default) message log UObject token activation - selects the object that the token refers to (if any)
void	OnObjectSaved ( UObject* SavedObject )	Delegate used to update the map of asset update counts
void	OnTabForegrounded ( TSharedPtr< SDockTab > ForegroundTa..., TSharedPtr< SDockTab > BackgroundTa... )
void	OnUserActivityTabChanged ( TSharedPtr< SDockTab > InTab )
void	OnUserDefinedChordChanged ( const FUICommandInfo& CommandInfo )	Called when the input manager records a user-defined chord
void	OnWorldSaved ( uint32 SaveFlags, UWorld* SavedWorld )	Delegate used to update the map of asset update counts (for UWorlds specifically)
void	OpenMarketplace ( const FString& CustomLocation )	Opens the Unreal Engine Launcher marketplace page
void	PreSaveWorld ( uint32 SaveFlags, UWorld* World )
void	RestartEditor ( bool bWarn )	Restarts the editor, reopening the current project, if any
void	SetAutosaveState ( const EAutosaveState::Type InState )	Sets the new state for the autosave
void	SetConfigRestoreFilename ( FString InBackupFile, FString InConfigFile )	Sets the config file to use for restoring Config files.
void	SetMapBuildCancelled ( const bool InCancelled )	Sets the flag that states whether or not the map build was cancelled.
void	SetPendingProjectName ( const FString& ProjectName )	Set the project name we will use to reload the editor when switching projects
void	ShutdownAfterError()	Performs any required cleanup in the case of a fatal error.
void	SwitchProject ( const FString& GameOrProjectFileNa..., bool bWarn )	Opens the specified project file or game. Restarts the editor
void	TickAssetAnalytics()	Triggers asset analytics if it hasn't been run yet
void	TickPerformanceAnalytics()	Ticks the performance analytics used by the analytics heartbeat

Classes

	Name	Description
	EAutosaveState	The various autosave states that exist

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

Take our survey

Dismiss