Show / Hide Table of Contents

Class KismetNodeHelperLibrary

Kismet Node Helper Library

Inheritance
System.Object
UObject
BlueprintFunctionLibrary
KismetNodeHelperLibrary
Inherited Members
UObject.TransientPackage
UObject.CastTo<T>(UObject)
UObject.CastTo(UObject, Type)
UObject.RemoveObject(UObject)
UObject.MakeObjectArrayField<T>(NativeArray*)
UObject.NotImplemented<T>()
UObject.Construct()
UObject.GetHashCode()
UObject.GetName()
UObject.ToString()
UObject.Name
UObject._None
UObject.None
UObject.ObjPointer
UObject.LoadObjectFromClass(Class, UObject, String, String, LoadFlags, PackageMap, Boolean)
UObject.LoadClass(Class, UObject, String, String, LoadFlags, PackageMap)
UObject.GetPropertyFor<T>(Name)
UObject.ExecuteUbergraph
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class KismetNodeHelperLibrary : BlueprintFunctionLibrary

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static KismetNodeHelperLibrary DefaultObject { get; }
Property Value
Type Description
KismetNodeHelperLibrary
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

BitIsMarked(Int32, Int32)

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

Declaration
public static bool BitIsMarked(int Data, int Index)
Parameters
Type Name Description
System.Int32 Data
System.Int32 Index
Returns
Type Description
System.Boolean
Remarks

param Data - The integer containing the bits that are being tested against @param Index - The bit index into the Data that we are inquiring @return - Whether the bit at index "Index" is set or not

| Improve this Doc View Source

ClearAllBits()

Clears all of the bit in the data @

Declaration
public static int ClearAllBits()
Returns
Type Description
System.Int32
Remarks

param Data - The integer containing the bits that are being cleared

| Improve this Doc View Source

ClearBit(Int32)

Clears the bit at index "Index" in the data @

Declaration
public static int ClearBit(int Index)
Parameters
Type Name Description
System.Int32 Index
Returns
Type Description
System.Int32
Remarks

param Data - The integer containing the bits that are being cleared @param Index - The bit index into the Data that we are clearing

| Improve this Doc View Source

GetEnumeratorName(UEnum, Byte)

Gets enumerator name.

Declaration
public static Name GetEnumeratorName(UEnum UEnum, byte EnumeratorValue)
Parameters
Type Name Description
UEnum UEnum
System.Byte EnumeratorValue
Returns
Type Description
Name
Remarks

@param Enum - Enumeration @param EnumeratorValue - Value of searched enumeration @return - name of the searched enumerator, or NAME_None

| Improve this Doc View Source

GetEnumeratorUserFriendlyName(UEnum, Byte)

Gets enumerator name as FString.

Declaration
public static string GetEnumeratorUserFriendlyName(UEnum UEnum, byte EnumeratorValue)
Parameters
Type Name Description
UEnum UEnum
System.Byte EnumeratorValue
Returns
Type Description
System.String
Remarks

Use DeisplayName when possible.

@param Enum - Enumeration @param EnumeratorValue - Value of searched enumeration @return - name of the searched enumerator, or NAME_None

| Improve this Doc View Source

GetEnumeratorValueFromIndex(UEnum, Byte)

@

Declaration
public static byte GetEnumeratorValueFromIndex(UEnum UEnum, byte EnumeratorIndex)
Parameters
Type Name Description
UEnum UEnum
System.Byte EnumeratorIndex
Returns
Type Description
System.Byte
Remarks

param Enum - Enumeration @param EnumeratorIndex - Input index @return - The value of the enumerator, or INDEX_NONE

| Improve this Doc View Source

GetFirstUnmarkedBit(Int32, Int32, Int32)

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

Declaration
public static int GetFirstUnmarkedBit(int Data, int StartIdx, int NumBits)
Parameters
Type Name Description
System.Int32 Data
System.Int32 StartIdx
System.Int32 NumBits
Returns
Type Description
System.Int32
Remarks

param Data - The integer containing the bits that are being set @param StartIdx - The index to start looking for an available index from @param NumBits - The logical number of bits we want to track @return - The index that was selected (returns INDEX_NONE if there was no unmarked bits to choose from)

| Improve this Doc View Source

GetRandomUnmarkedBit(Int32, Int32, Int32)

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

Declaration
public static int GetRandomUnmarkedBit(int Data, int StartIdx, int NumBits)
Parameters
Type Name Description
System.Int32 Data
System.Int32 StartIdx
System.Int32 NumBits
Returns
Type Description
System.Int32
Remarks

param Data - The integer containing the bits that are being set @param NumBits - The logical number of bits we want to track @return - The index that was selected (returns INDEX_NONE if there was no unmarked bits to choose from)

| Improve this Doc View Source

GetUnmarkedBit(Int32, Int32, Int32, Boolean)

Gets an already unmarked bit and returns the bit index selected @

Declaration
public static int GetUnmarkedBit(int Data, int StartIdx, int NumBits, bool bRandom)
Parameters
Type Name Description
System.Int32 Data
System.Int32 StartIdx
System.Int32 NumBits
System.Boolean bRandom
Returns
Type Description
System.Int32
Remarks

param Data - The integer containing the bits that are being set @param StartIdx - The index to start with when determining the selection' @param NumBits - The logical number of bits we want to track @param bRandom - Whether to select a random index or not @return - The index that was selected (returns INDEX_NONE if there was no unmarked bits to choose from)

| Improve this Doc View Source

GetValidValue(UEnum, Byte)

@

Declaration
public static byte GetValidValue(UEnum UEnum, byte EnumeratorValue)
Parameters
Type Name Description
UEnum UEnum
System.Byte EnumeratorValue
Returns
Type Description
System.Byte
Remarks

param Enum - Enumeration @param EnumeratorIndex - Input value @return - if EnumeratorIndex is valid return EnumeratorIndex, otherwise return MAX value of Enum

| Improve this Doc View Source

HasMarkedBit(Int32, Int32)

Returns whether there exists a marked bit in the data @

Declaration
public static bool HasMarkedBit(int Data, int NumBits)
Parameters
Type Name Description
System.Int32 Data
System.Int32 NumBits
Returns
Type Description
System.Boolean
Remarks

param Data - The data being tested against @param NumBits - The logical number of bits we want to track @return - Whether there is a bit marked in the data

| Improve this Doc View Source

HasUnmarkedBit(Int32, Int32)

Returns whether there exists an unmarked bit in the data @

Declaration
public static bool HasUnmarkedBit(int Data, int NumBits)
Parameters
Type Name Description
System.Int32 Data
System.Int32 NumBits
Returns
Type Description
System.Boolean
Remarks

param Data - The data being tested against @param NumBits - The logical number of bits we want to track @return - Whether there is a bit not marked in the data

| Improve this Doc View Source

MarkBit(Int32)

Sets the bit at index "Index" in the data @

Declaration
public static int MarkBit(int Index)
Parameters
Type Name Description
System.Int32 Index
Returns
Type Description
System.Int32
Remarks

param Data - The integer containing the bits that are being set @param Index - The bit index into the Data that we are setting

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static KismetNodeHelperLibrary New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
KismetNodeHelperLibrary

Operators

| Improve this Doc View Source

Implicit(IntPtr to KismetNodeHelperLibrary)

Convert from IntPtr to UObject

Declaration
public static implicit operator KismetNodeHelperLibrary(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
KismetNodeHelperLibrary
  • Improve this Doc
  • View Source
Back to top Generated by DocFX