1. Epic GamesDeveloper
  3. ICollectionContainer

ICollectionContainer

API > API/Developer > API/Developer/CollectionManager

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

Syntax

class ICollectionContainer : public TSharedFromThis< ICollectionContainer >

Inheritance Hierarchy

  • TSharedFromThis< ICollectionContainer > → ICollectionContainer

Constructors

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

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ICollectionContainer()

   ICollectionContainer.h  

Classes

Name Remarks
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)
FIsHiddenChangedEvent Event for when the collection container's hidden state changes

Typedefs

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

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   ICollectionContainer.h  

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

 Adds an asset to the specified collection. ICollectionContainer.h  

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

 Returns true if the collection exists ICollectionContainer.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. ICollectionContainer.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) ICollectionContainer.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. ICollectionContainer.h  

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

 Removes all assets from the specified collection. ICollectionContainer.h  

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

 Gets a list of assets in the given collection ICollectionContainer.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 ICollectionContainer.h  

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

 Returns the list of child collections of the given collection ICollectionContainer.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 ICollectionContainer.h  

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

 Gets the optional color for the specified collection ICollectionContainer.h  

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

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

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

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

void GetCollections ( TArray< FCollectionNameType >& OutCollections
) const

 Returns the list of collections ICollectionContainer.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 ICollectionContainer.h  

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

 Returns a list of collections in which the specified object exists ICollectionContainer.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 ICollectionContainer.h  

const TSharedRef< ICollectionSource > & GetCollectionSource()

 Returns the source of the collections in this container ICollectionContainer.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 ICollectionContainer.h  

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

 Gets the status info for the specified collection ICollectionContainer.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) ICollectionContainer.h  

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

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

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

 Gets a list of objects in the given collection ICollectionContainer.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 ICollectionContainer.h  

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

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

void GetRootCollections ( TArray< FCollectionNameType >& OutCollections
) const

 Returns the list of root-level collections ICollectionContainer.h  

bool HasCollectionColors ( TArray< FLinearColor >* OutColors
) const

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

bool HasCollections()

 Returns whether or not the collection container contains any collections ICollectionContainer.h  

bool IsHidden()

 Returns whether or not the collection container should be hidden in the Editor's UI ICollectionContainer.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 ICollectionContainer.h  

bool IsReadOnly ( ECollectionShareType::Type ShareType
) const

 Returns whether or not the collection container is read-only for the specified share type ICollectionContainer.h  

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

 Check whether the given name is valid for a new collection. ICollectionContainer.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. ICollectionContainer.h  

FString MakeCollectionPath ( FName CollectionName,
ECollectionShareType::Type ShareType
) const

 Returns a path that uniquely identifies a collection ICollectionContainer.h  

FOnAssetsAddedToCollection & OnAssetsAddedToCollection()

   ICollectionContainer.h  

FOnAssetsRemovedFromCollection & OnAssetsRemovedFromCollection()

   ICollectionContainer.h  

FCollectionCreatedEvent & OnCollectionCreated()

   ICollectionContainer.h  

FCollectionDestroyedEvent & OnCollectionDestroyed()

   ICollectionContainer.h  

FCollectionRenamedEvent & OnCollectionRenamed()

   ICollectionContainer.h  

FCollectionReparentedEvent & OnCollectionReparented()

   ICollectionContainer.h  

FCollectionUpdatedEvent & OnCollectionUpdated()

   ICollectionContainer.h  

FIsHiddenChangedEvent & OnIsHiddenChanged()

   ICollectionContainer.h  

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

 Removes the asset from the specified collection. ICollectionContainer.h  

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

   ICollectionContainer.h  

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

 Renames a collection. ICollectionContainer.h  

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

 Re-parents a collection. ICollectionContainer.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) ICollectionContainer.h  

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

 Sets the optional color for the specified collection ICollectionContainer.h  

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

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

void SetHidden ( bool bHidden
)

 Sets whether or not the collection container should be hidden in the Editor's UI ICollectionContainer.h  

void SetReadOnly ( ECollectionShareType::Type ShareType,
bool bReadOnly
)

 Sets whether or not the collection container is read-only for the specified share type ICollectionContainer.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. ICollectionContainer.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) ICollectionContainer.h  

Operators

Name Remarks Include Path Unreal Specifiers
  ICollectionContainer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page