ICollectionManager

Windows
MacOS
Linux

References

Module

CollectionManager

Header

/Engine/Source/Developer/CollectionManager/Public/ICollectionManager.h

Include

#include "ICollectionManager.h"

Syntax

class ICollectionManager

Destructors

Name Description

Public function Virtual

~ICollectionManager()

Virtual destructor

Functions

Name Description

Public function

bool

 

AddToCollection

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

Public function

bool

 

AddToCollection

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...,
    FName ObjectPath
)

Adds an asset to the specified collection.

Public function Const

bool

 

CollectionExists

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...
)

Returns true if the collection exists

Public function

bool

 

CreateCollection

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...,
    ECollectionStorageMode::Type Storag...
)

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 ShareTyp...,
    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 ShareTyp...
)

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

Public function

bool

 

EmptyCollection

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...
)

Removes all assets from the specified collection.

Public function Const

bool

 

GetAssetsInCollection

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...,
    TArray< FName >& OutAssetPaths,
    ECollectionRecursionFlags::Flags Re...
)

Returns a list of asset paths found in the specified collection and share type

Public function Const

void

 

GetChildCollectionNames

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...,
    ECollectionShareType::Type ChildSha...,
    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 ShareTyp...,
    TArray< FCollectionNameType >& Out...
)

Returns the list of child collections of the given collection

Public function Const

bool

 

GetClassesInCollection

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...,
    TArray< FName >& ClassPaths,
    ECollectionRecursionFlags::Flags Re...
)

Returns a list of class paths found in the specified collection and share type

Public function Const

bool

 

GetCollectionColor

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...,
    TOptional< FLinearColor >& OutColo...
)

Gets the optional color for the specified collection

Public function Const

void

 

GetCollectionNames

(
    ECollectionShareType::Type ShareTyp...,
    TArray< FName >& CollectionNames
)

Returns the list of collection names of the specified share type

Public function Const

void

 

GetCollections

(
    TArray< FCollectionNameType >& Out...
)

Returns the list of collections

Public function Const

void

 

GetCollections

(
    FName CollectionName,
    TArray< FCollectionNameType >& Out...
)

Returns the list of collections with the given name

Public function Const

void

 

GetCollectionsContainingObject

(
    FName ObjectPath,
    TArray< FCollectionNameType >& Out...,
    ECollectionRecursionFlags::Flags Re...
)

Returns a list of collections in which the specified object exists

Public function Const

void

 

GetCollectionsContainingObject

(
    FName ObjectPath,
    ECollectionShareType::Type ShareTyp...,
    TArray< FName >& OutCollectionName...,
    ECollectionRecursionFlags::Flags Re...
)

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

Public function Const

void

 

GetCollectionsContainingObjects

(
    const TArray< FName >& ObjectPaths,
    TMap< FCollectionNameType, TArray< ...,
    ECollectionRecursionFlags::Flags Re...
)

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

Public function Const

FString

 

GetCollectionsStringForObject

(
    FName ObjectPath,
    ECollectionShareType::Type ShareTyp...,
    ECollectionRecursionFlags::Flags Re...,
    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 ShareTyp...,
    FCollectionStatusInfo& OutStatusIn...
)

Gets the status info for the specified collection

Public function Const

bool

 

GetCollectionStorageMode

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...,
    ECollectionStorageMode::Type& OutS...
)

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

Public function Const

bool

 

GetDynamicQueryText

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...,
    FString& OutQueryText
)

Gets the dynamic query text for the specified collection.

Public function Const

FText

 

GetLastError()

Returns the most recent error.

Public function Const

bool

 

GetObjectsInCollection

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...,
    TArray< FName >& ObjectPaths,
    ECollectionRecursionFlags::Flags Re...
)

Returns a list of object paths found in the specified collection and share type

Public function Const

TOptional< F...

 

GetParentCollection

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...
)

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 ShareTyp...,
    TArray< FName >& CollectionNames
)

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

Public function Const

void

 

GetRootCollections

(
    TArray< FCollectionNameType >& Out...
)

Returns the list of root-level collections

Public function

void

 

HandleFixupRedirectors

(
    ICollectionRedirectorFollower& InR...
)

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 FName& ObjectPath
)

Called to notify the collections that an object has been deleted

Public function

void

 

HandleObjectRenamed

(
    const FName& OldObjectPath,
    const FName& NewObjectPath
)

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

Public function

bool

 

HandleRedirectorDeleted

(
    const FName& ObjectPath
)

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

 

HasCollectionColors

(
    TArray< FLinearColor >* OutCol...
)

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

Public function Const

bool

 

HasCollections()

Returns whether or not the collection manager contains any collections

Public function Const

bool

 

IsObjectInCollection

(
    FName ObjectPath,
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...,
    ECollectionRecursionFlags::Flags Re...
)

Check to see if the given object exists in the given collection

Public function Const

bool

 

IsValidCollectionName

(
    const FString& CollectionName,
    ECollectionShareType::Type ShareTyp...
)

Returns whether or not the given collection name is valid.

Public function Const

bool

 

IsValidParentCollection

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...,
    FName ParentCollectionName,
    ECollectionShareType::Type ParentSh...
)

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

Public function

FAddToCollec...

 

OnAddToCollectionCheckinDescriptionEvent()

Public function

FAssetsAdded...

 

OnAssetsAdded()

Public function

FAssetsRemov...

 

OnAssetsRemoved()

Public function

FCollectionC...

 

OnCollectionCreated()

Public function

FCollectionD...

 

OnCollectionDestroyed()

Public function

FCollectionR...

 

OnCollectionRenamed()

Public function

FCollectionR...

 

OnCollectionReparented()

Public function

FCollectionU...

 

OnCollectionUpdated()

Public function

bool

 

RemoveFromCollection

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...,
    FName ObjectPath
)

Removes the asset from the specified collection.

Public function

bool

 

RemoveFromCollection

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

Public function

bool

 

RenameCollection

(
    FName CurrentCollectionName,
    ECollectionShareType::Type CurrentS...,
    FName NewCollectionName,
    ECollectionShareType::Type NewShare...
)

Renames a collection.

Public function

bool

 

ReparentCollection

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...,
    FName ParentCollectionName,
    ECollectionShareType::Type ParentSh...
)

Re-parents a collection.

Public function

bool

 

SaveCollection

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...
)

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

Public function

bool

 

SetCollectionColor

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...,
    const TOptional< FLinearColor >& N...
)

Sets the optional color for the specified collection

Public function

bool

 

SetDynamicQueryText

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...,
    const FString& InQueryText
)

Sets the dynamic query text for the specified collection.

Public function Const

bool

 

TestDynamicQuery

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...,
    const ITextFilterExpressionContext ...,
    bool& OutResult
)

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

Public function

bool

 

UpdateCollection

(
    FName CollectionName,
    ECollectionShareType::Type ShareTyp...
)

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

Classes

Name

Description

Public class

FAddToCollectionCheckinDescriptionEvent

When a collection checkin happens, use this event to add additional text to the changelist description

Public class

FAssetsAddedEvent

Event for when assets are added to a collection

Public class

FAssetsRemovedEvent

Event for when assets are removed from a collection

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)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss