TypedElementListLibrary.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Elements/Framework/TypedElementRegistry.h"
#include "Elements/Framework/TypedElementListProxy.h"
#include "Elements/Framework/TypedElementList.h"
#include "TypedElementListLibrary.generated.h"
 
UCLASS()
class UTypedElementListLibrary : public UObject
{
    GENERATED_BODY()
    
public:
    UFUNCTION(BlueprintCallable, DisplayName="Create Element List", Category = "TypedElementFramework|Registry", meta=(ScriptMethod, ScriptName="CreateElementList"))
    static FScriptTypedElementListProxy CreateScriptElementList(UTypedElementRegistry* Registry)
    {
        return Registry->CreateScriptElementList();
    }
 
    UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static FScriptTypedElementListProxy Clone(const FScriptTypedElementListProxy ElementList)
    {
        FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
        return ElementListPtr ? ElementListPtr->Clone() : FScriptTypedElementListProxy();
    }
 
    UFUNCTION(BlueprintPure, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static FScriptTypedElementHandle GetElementHandleAt(const FScriptTypedElementListProxy ElementList, const int32 Index)
    {
        FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
        return ElementListPtr ? ElementListPtr->GetElementHandleAt(Index) : FScriptTypedElementHandle();
    }
 
    UFUNCTION(BlueprintPure, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static UObject* GetElementInterface(const FScriptTypedElementListProxy ElementList, const FScriptTypedElementHandle& ElementHandle, const TSubclassOf<UInterface> BaseInterfaceType)
    {
        FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
        return ElementListPtr ? ElementListPtr->GetElementInterface(ElementHandle, BaseInterfaceType) : nullptr;
    }
 
    UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static bool HasElements(const FScriptTypedElementListProxy ElementList, const TSubclassOf<UInterface> BaseInterfaceType = {})
    {
        FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
        return ElementListPtr && ElementListPtr->HasElements(BaseInterfaceType);
    }
 
    UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static int32 CountElements(const FScriptTypedElementListProxy ElementList, const TSubclassOf<UInterface> BaseInterfaceType = {})
    {
        FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
        return ElementListPtr ? ElementListPtr->CountElements(BaseInterfaceType) : 0;
    }
 
    UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static bool HasElementsOfType(const FScriptTypedElementListProxy ElementList, const FName ElementTypeName)
    {
        FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
        return ElementListPtr && ElementListPtr->HasElementsOfType(ElementTypeName);
    }
 
    UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static int32 CountElementsOfType(const FScriptTypedElementListProxy ElementList, const FName ElementTypeName)
    {
        FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
        return ElementListPtr ? ElementListPtr->CountElementsOfType(ElementTypeName) : 0;
    }
 
    UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static TArray<FScriptTypedElementHandle> GetElementHandles(const FScriptTypedElementListProxy ElementList, const TSubclassOf<UInterface> BaseInterfaceType)
    {
        FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
        return ElementListPtr ? ElementListPtr->GetElementHandles(BaseInterfaceType) : TArray<FScriptTypedElementHandle>();
    }
 
    UFUNCTION(BlueprintPure, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static bool IsValidIndex(const FScriptTypedElementListProxy ElementList, const int32 Index)
    {
        FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
        return ElementListPtr && ElementListPtr->IsValidIndex(Index);
    }
 
    UFUNCTION(BlueprintPure, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static int32 Num(const FScriptTypedElementListProxy ElementList)
    {
        FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
        return ElementListPtr ? ElementListPtr->Num() : 0;
    }
 
    UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static void Shrink(FScriptTypedElementListProxy ElementList)
    {
        if (FScriptTypedElementListPtr ElementListPtr = ElementList.GetElementList())
        {
            ElementListPtr->Shrink();
        }
    }
 
    UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static void Reserve(FScriptTypedElementListProxy ElementList, const int32 Size)
    {
        if (FScriptTypedElementListPtr ElementListPtr = ElementList.GetElementList())
        {
            ElementListPtr->Reserve(Size);
        }
    }
 
    UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static void Empty(FScriptTypedElementListProxy ElementList, const int32 Slack = 0)
    {
        if (FScriptTypedElementListPtr ElementListPtr = ElementList.GetElementList())
        {
            ElementListPtr->Empty(Slack);
        }
    }
 
    UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static void Reset(FScriptTypedElementListProxy ElementList)
    {
        if (FScriptTypedElementListPtr ElementListPtr = ElementList.GetElementList())
        {
            ElementListPtr->Reset();
        }
    }
 
    UFUNCTION(BlueprintPure, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static bool Contains(const FScriptTypedElementListProxy ElementList, const FScriptTypedElementHandle& ElementHandle)
    {
        FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
        return ElementListPtr && ElementListPtr->Contains(ElementHandle);
    }
 
    UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static bool Add(FScriptTypedElementListProxy ElementList, const FScriptTypedElementHandle& ElementHandle)
    {
        FScriptTypedElementListPtr ElementListPtr = ElementList.GetElementList();
        return ElementListPtr && ElementListPtr->Add(ElementHandle);
    }
 
    UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static void Append(FScriptTypedElementListProxy ElementList, const TArray<FScriptTypedElementHandle>& ElementHandles)
    {
        if (FScriptTypedElementListPtr ElementListPtr = ElementList.GetElementList())
        {
            ElementListPtr->Append(ElementHandles);
        }
    }
 
    UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static void AppendList(FScriptTypedElementListProxy ElementList, const FScriptTypedElementListProxy OtherElementList)
    {
        FScriptTypedElementListPtr ElementListPtr = ElementList.GetElementList();
        FScriptTypedElementListConstPtr OtherElementListPtr = OtherElementList.GetElementList();
        if (ElementListPtr && OtherElementListPtr)
        {
            ElementListPtr->Append(OtherElementListPtr.ToSharedRef());
        }
    }
 
    UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
    static bool Remove(FScriptTypedElementListProxy ElementList, const FScriptTypedElementHandle& ElementHandle)
    {
        FScriptTypedElementListPtr ElementListPtr = ElementList.GetElementList();
        return ElementListPtr && ElementListPtr->Remove(ElementHandle);
    }
};