1. Epic GamesDeveloper
  3. ICollectionManager

ICollectionManager

API > API/Developer > API/Developer/CollectionManager

References

   
Module CollectionManager
Header /Engine/Source/Developer/CollectionManager/Public/ICollectionManager.h
Include #include "ICollectionManager.h"

Syntax

class ICollectionManager

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Public function bool

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

  
Public function bool

AddToCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
const FSoftObjectPath& ObjectPath
)

 Adds an asset to the specified collection.
Public function Const bool

CollectionExists ( FName CollectionName,
ECollectionShareType::Type ShareType
)

 Returns true if the collection exists
Public function bool Adds a collection to the asset registry. A .collection file will be added to disk.
Public function Const void

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

 Creates a unique collection name for the given type taking the form BaseName+(unique number)
Public function bool

DestroyCollection ( FName CollectionName,
ECollectionShareType::Type ShareType
)

 Removes a collection to the asset registry. A .collection file will be deleted from disk.
Public function bool

EmptyCollection ( FName CollectionName,
ECollectionShareType::Type ShareType
)

 Removes all assets from the specified collection.
Public function Const bool

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

 Returns a list of asset paths found in the specified collection and share type
Public function Const void

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

 Returns the list of child collections of the given collection that are also of the specified share type
Public function Const void

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

 Returns the list of child collections of the given collection
Public function Const bool Returns a list of class paths found in the specified collection and share type
Public function Const bool

GetCollectionColor ( FName CollectionName,
ECollectionShareType::Type ShareType,
TOptional< FLinearColor >& OutColor
)

 Gets the optional color for the specified collection
Public function Const void

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

 Returns the list of collection names of the specified share type
Public function Const void

GetCollections ( TArray< FCollectionNameType >& OutCollections
)

 Returns the list of collections
Public function Const void

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

 Returns the list of collections with the given name
Public function Const void Returns a list of collections in which the specified object exists
Public function Const void

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

 Returns a list of collections in which the specified object exists of the specified share type
Public function Const void

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

 Returns a list of collections in which any of the specified objects exist
Public function Const FString

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

 Returns a string containing a comma separated list of collections in which the specified object exists of the specified share type
Public function Const bool

GetCollectionStatusInfo ( FName CollectionName,
ECollectionShareType::Type ShareType,
FCollectionStatusInfo& OutStatusInfo
)

 Gets the status info for the specified collection
Public function Const bool Gets the method by which the specified collection stores its objects (static or dynamic)
Public function Const bool

GetDynamicQueryText ( FName CollectionName,
ECollectionShareType::Type ShareType,
FString& OutQueryText
)

 Gets the dynamic query text for the specified collection.
Public function Const FText Returns the most recent error.
Public function Const bool Returns a list of object paths found in the specified collection and share type
Public function Const TOptional< FCollectionNameType >

GetParentCollection ( FName CollectionName,
ECollectionShareType::Type ShareType
)

 Returns the parent collection of the given collection, or an unset value if there is no parent set
Public function Const void

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

 Returns the list of root-level collection names of the specified share type
Public function Const void Returns the list of root-level collections
Public function void 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
Public function void

HandleObjectDeleted ( const FSoftObjectPath& ObjectPath
)

 Called to notify the collections that an object has been deleted
Public function void

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

 Called to notify the collections that an object has been renamed or moved
Public function bool 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
Public function Const bool Checks whether any collections have a custom color set, optionally retrieving the list of in-use colors
Public function Const bool Returns whether or not the collection manager contains any collections
Public function Const bool

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

 Check to see if the given object exists in the given collection
Public function Const bool

IsValidCollectionName ( const FString& CollectionName,
ECollectionShareType::Type ShareType
)

 Returns whether or not the given collection name is valid.
Public function Const bool

IsValidParentCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
FName ParentCollectionName,
ECollectionShareType::Type ParentShareType
)

 Check to see if the given collection is valid to be used as the parent of another collection.
Public function FAddToCollectionCheckinDescriptionEvent &  
Public function FOnAssetsAddedToCollection &  
Public function FOnAssetsRemovedFromCollection &  
Public function FCollectionCreatedEvent &  
Public function FCollectionDestroyedEvent &  
Public function FCollectionRenamedEvent &  
Public function FCollectionReparentedEvent &  
Public function FCollectionUpdatedEvent &  
Public function bool

RemoveFromCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
const FSoftObjectPath& ObjectPath
)

 Removes the asset from the specified collection.
Public function bool

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

  
Public function bool

RenameCollection ( FName CurrentCollectionName,
ECollectionShareType::Type CurrentShareType,
FName NewCollectionName,
ECollectionShareType::Type NewShareType
)

 Renames a collection.
Public function bool

ReparentCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
FName ParentCollectionName,
ECollectionShareType::Type ParentShareType
)

 Re-parents a collection.
Public function bool

SaveCollection ( FName CollectionName,
ECollectionShareType::Type ShareType
)

 Save the collection (if dirty) and check it into source control (if under SCC control)
Public function bool

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

 Sets the optional color for the specified collection
Public function bool

SetDynamicQueryText ( FName CollectionName,
ECollectionShareType::Type ShareType,
const FString& InQueryText
)

 Sets the dynamic query text for the specified collection.
Public function Const bool

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

 Tests the dynamic query for the specified collection against the context provided.
Public function bool

UpdateCollection ( FName CollectionName,
ECollectionShareType::Type ShareType
)

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

Classes

  Type Name Description
Public class FAddToCollectionCheckinDescriptionEvent When a collection checkin happens, use this event to add additional text to the changelist description  
Public class FAssetsAddedEvent    
Public class FAssetsRemovedEvent    
Public class FCollectionCreatedEvent Event for when collections are created  
Public class FCollectionDestroyedEvent Event for when collections are destroyed  
Public class FCollectionRenamedEvent Event for when collections are renamed  
Public class FCollectionReparentedEvent Event for when collections are re-parented (params: Collection, OldParent, NewParent)  
Public class 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 Description
FOnAssetsAddedToCollection Event for when assets are added to a collection
FOnAssetsRemovedFromCollection Event for when assets are removed from a collection

Deprecated Functions

  Type Name Description
Public function bool

AddToCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
const TArray< FName >& ObjectPaths,
int32* OutNumAdded
)

 FNames containing full object paths are deprecated. Use FSoftObjectPath instead.
Public function bool

AddToCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
FName ObjectPath
)

 FNames containing full object paths are deprecated. Use FSoftObjectPath instead.
Public function Const bool

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

 FNames containing full object paths are deprecated. Use FSoftObjectPath instead.
Public function Const bool

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

 FNames containing class paths are deprecated. Use FTopLevelAssetPath instead.
Public function Const void FNames containing full object paths are deprecated. Use FSoftObjectPath instead.
Public function Const void

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

 FNames containing full object paths are deprecated. Use FSoftObjectPath instead.
Public function Const void

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

 FNames containing full object paths are deprecated. Use FSoftObjectPath instead.
Public function Const FString

GetCollectionsStringForObject ( FName ObjectPath,
ECollectionShareType::Type ShareType,
ECollectionRecursionFlags::Flags RecursionMode,
bool bFullPaths
)

 FNames containing full object paths are deprecated. Use FSoftObjectPath instead.
Public function Const bool

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

 FNames containing full object paths are deprecated. Use FSoftObjectPath instead.
Public function void

HandleObjectDeleted ( const FName& ObjectPath
)

 FNames containing full object paths are deprecated. Use FSoftObjectPath instead.
Public function void

HandleObjectRenamed ( const FName& OldObjectPath,
const FName& NewObjectPath
)

 FNames containing full object paths are deprecated. Use FSoftObjectPath instead.
Public function bool

HandleRedirectorDeleted ( const FName& ObjectPath
)

 FNames containing full object paths are deprecated. Use FSoftObjectPath instead.
Public function Const bool

IsObjectInCollection ( FName ObjectPath,
FName CollectionName,
ECollectionShareType::Type ShareType,
ECollectionRecursionFlags::Flags RecursionMode
)

 FNames containing full object paths are deprecated. Use FSoftObjectPath instead.
Public function FAssetsAddedEvent & Names containing full asset paths are deprecated, use OnAssetsAddedToCollection instead.
Public function FAssetsRemovedEvent & Names containing full asset paths are deprecated, use OnAssetsRemovedFromCollection instead.
Public function bool

RemoveFromCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
FName ObjectPath
)

 FNames containing full object paths are deprecated. Use FSoftObjectPath instead.
Public function bool

RemoveFromCollection ( FName CollectionName,
ECollectionShareType::Type ShareType,
const TArray< FName >& ObjectPaths,
int32* OutNumRemoved
)

 FNames containing full object paths are deprecated. Use FSoftObjectPath instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page