UKismetNodeHelperLibrary

This kismet library is used for helper functions primarily used in the kismet compiler

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Kismet/KismetNodeHelperLibrary.h

Include

#include "Kismet/KismetNodeHelperLibrary.h"

Syntax

class UKismetNodeHelperLibrary : public UBlueprintFunctionLibrary

Remarks

This kismet library is used for helper functions primarily used in the kismet compiler

Do not change the signatures for any of these functions as it can break the kismet compiler and/or the nodes referencing them

Constructors

Name Description

Public function

UKismetNodeHelperLibrary

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static

bool

 

BitIsMarked

(
    int32 Data,
    int32 Index
)

Returns whether the bit at index "Index" is set or not in the data

Public function Static

void

 

ClearAllBits

(
    int32& Data
)

Clears all of the bit in the data

Public function Static

void

 

ClearBit

(
    int32& Data,
    int32 Index
)

Clears the bit at index "Index" in the data

Public function Static

FName

 

GetEnumeratorName

(
    const UEnum* Enum,
    uint8 EnumeratorValue
)

Gets enumerator name.

Public function Static

FString

 

GetEnumeratorUserFriendlyName

(
    const UEnum* Enum,
    uint8 EnumeratorValue
)

Gets enumerator name as FString.

Public function Static

uint8

 

GetEnumeratorValueFromIndex

(
    const UEnum* Enum,
    uint8 EnumeratorIndex
)

Public function Static

int32

 

GetFirstUnmarkedBit

(
    int32 Data,
    int32 StartIdx,
    int32 NumBits
)

Gets the first index not already marked starting from a specific index and returns the bit index selected

Public function Static

int32

 

GetRandomUnmarkedBit

(
    int32 Data,
    int32 StartIdx,
    int32 NumBits
)

Gets a random not already marked bit and returns the bit index selected

Public function Static

int32

 

GetUnmarkedBit

(
    int32 Data,
    int32 StartIdx,
    int32 NumBits,
    bool bRandom
)

Gets an already unmarked bit and returns the bit index selected

Public function Static

uint8

 

GetValidValue

(
    const UEnum* Enum,
    uint8 EnumeratorValue
)

Public function Static

bool

 

HasMarkedBit

(
    int32 Data,
    int32 NumBits
)

Returns whether there exists a marked bit in the data

Public function Static

bool

 

HasUnmarkedBit

(
    int32 Data,
    int32 NumBits
)

Returns whether there exists an unmarked bit in the data

Public function Static

void

 

MarkBit

(
    int32& Data,
    int32 Index
)

Sets the bit at index "Index" in the data
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss