UniversalObjectLocator.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "UniversalObjectLocatorFwd.h"
#include "UniversalObjectLocatorFragment.h"
#include "UniversalObjectLocatorResolveParams.h"
#include "UniversalObjectLocatorFragmentType.h"
#include "UniversalObjectLocator.generated.h"
 
namespace UE::UniversalObjectLocator
{
    struct FUniversalObjectLocatorCustomization;
    struct FFragmentItem;
}
 
USTRUCT(BlueprintType, Category=GameFramework, meta=(HasNativeMake="/Script/Engine.UniversalObjectLocatorScriptingExtensions.MakeUniversalObjectLocator"))
struct FUniversalObjectLocator
{
    GENERATED_BODY()
 
    using FResolveParams       = UE::UniversalObjectLocator::FResolveParams;
    using FResolveResult       = UE::UniversalObjectLocator::FResolveResult;
    using FResolveResultData   = UE::UniversalObjectLocator::FResolveResultData;
    using FParseStringParams   = UE::UniversalObjectLocator::FParseStringParams;
    using FParseStringResult   = UE::UniversalObjectLocator::FParseStringResult;
 
    UNIVERSALOBJECTLOCATOR_API FUniversalObjectLocator();
 
    UNIVERSALOBJECTLOCATOR_API FUniversalObjectLocator(UObject* Object, UObject* Context = nullptr, UObject* StopAtContext = nullptr);
 
    bool IsEmpty() const
    {
        return Fragments.Num() == 0;
    }
 
    UNIVERSALOBJECTLOCATOR_API FResolveResult Resolve(const FResolveParams& Params) const;
 
    UNIVERSALOBJECTLOCATOR_API FResolveResult AsyncFind(UObject* Context = nullptr) const;
 
    UNIVERSALOBJECTLOCATOR_API FResolveResult AsyncLoad(UObject* Context = nullptr) const;
 
    UNIVERSALOBJECTLOCATOR_API FResolveResult AsyncUnload(UObject* Context = nullptr) const;
 
    UNIVERSALOBJECTLOCATOR_API UObject* SyncFind(UObject* Context = nullptr) const;
 
    UNIVERSALOBJECTLOCATOR_API UObject* SyncLoad(UObject* Context = nullptr) const;
 
    UNIVERSALOBJECTLOCATOR_API void SyncUnload(UObject* Context = nullptr) const;
 
    UNIVERSALOBJECTLOCATOR_API const UE::UniversalObjectLocator::FFragmentType* GetLastFragmentType() const;
 
    UNIVERSALOBJECTLOCATOR_API UE::UniversalObjectLocator::FFragmentTypeHandle GetLastFragmentTypeHandle() const;
 
    UNIVERSALOBJECTLOCATOR_API void ToString(FStringBuilderBase& OutString) const;
 
    UNIVERSALOBJECTLOCATOR_API FParseStringResult TryParseString(FStringView InString, const FParseStringParams& InParams);
 
    static UNIVERSALOBJECTLOCATOR_API FUniversalObjectLocator FromString(FStringView InString, const FParseStringParams& InParams);
 
public:
 
    UNIVERSALOBJECTLOCATOR_API void Reset();
 
    UNIVERSALOBJECTLOCATOR_API void Reset(UObject* Object, UObject* Context = nullptr, UObject* StopAtContext = nullptr);
 
    UNIVERSALOBJECTLOCATOR_API void AddFragment(FUniversalObjectLocatorFragment&& InFragment);
 
    template<typename FragmentType, typename ...ArgTypes>
    void AddFragment(ArgTypes&&... FragmentArgs);
 
    UNIVERSALOBJECTLOCATOR_API FUniversalObjectLocatorFragment* GetLastFragment();
 
    UNIVERSALOBJECTLOCATOR_API const FUniversalObjectLocatorFragment* GetLastFragment() const;
 
    UNIVERSALOBJECTLOCATOR_API bool ForEachFragment(TFunctionRef<bool(int32, int32, const FUniversalObjectLocatorFragment&)> InFunction) const;
 
    /*
    * Iterates over all fragments and combines their types' default flags.
    */
    UNIVERSALOBJECTLOCATOR_API UE::UniversalObjectLocator::EFragmentTypeFlags GetDefaultFlags() const;
 
    UNIVERSALOBJECTLOCATOR_API friend bool operator==(const FUniversalObjectLocator& A, const FUniversalObjectLocator& B);
 
    UNIVERSALOBJECTLOCATOR_API friend bool operator!=(const FUniversalObjectLocator& A, const FUniversalObjectLocator& B);
 
    UNIVERSALOBJECTLOCATOR_API friend uint32 GetTypeHash(const FUniversalObjectLocator& Locator);
 
    /*~ Begin TStructOpsTypeTraits implementation */
    UNIVERSALOBJECTLOCATOR_API bool ExportTextItem(FString& ValueStr, const FUniversalObjectLocator& DefaultValue, UObject* Parent, int32 PortFlags, UObject* ExportRootScope) const;
    UNIVERSALOBJECTLOCATOR_API bool ImportTextItem(const TCHAR*& Buffer, int32 PortFlags, UObject* Parent, FOutputDevice* ErrorText, FArchive* InSerializingArchive = nullptr);
    UNIVERSALOBJECTLOCATOR_API bool SerializeFromMismatchedTag(const FPropertyTag& Tag, FStructuredArchive::FSlot Slot);
    /*~ End TStructOpsTypeTraits implementation */
 
private:
    UNIVERSALOBJECTLOCATOR_API bool AddFragment(const UObject* Object, UObject* Context, UObject* StopAtContext);
 
    FResolveResult ResolveSyncImpl(const FResolveParams& Params) const;
    FResolveResult ResolveAsyncImpl(const FResolveParams& Params) const;
 
private:
 
    UPROPERTY()
    TArray<FUniversalObjectLocatorFragment> Fragments;
 
    friend struct UE::UniversalObjectLocator::FUniversalObjectLocatorCustomization;
    friend struct UE::UniversalObjectLocator::FFragmentItem;
};
 
template<typename FragmentType, typename ...ArgTypes>
void FUniversalObjectLocator::AddFragment(ArgTypes&&... FragmentArgs)
{
    TUniversalObjectLocatorFragment<FragmentType> NewFragment(Forward<ArgTypes>(FragmentArgs)...);
    AddFragment(MoveTemp(NewFragment));
}
 
template<>
struct TStructOpsTypeTraits<FUniversalObjectLocator> : public TStructOpsTypeTraitsBase2<FUniversalObjectLocator>
{
    enum
    {
        WithIdenticalViaEquality = true,
        WithExportTextItem = true,
        WithImportTextItem = true,
        WithStructuredSerializeFromMismatchedTag = true,
    };
};