1. Epic GamesDeveloper
  3. FUnrealEdMisc

FUnrealEdMisc

The public interface for the unreal editor misc singleton.

API > API/Editor > API/Editor/UnrealEd

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

  Type Name Description
Public function   Constructor, private - use Get() function

Destructors

  Type Name Description
Public function Virtual   Destructor

Functions

  Type Name Description
Public function void

AllowSavingLayoutOnClose ( bool bIsEnabled
)

 Sets whether saving the layout on close is allowed.
Public function void Start the performance survey that attempts to monitor editor performance in the default or simple startup maps
Public function void End the performance survey that attempts to monitor editor performance in the default or simple startup maps
Public function void  
Public function void  
Public function void  
Public function void

CB_MapChange ( uint32 InFlags
)

 Tells the editor that something has been done to change the map.
Public function void Called right after unit testing concludes
Public function void Called right before unit testing is about to begin
Public function void  
Public function void  
Public function void Displays a property dialog based upon what is currently selected.
Public function void Clears the config restore name for restoring the specified config file
Public function void Clears all the restore names for restoring config files
Public function void Clear the project name we will use to reload the editor when switching projects
Public function void Called when the heartbeat event should be sent to engine analytics
Public function bool

EnableWorldComposition ( UWorld* InWorld,
bool bEnable
)

 Handles "Enable World Composition" option in WorldSettings
Public function 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.
Public function void

ForceDeletePreferences ( bool bIsEnabled
)

 Sets whether the preferences file should be deleted.
Public function Static FUnrealEdMisc &

Get ()

 Singleton accessor
Public function const TMap< FString, FString > & Retrieves the map of config->backup config filenames to be used for restoring config files
Public function Const FString Returns the editor executable to use to execute commandlets
Public function Const bool Whether or not the map build in progressed was cancelled by the user.
Public function Const const FString & Get the project name we will use to reload the editor when switching projects
Public function FString Get the path to the executable that runs the editor
Public function Const bool

GetURL ( const TCHAR* InKey,
FString& OutURL,
const bool bCheckRocket
)

 Fetches a URL from the config and optionally switches it to rocket if required
Public function void Initialize engine analytics
Public function bool Returns true if preferences should be deleted.
Public function bool Returns true if saving layout on close is allowed.
Public function void

LogAssetUpdate ( UObject* UpdatedAsset,
FObjectPreSaveContext SaveContext
)

 Logs an update to an asset
Public function void Check if this we are editing a template project, and if so mount any shared resource paths it uses
Public function void

OnActiveTabChanged ( TSharedPtr< SDockTab > PreviouslyActive,
TSharedPtr< SDockTab > NewlyActivated
)

 Called from tab manager when the tab changes
Public function void

OnActorTokenActivated ( const TSharedRef< class IMessageToken >& Token
)

 Delegate used on message log AActor token activation
Public function void

OnDeferCommand ( const FString& DeferredCommand
)

 Delegate that gets called by modules that can't directly access Engine
Public function void

OnEditorChangeMode ( FEditorModeID NewEditorMode
)

  
Public function void  
Public function void  
Public function Virtual void

OnExit ()

 Cleans up various systems
Public function FText

OnGetDisplayName ( const UObject* InObject,
const bool bFullPath
)

 Delegate for (default) display name of UObject tokens.
Public function Const void

OnGotoAsset ( const FString& InAssetPath
)

 Delegate used to go to assets in the content browser
Public function Virtual void

OnInit ()

 Initalizes various systems
Public function void

OnMapChanged ( UWorld* World,
EMapChangeType MapChangeType
)

 Called when a map is changed (loaded,saved,new map, etc)
Public function void Delegate for (default) message log message selection - selects the objects that the tokens refer to (if any)
Public function void Delegate for (default) message log UObject token activation - selects the object that the token refers to (if any)
Public function void

OnObjectSaved ( UObject* SavedObject,
FObjectPreSaveContext SaveContext
)

 Delegate used to update the map of asset update counts
Public function void

OnTabForegrounded ( TSharedPtr< SDockTab > ForegroundTab,
TSharedPtr< SDockTab > BackgroundTab
)

  
Public function void  
Public function void

OnUserDefinedChordChanged ( const FUICommandInfo& CommandInfo
)

 Called when the input manager records a user-defined chord
Public function void

OpenMarketplace ( const FString& CustomLocation
)

 Opens the Unreal Engine Launcher marketplace page
Public function void

ReplaceDocumentationURLWildcards ( FString& Url,
const FCultureRef& Culture,
const FString& PageId
)

  
Public function void

RestartEditor ( bool bWarn,
const TOptional< FString >& NewCommandLine
)

 Restarts the editor, reopening the current project, if any
Public function void

SetConfigRestoreFilename ( FString InBackupFile,
FString InConfigFile
)

 Sets the config file to use for restoring Config files.
Public function void

SetMapBuildCancelled ( const bool InCancelled
)

 Sets the flag that states whether or not the map build was cancelled.
Public function void

SetPendingProjectName ( const FString& ProjectName
)

 Set the project name we will use to reload the editor when switching projects
Public function Virtual void Performs any required cleanup in the case of a fatal error.
Public function bool

SpawnEditorInstance ( const FString& ProjectName
)

 Launch an editor instance, passing ProjectName and the command line args from this running instance
Public function void

SwitchProject ( const FString& GameOrProjectFileName,
bool bWarn,
const TOptional< FString >& NewCommandLine
)

 Opens the specified project file or game. Restarts the editor
Public function void Triggers asset analytics if it hasn't been run yet
Public function void Ticks the performance analytics used by the analytics heartbeat

Deprecated Functions

  Type Name Description
Public function void

OnNativizeBlueprintsSettingChanged ( const FString& PackageName,
bool bSelect
)

 Blueprint Nativization has been removed as a supported feature. This delegate method will eventually be removed.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page