1. Epic GamesDeveloper
  3. ICollectionManager

ICollectionManager

API > API/Developer > API/Developer/CollectionManager

   
Name ICollectionManager
Type class
Header File /Engine/Source/Developer/CollectionManager/Public/ICollectionManager.h
Include Path #include "ICollectionManager.h"

Syntax

class ICollectionManager

Constructors

Name Remarks Include Path Unreal Specifiers
  ICollectionManager.h  
  ICollectionManager.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ICollectionManager()

   ICollectionManager.h  

Classes

Name Remarks
FAddToCollectionCheckinDescriptionEvent When a collection checkin happens, use this event to add additional text to the changelist description.
FCollectionContainerCreatedEvent Event for when collection containers are created
FCollectionContainerDestroyedEvent Event for when collection containers are destroyed
FCollectionCreatedEvent Event for when collections are created
FCollectionDestroyedEvent Event for when collections are destroyed
FCollectionRenamedEvent Event for when collections are renamed
FCollectionReparentedEvent Event for when collections are re-parented (params: Collection, OldParent, NewParent)
FCollectionUpdatedEvent Event for when collections is updated, or otherwise changed and we can't tell exactly how (eg, after updating from source control and merging)

Typedefs

Name Type Remarks Include Path
FOnAssetsAddedToCollection TMulticastDelegate_TwoParams< void, const FCollectionNameType &, TConstArrayView< FSoftObjectPath > > Event for when assets are added to a collection ICollectionManager.h
FOnAssetsRemovedFromCollection TMulticastDelegate_TwoParams< void, const FCollectionNameType &, TConstArrayView< FSoftObjectPath > > Event for when assets are removed from a collection ICollectionManager.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSharedPtr< ICollectionContainer > AddCollectionContainer ( const TSharedRef< ICollectionSource >& CollectionSource
)

 Creates and returns a new collection container for the specified collection source ICollectionManager.h  

bool AddToCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
TConstArrayView< FSoftObjectPath > ObjectPaths,
int32* OutNumAdded,
FText* OutError
)

   ICollectionManager.h  

bool AddToCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
const FSoftObjectPath& ObjectPath,
FText* OutError
)

 Adds an asset to the specified collection. ICollectionManager.h  

bool CollectionExists ( FName CollectionName,
ECollectionShareType::Type ShareType
) const

 Returns true if the collection exists ICollectionManager.h  

bool CreateCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
ECollectionStorageMode::Type StorageMode,
FText* OutError
)

 Creates a new collection. A .collection file will be added to disk. ICollectionManager.h  

void CreateUniqueCollectionName ( FName BaseName,
ECollectionShareType::Type ShareType,
FName& OutCollectionName
) const

 Creates a unique collection name for the given type taking the form BaseName+(unique number) ICollectionManager.h  

bool DestroyCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
FText* OutError
)

 Removes a collection to the asset registry. A .collection file will be deleted from disk. ICollectionManager.h  

bool EmptyCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
FText* OutError
)

 Removes all assets from the specified collection. ICollectionManager.h  

TSharedPtr< ICollectionContainer > FindCollectionContainer ( const TSharedRef< ICollectionSource >& CollectionSource
) const

 Returns the collection container that matches the specified collection source, if any ICollectionManager.h  

TSharedPtr< ICollectionContainer > FindCollectionContainer ( FName CollectionSourceName
) const

 Returns the collection container that matches the specified collection source name, if any ICollectionManager.h  

bool GetAssetsInCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
TArray< FSoftObjectPath >& OutAssetPaths,
ECollectionRecursionFlags::Flags RecursionMode
) const

 Gets a list of assets in the given collection ICollectionManager.h  

void GetChildCollectionNames ( FName CollectionName,
ECollectionShareType::Type ShareType,
ECollectionShareType::Type ChildShareType,
TArray< FName >& CollectionNames
) const

 Returns the list of child collections of the given collection that are also of the specified share type ICollectionManager.h  

void GetChildCollections ( FName CollectionName,
ECollectionShareType::Type ShareType,
TArray< FCollectionNameType >& OutCollections
) const

 Returns the list of child collections of the given collection ICollectionManager.h  

bool GetClassesInCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
TArray< FTopLevelAssetPath >& ClassPaths,
ECollectionRecursionFlags::Flags RecursionMode
) const

 Gets a list of class paths in the given collection ICollectionManager.h  

bool GetCollectionColor ( FName CollectionName,
ECollectionShareType::Type ShareType,
TOptional< FLinearColor >& OutColor,
FText* OutError
) const

 Gets the optional color for the specified collection ICollectionManager.h  

void GetCollectionContainers ( TArray< TSharedPtr< ICollectionContainer > >& OutCollectionContainers
) const

 Gets all collection containers ICollectionManager.h  

void GetCollectionNames ( ECollectionShareType::Type ShareType,
TArray< FName >& CollectionNames
) const

 Returns the list of collection names of the specified share type ICollectionManager.h  

void GetCollections ( FName CollectionName,
TArray< FCollectionNameType >& OutCollections
) const

 Returns the list of collections with the given name ICollectionManager.h  

void GetCollections ( TArray< FCollectionNameType >& OutCollections
) const

 Returns the list of collections ICollectionManager.h  

void GetCollectionsContainingObject ( const FSoftObjectPath& ObjectPath,
ECollectionShareType::Type ShareType,
TArray< FName >& OutCollectionNames,
ECollectionRecursionFlags::Flags RecursionMode
) const

 Returns a list of collections in which the specified object exists of the specified share type ICollectionManager.h  

void GetCollectionsContainingObject ( const FSoftObjectPath& ObjectPath,
TArray< FCollectionNameType >& OutCollections,
ECollectionRecursionFlags::Flags RecursionMode
) const

 Returns a list of collections in which the specified object exists ICollectionManager.h  

void GetCollectionsContainingObjects ( const TArray< FSoftObjectPath >& ObjectPaths,
TMap< FCollectionNameType, TArray< FSoftObjectPath > >& OutCollectionsAndMatchedObjects,
ECollectionRecursionFlags::Flags RecursionMode
) const

 Returns a list of collections in which any of the specified objects exist ICollectionManager.h  

FString GetCollectionsStringForObject ( const FSoftObjectPath& ObjectPath,
ECollectionShareType::Type ShareType,
ECollectionRecursionFlags::Flags RecursionMode,
bool bFullPaths
) const

 Returns a string containing a comma separated list of collections in which the specified object exists of the specified share type ICollectionManager.h  

bool GetCollectionStatusInfo ( FName CollectionName,
ECollectionShareType::Type ShareType,
FCollectionStatusInfo& OutStatusInfo,
FText* OutError
) const

 Gets the status info for the specified collection ICollectionManager.h  

bool GetCollectionStorageMode ( FName CollectionName,
ECollectionShareType::Type ShareType,
ECollectionStorageMode::Type& OutStorageMode,
FText* OutError
) const

 Gets the method by which the specified collection stores its objects (static or dynamic) ICollectionManager.h  

bool GetDynamicQueryText ( FName CollectionName,
ECollectionShareType::Type ShareType,
FString& OutQueryText,
FText* OutError
) const

 Gets the dynamic query text for the specified collection. ICollectionManager.h  

FText GetLastError()

 Returns the most recent error. ICollectionManager.h  

bool GetObjectsInCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
TArray< FSoftObjectPath >& ObjectPaths,
ECollectionRecursionFlags::Flags RecursionMode
) const

 Gets a list of objects in the given collection ICollectionManager.h  

TOptional< FCollectionNameType > GetParentCollection ( FName CollectionName,
ECollectionShareType::Type ShareType
) const

 Returns the parent collection of the given collection, or an unset value if there is no parent set ICollectionManager.h  

const TSharedRef< ICollectionContainer > & GetProjectCollectionContainer()

 Returns the collection container for the current uproject ICollectionManager.h  

void GetRootCollectionNames ( ECollectionShareType::Type ShareType,
TArray< FName >& CollectionNames
) const

 Returns the list of root-level collection names of the specified share type ICollectionManager.h  

void GetRootCollections ( TArray< FCollectionNameType >& OutCollections
) const

 Returns the list of root-level collections ICollectionManager.h  

void GetVisibleCollectionContainers ( TArray< TSharedPtr< ICollectionContainer > >& OutCollectionContainers
) const

 Gets all collection containers that aren't hidden ICollectionManager.h  

void HandleFixupRedirectors ( ICollectionRedirectorFollower& InRedirectorFollower
)

 Called to notify the collections that they should fix-up their object references so that they no longer contain any redirectors References are only updated in-memory, and won't be saved to disk until a redirector is deleted (which forces our hand), or the collection is saved for any other reason ICollectionManager.h  

void HandleObjectDeleted ( const FSoftObjectPath& ObjectPath
)

 Called to notify the collections that an object has been deleted ICollectionManager.h  

void HandleObjectRenamed ( const FSoftObjectPath& OldObjectPath,
const FSoftObjectPath& NewObjectPath
)

 Called to notify the collections that an object has been renamed or moved ICollectionManager.h  

void HandleObjectsDeleted ( TConstArrayView< FSoftObjectPath > ObjectPaths
)

 Called to notify the collections that objects have been deleted ICollectionManager.h  

bool HandleRedirectorDeleted ( const FSoftObjectPath& ObjectPath,
FText* OutError
)

 Called to notify the collections that a redirector has been deleted and that they should ensure their on-disk representation is re-saved with the fixed up in-memory version ICollectionManager.h  

bool HandleRedirectorsDeleted ( TConstArrayView< FSoftObjectPath > ObjectPaths,
FText* OutError
)

 Called to notify the collections that redirectors have been deleted and that they should ensure their on-disk representation is re-saved with the fixed up in-memory version ICollectionManager.h  

bool HasCollectionColors ( TArray< FLinearColor >* OutColors
) const

 Checks whether any collections have a custom color set, optionally retrieving the list of in-use colors ICollectionManager.h  

bool HasCollectionContainer ( const TSharedRef< ICollectionContainer >& CollectionContainer
) const

 Returns true if this collection manager contains the specified collection container ICollectionManager.h  

bool HasCollections()

 Returns whether or not the collection manager contains any collections ICollectionManager.h  

bool IsObjectInCollection ( const FSoftObjectPath& ObjectPath,
FName CollectionName,
ECollectionShareType::Type ShareType,
ECollectionRecursionFlags::Flags RecursionMode,
FText* OutError
) const

 Check to see if the given object exists in the given collection ICollectionManager.h  

bool IsValidCollectionName ( const FString& CollectionName,
ECollectionShareType::Type ShareType,
FText* OutError
) const

 Check whether the given name is valid for a new collection. ICollectionManager.h  

bool IsValidParentCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
FName ParentCollectionName,
ECollectionShareType::Type ParentShareType,
FText* OutError
) const

 Check to see if the given collection is valid to be used as the parent of another collection. ICollectionManager.h  

FAddToCollectionCheckinDescriptionEvent & OnAddToCollectionCheckinDescriptionEvent()

   ICollectionManager.h  

FOnAssetsAddedToCollection & OnAssetsAddedToCollection()

   ICollectionManager.h  

FOnAssetsRemovedFromCollection & OnAssetsRemovedFromCollection()

   ICollectionManager.h  

FCollectionContainerCreatedEvent & OnCollectionContainerCreated()

   ICollectionManager.h  

FCollectionContainerDestroyedEvent & OnCollectionContainerDestroyed()

   ICollectionManager.h  

FCollectionCreatedEvent & OnCollectionCreated()

   ICollectionManager.h  

FCollectionDestroyedEvent & OnCollectionDestroyed()

   ICollectionManager.h  

FCollectionRenamedEvent & OnCollectionRenamed()

   ICollectionManager.h  

FCollectionReparentedEvent & OnCollectionReparented()

   ICollectionManager.h  

FCollectionUpdatedEvent & OnCollectionUpdated()

   ICollectionManager.h  

bool RemoveCollectionContainer ( const TSharedRef< ICollectionContainer >& CollectionContainer
)

 Removes the specified collection container ICollectionManager.h  

bool RemoveFromCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
const FSoftObjectPath& ObjectPath,
FText* OutError
)

 Removes the asset from the specified collection. ICollectionManager.h  

bool RemoveFromCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
TConstArrayView< FSoftObjectPath > ObjectPaths,
int32* OutNumRemoved,
FText* OutError
)

   ICollectionManager.h  

bool RenameCollection ( FName CurrentCollectionName,
ECollectionShareType::Type CurrentShareType,
FName NewCollectionName,
ECollectionShareType::Type NewShareType,
FText* OutError
)

 Renames a collection. ICollectionManager.h  

bool ReparentCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
FName ParentCollectionName,
ECollectionShareType::Type ParentShareType,
FText* OutError
)

 Re-parents a collection. ICollectionManager.h  

UE_INTERNAL void ResumeObjectDeletionHandling()

   ICollectionManager.h  

bool SaveCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
FText* OutError
)

 Save the collection (if dirty) and check it into source control (if under SCC control) ICollectionManager.h  

bool SetCollectionColor ( FName CollectionName,
ECollectionShareType::Type ShareType,
const TOptional< FLinearColor >& NewColor,
FText* OutError
)

 Sets the optional color for the specified collection ICollectionManager.h  

bool SetDynamicQueryText ( FName CollectionName,
ECollectionShareType::Type ShareType,
const FString& InQueryText,
FText* OutError
)

 Sets the dynamic query text for the specified collection. ICollectionManager.h  

UE_INTERNAL void SuppressObjectDeletionHandling()

 Internal API for processing HandleObjectsDeleted calls in a batch-friendly way ICollectionManager.h  

bool TestDynamicQuery ( FName CollectionName,
ECollectionShareType::Type ShareType,
const ITextFilterExpressionContext& InContext,
bool& OutResult,
FText* OutError
) const

 Tests the dynamic query for the specified collection against the context provided. ICollectionManager.h  

bool TryParseCollectionPath ( const FString& CollectionPath,
TSharedPtr< ICollectionContainer >* OutCollectionContainer,
FName* OutCollectionName,
ECollectionShareType::Type* OutShareType
) const

 Returns true if the collection path could be parsed into its constituent parts, and the collection container exists (if an out parameter for it was passed in) ICollectionManager.h  

bool UpdateCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
FText* OutError
)

 Update the collection to make sure it's using the latest version from source control (if under SCC control) ICollectionManager.h  

Operators

Name Remarks Include Path Unreal Specifiers

ICollectionManager & operator= ( const ICollectionManager&
)

   ICollectionManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page