1. Epic GamesDeveloper
  3. UAssetEditorSubsystem

UAssetEditorSubsystem

[UAssetEditorSubsystem](API\Editor\UnrealEd\Subsystems\UAssetEditorSubsystem)

API > API/Editor > API/Editor/UnrealEd > API/Editor/UnrealEd/Subsystems

Inheritance Hierarchy

References

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

Syntax

UCLASS (MinimalAPI)  
class UAssetEditorSubsystem : public UEditorSubsystem

Remarks

UAssetEditorSubsystem

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddReadOnlyAssetFilter ( const FName& Owner,
const FReadOnlyAssetFilter& ReadOnlyAssetFilter
)

  
Public function bool

CanOpenEditorForAsset ( UObject* Asset,
const EAssetTypeActivationOpenedMethod OpenedMethod,
FText* OutErrorMsg
)

 Check whether the given asset can be opened in the given open method
Public function bool Close all open asset editors
Public function UFunction BlueprintCallable, Category int32 Close all active editors for the supplied asset and return the number of asset editors that were closed
Public function void Close any editor which is not this one
Public function UEdMode * Creates a scriptable editor mode based on ID name, which will be owned by the given Owner, if that name exists in the map of editor modes found at system startup.
Public function void

CreateRecentAssetsMenuForEditor ( const IAssetEditorInstance* InAssetEditorInstance,
FToolMenuSection& InSection
)

 Fill in the given section with the recent assets for the given asset editor instance
Public function Virtual void  
Public function IAssetEditorInstance *

FindEditorForAsset ( UObject* Asset,
bool bFocusIfOpen
)

 Returns the primary editor if one is already open for the specified asset.
Public function Const bool

FindEditorModeInfo ( const FEditorModeID& InModeID,
FEditorModeInfo& OutModeInfo
)

 Returns information about an editor mode, based on the given ID.
Public function TArray< IAssetEditorInstance * > Returns all editors currently opened for the specified asset
Public function TArray< IAssetEditorInstance * > Returns all editors currently opened for the specified asset or any of its subobjects
Public function TArray< UObject * > Get all assets currently being tracked with open editors
Public function FNamePermissionList & Get the permission list that controls which editor modes are exposed
Public function TOptional< EAssetOpenMethod > These functions are used by the Asset Editor Toolkit to query the method in which the given assets are being opened These are only valid when the asset is in the process of being opened, i.e while we are in OpenEditorForAsset.
Public function TOptional< EAssetOpenMethod >  
Public function Const TOptional< bool > Get the current value of bAutoRestoreAndDisableSaving
Public function Const TArray< FEditorModeInfo > Creates an array of all known FEditorModeInfos, sorted by their priority, from greatest to least.
Public function Const FMainMRUFavoritesList *  
Public function Virtual void

Initialize ( FSubsystemCollectionBase& Collection
)

  
Public function bool

IsAssetEditable ( const UObject* Asset
)

  
Public function void Notify the asset editor manager that an asset editor is done editing an asset
Public function void Notify the asset editor manager that an asset was opened
Public function void

NotifyAssetsOpened ( const TArray< UObject* >& Assets,
IAssetEditorInstance* Instance
)

  
Public function void Notify the asset editor manager that an asset was closed
Public function void Notify the asset editor manager that an asset editor is being opened and before widgets are constructed
Public function Virtual FOnAssetClosedInEditorEvent &  
Public function FAssetEditorOpenEvent &  
Public function Virtual FAssetEditorRequestCloseEvent &  
Public function Virtual FAssetEditorRequestOpenEvent &  
Public function Virtual FOnAssetOpenedInEditorEvent &  
Public function FOnModeRegistered & Event that is triggered whenever a mode is registered
Public function FRegisteredModesChangedEvent & Event that is triggered whenever a mode is registered or unregistered
Public function FOnModeUnregistered & Event that is triggered whenever a mode is unregistered
Public function Virtual FOnAssetsOpenedInEditorEvent &  
Public function bool

OpenEditorForAsset ( TObjectPtr< ObjectType > Asset,
const EToolkitMode::Type ToolkitMode,
TSharedPtr< IToolkitHost > OpenedFromLevelEditor,
const bool bShowProgressWindow
)

  
Public function bool

OpenEditorForAsset ( UObject* Asset,
const EToolkitMode::Type ToolkitMode,
TSharedPtr< IToolkitHost > OpenedFromLevelEditor,
const bool bShowProgressWindow,
EAssetTypeActivationOpenedMethod OpenedMethod
)

 Tries to open an editor for the specified asset.
Public function void

OpenEditorForAsset ( const FString& AssetPathName,
const EAssetTypeActivationOpenedMethod OpenedMethod
)

 Opens an asset by path
Public function void

OpenEditorForAsset ( const FSoftObjectPath& AssetPath,
const EAssetTypeActivationOpenedMethod OpenedMethod
)

  
Public function UFunction BlueprintCallable, Category bool

OpenEditorForAssets ( const TArray< UObject* >& Assets,
const EAssetTypeActivationOpenedMethod OpenedMethod
)

 Tries to open an editor for all of the specified assets.
Public function UFunction BlueprintCallable, Category bool

OpenEditorForAssets_Advanced ( const TArray< UObject* >& InAssets,
const EToolkitMode::Type ToolkitMode,
TSharedPtr< IToolkitHost > OpenedFromLevelEditor,
const EAssetTypeActivationOpenedMethod OpenedMethod
)

  
Public function void

OpenEditorsForAssets ( const TArray< FName >& AssetsToOpen,
const EAssetTypeActivationOpenedMethod OpenedMethod
)

  
Public function void

OpenEditorsForAssets ( const TArray< FString >& AssetsToOpen,
const EAssetTypeActivationOpenedMethod OpenedMethod
)

 Opens editors for the supplied assets (via OpenEditorForAsset)
Public function void

OpenEditorsForAssets ( const TArray< FSoftObjectPath >& AssetsToOpen
)

  
Public function void

RegisterUAssetEditor ( UAssetEditor* NewAssetEditor
)

  
Public function void Remove given asset from all open editors
Public function void

RemoveReadOnlyAssetFilter ( const FName& Owner
)

  
Public function void Request notification to restore the assets that were previously open when the editor was last closed
Public function void Restore the assets that were previously open when the editor was last closed.
Public function void

SaveOpenAssetEditors ( const bool bOnShutdown
)

 Saves a list of open asset editors so they can be restored on editor restart.
Public function void

SaveOpenAssetEditors ( const bool bOnShutdown,
const bool bCancelIfDebugger
)

 Saves a list of open asset editors so they can be restored on editor restart.
Public function void

SetAutoRestoreAndDisableSaving ( const bool bInAutoRestoreAndDisableSaving
)

 Sets bAutoRestoreAndDisableSaving and sets bRequestRestorePreviouslyOpenAssets to false to avoid running RestorePreviouslyOpenAssets() twice.
Public function void

SetAutoRestoreAndDisableSavingOverride ( TOptional< bool > bInAutoRestoreAndDisableSaving
)

 Set/Unset the bAutoRestoreAndDisableSaving override, along with setting bRequestRestorePreviouslyOpenAssets to false to avoid running RestorePreviouslyOpenAssets() twice
Public function void  
Public function void

UnregisterUAssetEditor ( UAssetEditor* RemovedAssetEditor
)

  

Classes

  Type Name Description
Public class FAssetEditorOpenEvent Called when an asset editor is actually opened  
Public class FAssetEditorRequestCloseEvent Event called specifically when an external system requests an asset editor to be closed (e.g by calling CloseAllAssetEditors()) If you want an event that is called anytime an asset is removed from an editor (which may or may not close the editor) - use OnAssetClosedInEditor()  
Public class FAssetEditorRequestOpenEvent Called when an asset editor is requested to be opened  
Public class FOnAssetClosedInEditorEvent Called when an editor is done editing an asset  
Public class FOnAssetOpenedInEditorEvent Called when an asset has been opened in an editor  
Public class FOnAssetsOpenedInEditorEvent Called when an asset editor is opening and before widgets are constructed  

Typedefs

Name Description
FReadOnlyAssetFilter Functionality to add a filter that is run to check if an asset is allowed to be opened in read only mode (If the asset type supports it)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page