ObjectLibrary.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "AssetRegistry/AssetData.h"
#include "ObjectLibrary.generated.h"
 
struct FPropertyChangedEvent;
 
UCLASS(MinimalAPI)
class UObjectLibrary : public UObject
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditAnywhere, Category=ObjectLibrary, meta=(AllowAbstract = ""))
    TObjectPtr<UClass>              ObjectBaseClass;
 
    UPROPERTY(EditAnywhere, Category=ObjectLibrary)
    bool bHasBlueprintClasses;
 
protected:
 
    UPROPERTY(EditAnywhere, Category=ObjectLibrary)
    TArray<TObjectPtr<UObject>> Objects;
 
    UPROPERTY()
    TArray<TWeakObjectPtr <UObject> >   WeakObjects;
 
    UPROPERTY(Transient)
    bool bUseWeakReferences;
 
    UPROPERTY(Transient)
    bool bIsFullyLoaded;
 
    TArray<FAssetData>  AssetDataList;
 
public:
    //~ Begin UObject Interface
#if WITH_EDITOR
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    virtual void PostLoad() override;
#endif // WITH_EDITOR
    //~ End UObject Interface
 
    ENGINE_API static class UObjectLibrary* CreateLibrary(UClass* InBaseClass, bool bInHasBlueprintClasses, bool bInUseWeak);
 
    virtual void UseWeakReferences(bool bSetUseWeak);
 
    virtual bool AddObject(UObject *NewObject);
 
    virtual bool RemoveObject(UObject *ObjectToRemove);
 
    DECLARE_EVENT_OneParam(UObjectLibrary, FObjectLibraryOnObjectAdded, UObject* /*NewObject*/);
    FObjectLibraryOnObjectAdded& OnObjectAdded() { return OnObjectAddedEvent; }
 
    DECLARE_EVENT_OneParam(UObjectLibrary, FObjectLibraryOnObjectRemoved, UObject* /*ObjectToRemove*/);
    FObjectLibraryOnObjectRemoved& OnObjectRemoved() { return OnObjectRemovedEvent; }
 
    template <typename T>
    void GetObjects(TArray<T*>& OutObjects)
    {
        for (int32 i = 0; i < Objects.Num(); i++)
        {
            T* Obj = Cast<T>(Objects[i]);
            if (Obj)
            {
                OutObjects.Add(Obj);
            }
        }
 
        for (int32 i = 0; i < WeakObjects.Num(); i++)
        {
            T* Obj = Cast<T>(WeakObjects[i].Get());
            if (Obj)
            {
                OutObjects.Add(Obj);
            }
        }
    }
 
    int32 GetObjectCount() const 
    {
        return Objects.Num() + WeakObjects.Num();
    }
 
    virtual void GetAssetDataList(TArray<FAssetData>& OutAssetData);
 
    int32 GetAssetDataCount() const 
    {
        return AssetDataList.Num();
    }
 
    bool IsLibraryFullyLoaded() const
    {
        return bIsFullyLoaded;
    }
 
    virtual void ClearLoaded();
 
    virtual int32 LoadAssetsFromPaths(const TArray<FString>& Paths);
 
    virtual int32 LoadAssetsFromPath(const FString& Path)
    {
        TArray<FString> Paths;
        Paths.Add(Path);
        return LoadAssetsFromPaths(Paths);
    }
 
    virtual int32 LoadBlueprintsFromPaths(const TArray<FString>& Paths);
 
    virtual int32 LoadBlueprintsFromPath(const FString& Path)
    {
        TArray<FString> Paths;
        Paths.Add(Path);
        return LoadBlueprintsFromPaths(Paths);
    }
 
    virtual int32 LoadAssetDataFromPaths(const TArray<FString>& Paths, bool bForceSynchronousScan = true);
 
    virtual int32 LoadAssetDataFromPath(const FString& Path)
    {
        TArray<FString> Paths;
        Paths.Add(Path);
        return LoadAssetDataFromPaths(Paths);
    }
 
    virtual int32 LoadBlueprintAssetDataFromPaths(const TArray<FString>& Paths, bool bForceSynchronousScan = true);
 
    virtual int32 LoadBlueprintAssetDataFromPath(const FString& Path)
    {
        TArray<FString> Paths;
        Paths.Add(Path);
        return LoadBlueprintAssetDataFromPaths(Paths);
    }
 
    virtual int32 LoadAssetsFromAssetData();
 
    bool bIncludeOnlyOnDiskAssets;
 
    bool bRecursivePaths;
 
#if WITH_EDITOR
    TArray<FString> DeferredAssetDataPaths;
 
    bool bIsGlobalAsyncScanEnvironment;
 
    virtual void OnAssetRegistryFilesLoaded();
#endif // WITH_EDITOR
 
protected:
    FObjectLibraryOnObjectAdded OnObjectAddedEvent;
    FObjectLibraryOnObjectRemoved OnObjectRemovedEvent;
};