KismetNodeHelperLibrary.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 "Kismet/BlueprintFunctionLibrary.h"
#include "KismetNodeHelperLibrary.generated.h"
 
UCLASS(meta=(BlueprintThreadSafe), MinimalAPI)
class UKismetNodeHelperLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_UCLASS_BODY()
 
    // --- Functions for handling bitmasking an integer as an array of bools ------------------------------
 
    
     UFUNCTION(BlueprintCallable, meta=(BlueprintInternalUseOnly = "TRUE"))
    static ENGINE_API bool BitIsMarked(int32 Data, int32 Index);
 
    UFUNCTION(BlueprintCallable, meta=(BlueprintInternalUseOnly = "TRUE"))
    static ENGINE_API void MarkBit(int32& Data, int32 Index);
 
    UFUNCTION(BlueprintCallable, meta=(BlueprintInternalUseOnly = "TRUE"))
    static ENGINE_API void ClearBit(int32& Data, int32 Index);
 
    UFUNCTION(BlueprintCallable, meta=(BlueprintInternalUseOnly = "TRUE"))
    static ENGINE_API void ClearAllBits(int32& Data);
 
    UFUNCTION(BlueprintCallable, meta=(BlueprintInternalUseOnly = "TRUE"))
    static ENGINE_API bool HasUnmarkedBit(int32 Data, int32 NumBits);
 
    UFUNCTION(BlueprintCallable, meta=(BlueprintInternalUseOnly = "TRUE"))
    static ENGINE_API bool HasMarkedBit(int32 Data, int32 NumBits);
 
    UFUNCTION(BlueprintCallable, meta=(BlueprintInternalUseOnly = "TRUE", NotBlueprintThreadSafe))
    static ENGINE_API int32 GetUnmarkedBit(int32 Data, int32 StartIdx, int32 NumBits, bool bRandom);
 
    UFUNCTION(BlueprintCallable, meta=(BlueprintInternalUseOnly = "TRUE", NotBlueprintThreadSafe))
    static ENGINE_API int32 GetRandomUnmarkedBit(int32 Data, int32 StartIdx, int32 NumBits);
 
    UFUNCTION(BlueprintCallable, meta=(BlueprintInternalUseOnly = "TRUE"))
    static ENGINE_API int32 GetFirstUnmarkedBit(int32 Data, int32 StartIdx, int32 NumBits);
 
    // --- Functions for handling Enumerators ------------------------------
 
    UFUNCTION(BlueprintPure, meta=(BlueprintInternalUseOnly = "TRUE"))
    static ENGINE_API FName GetEnumeratorName(const UEnum* Enum, uint8 EnumeratorValue);
 
    UFUNCTION(BlueprintPure, meta=(BlueprintInternalUseOnly = "TRUE"))
    static ENGINE_API FString GetEnumeratorUserFriendlyName(const UEnum* Enum, uint8 EnumeratorValue);
 
    UFUNCTION(BlueprintPure, meta=(BlueprintInternalUseOnly = "TRUE"))
    static ENGINE_API uint8 GetValidValue(const UEnum* Enum, uint8 EnumeratorValue);
 
    UFUNCTION(BlueprintPure, meta=(BlueprintInternalUseOnly = "TRUE"))
    static ENGINE_API uint8 GetEnumeratorValueFromIndex(const UEnum* Enum, uint8 EnumeratorIndex);
};