ArticyFunctionLibrary.h

//  
// Copyright (c) 2023 articy Software GmbH & Co. KG. All rights reserved.  
//
 
#pragma once
 
#include "Kismet/BlueprintFunctionLibrary.h"
#include "ArticyObject.h"
#include "ArticyFlowPlayer.h"
#include "ArticyFunctionLibrary.generated.h"

UCLASS()
class ARTICYRUNTIME_API UArticyFunctionLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
 
public:
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get Object", DefaultToSelf = "WorldContext", DeterminesOutputType = "CastTo"), Category = "ArticyRef")
    static UArticyObject* ArticyRef_GetObject(FArticyRef Ref, TSubclassOf<class UArticyObject> CastTo, const UObject* WorldContext);

    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Set Object", DefaultToSelf = "WorldContext"), Category = "ArticyRef")
    static void ArticyRef_SetObject(UPARAM(Ref) FArticyRef& Ref, UPARAM(Ref) UArticyObject* Object);

    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get Object Id", DefaultToSelf = "WorldContext", BlueprintAutoCast), Category = "ArticyRef")
    static FArticyId ArticyRef_GetObjectId(FArticyRef Ref);

    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Set Object Id", DefaultToSelf = "WorldContext", BlueprintAutoCast), Category = "ArticyRef")
    static void ArticyRef_SetObjectId(UPARAM(Ref) FArticyRef& Ref, UPARAM(Ref) FArticyId Id);

    UFUNCTION(BlueprintCallable, BlueprintPure, Category = "ArtiycRef")
    static bool MatchesRaw(const FArticyRef& A, const FArticyRef& B);

    UFUNCTION(BlueprintCallable, BlueprintPure, Category = "ArtiycRef")
    static bool MatchesEffective(const FArticyRef& A, const FArticyRef& B);

    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get Object", DefaultToSelf = "WorldContext", DeterminesOutputType = "CastTo"), Category = "ArticyId")
    static UArticyObject* ArticyId_GetObject(FArticyId Id, TSubclassOf<class UArticyObject> CastTo, const UObject* WorldContext);

    UFUNCTION(BlueprintPure, meta = (DisplayName = "To Articy Id"), Category = "ArticyId")
    static FArticyId ArticyId_FromString(UPARAM(Ref) const FString& hex);

    UFUNCTION(BlueprintPure, meta = (DisplayName = "To Hex String"), Category = "ArticyId")
    static FString ArticyId_ToString(UPARAM(Ref) const FArticyId& Id);

    UFUNCTION(BlueprintPure, meta = (DisplayName = "Equal (ArticyId)", CompactNodeTitle = "==", Keywords = "== equal"), Category = "ArticyId")
    static bool ArticyId_Equal(const FArticyId& A, const FArticyId& B);

    UFUNCTION(BlueprintPure, meta = (DisplayName = "Not Equal (ArticyId)", CompactNodeTitle = "!=", Keywords = "!= not equal"), Category = "ArticyId")
    static bool ArticyId_NotEqual(const FArticyId& A, const FArticyId& B);

    UFUNCTION(BlueprintPure, meta = (DisplayName = "Is Valid"), Category = "ArticyId")
    static bool ArticyId_IsValid(const FArticyId& Id);

    UFUNCTION(BlueprintPure, meta = (DisplayName = "Make ArticyGvName from full name"), Category = "ArticyId")
    static FArticyGvName ArticyGvName_MakeFromFullName(const FName& FullName);

    UFUNCTION(BlueprintPure, meta = (DisplayName = "Make ArticyGvName from namespace & variable"), Category = "ArticyId")
    static FArticyGvName ArticyGvName_MakeFromVariableAndNamespace(const FName& Variable, const FName& Namespace);

    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get Target"), Category = "ArticyBranch")
    static TScriptInterface<class IArticyFlowObject> GetBranchTarget(UPARAM(ref) const struct FArticyBranch& Branch);

    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get Seen Counter"), Category = "ArticyNode")
    static int GetNodeSeenCounter(TScriptInterface<class IArticyFlowObject> Node, const UObject* WorldContext);

    UFUNCTION(BlueprintPure, meta = (DisplayName = "Set Seen Counter"), Category = "ArticyNode")
    static int SetNodeSeenCounter(TScriptInterface<class IArticyFlowObject> Node, int Value, const UObject* WorldContext);
};