Pulse helpers API reference

This page documents the remaining helper APIs from Source/PulseGameCore/Public/**/*Helpers.h (excluding the already documented HUD helper page).

Helper files with no Blueprint-callable API

The following helper classes are currently empty Blueprint libraries (no UFUNCTION API):

• UBlueprintActorHelpers
• UBlueprintObjectHelpers
• UBlueprintSetHelpers
• UPulseRandomHelpers

PulseRandomHelpers.h still contains a large C++ namespace utility API under Pulse::Random (random index/element helpers and unique/non-unique random sampling helpers for arrays/sets).

UPulseActorHelpers (PulseActorHelpers.h)

• ActorsToTransforms, ActorsToTransformsFromSet
• ActorsToLocations, ActorsToLocationsFromSet
• ActorsToRotations, ActorsToRotationsFromSet
• ActorsToScales, ActorsToScalesFromSet
• ActorsToDistancesSquared, ActorsToDistancesFromSetSquared
• ActorsToDistances, ActorsToDistancesFromSet
• SortActorsByDistanceInline
• SortActorsByDistance, SortActorsByDistanceFromSet
• GetNearestOrFarthestActor, GetNearestOrFarthestActorFromSet
• GetNearestOrFarthestActorIndex, GetNearestOrFarthestActorIndexFromSet
• GetNearestOrFarthestActorIndexes
• GetNearestOrFarthestActorFromEachOther, GetNearestOrFarthestActorFromEachOtherFromSet
• GetFirstActorWithTag, GetFirstActorWithTagFromSet
• GetActorsWithTag, GetActorsWithTagFromSet

UPulseDebugHelpers (PulseDebugHelpers.h)

• LogInPIE
• LogInPIEAndDefault
• ConditionLogInPIE
• ConditionLogInPIEAndDefault
• Assert
• LogFatal

UPulseFileHelpers (PulseFileHelpers.h)

• CreateDirectory, DeleteFile, DeleteDirectory
• RenameFile, CopyFile, MoveFile
• ReadFileToArray, ReadFileToString
• WriteArrayToFile, WriteStringToFile, AppendStringToFile
• GetFilesInDirectory
• GetFileSize, GetFileLastModifiedTime, GetFileLastAccessTime
• GetDirectoryName
• OpenFileDialog, OpenFileDialogMulti, OpenDirectoryDialog, SaveFileDialog

UPulseNameHelpers (PulseNameHelpers.h)

• GetNone
• IsNone
• IsNoneBranch
• ToUpper
• ToLower
• Append
• StartsWith
• EndsWith
• StringToNameArray

UPulseNumberHelpers (PulseNumberHelpers.h)

• SubtractFromOne
• DivideByTwo_Int, DivideByTwo_Int64, DivideByTwo_Float, DivideByTwo_Byte
• AddOne_Int, AddOne_Int64, AddOne_Float, AddOne_Byte
• Negate_Int, Negate_Int64, Negate_Float
• SubtractOne_Int, SubtractOne_Int64, SubtractOne_Byte, SubtractOne_Float
• AddAll_Int, AddAll_Int64, AddAll_Float
• MultiplyAll_Int, MultiplyAll_Int64, MultiplyAll_Float
• IsInRange_Int, IsInRange_Int64, IsInRange_Float, IsInRange_Byte
• IsInRangeWithTolerance_Int, IsInRangeWithTolerance_Int64, IsInRangeWithTolerance_Float, IsInRangeWithTolerance_Byte
• Average_Float, Average_Int, Average_Int64
• Avarage_FloatSet, Avarage_IntSet, Avarage_Int64Set
• PercentageInRange_Float, PercentageInRange_Int, PercentageInRange_Int64

UPulseObjectHelpers (PulseObjectHelpers.h)

• ObjectsToStrings
• CastArray

UPulseStringHelpers (PulseStringHelpers.h)

• DateTimeToString
• StringToDateTime
• NameToStringArray
• IntegerToStringArray
• Integer64ToStringArray
• FloatToStringArray
• BoolToStringArray

UPulseOnlineHelpers (Online/PulseOnlineHelpers.h)

• Session browser fields:
  • GetPingInMs
  • GetServerName
  • GetCurrentPlayers
  • GetMaxPlayers
  • GetOpenSlots
• Session setting construction:
  • MakeStringSessionSetting
  • MakeBoolSessionSetting
  • MakeInt32SessionSetting
  • MakeFloatSessionSetting
  • AddSessionSetting
  • GetSessionSettings
• Connect string helpers:
  • GetResolvedConnectString
  • GetResolvedConnectStringForSession
• Session state checks:
  • HasActiveGameSession
  • HasActiveGameSessionNotDestroying

UBlueprintArrayHelpers (Blueprint/BlueprintArrayHelpers.h)

Custom-thunk generic array utilities:

• RandomIndex
• RandomIndexFromStream
• GetArrayWeight
• RandomIndexWeighted
• RandomElementWeighted
• RandomIndexWeightedFromStream
• RandomElementWeightedFromStream
• RemoveDuplicates
• ArrayDifference
• ArrayDifferenceBoth
• IsArrayEmpty
• IsArrayNotEmpty
• CheckElements_AllExists
• CheckElements_AnyExists
• CheckElements_NoneExists

UBlueprintNumberHelpers (Blueprint/BlueprintNumberHelpers.h)

Numeric limit constants:

• GetMinByte, GetMaxByte
• GetMinInt32, GetMaxInt32
• GetMinInt64, GetMaxInt64
• GetMinFloat, GetMaxFloat
• GetMinDouble, GetMaxDouble

UPulseTraceHelpers (PulseTraceHelpers.h)

Trace parameter builders

• Shape setup:
  • SetTraceShapeToSphere
  • SetTraceShapeToBox
  • SetTraceShapeToCapsule
  • SetTraceShapeToLine
• Type setup:
  • SetTraceTypeToChannel
  • SetTraceTypeToObject
  • AddObjectTypeToTrace
  • RemoveObjectTypeFromTrace
• Query/debug setup:
  • AddActorToIgnoreList
  • RemoveActorFromIgnoreList
  • ClearIgnoreList
  • SetTraceToMulti
  • SetTraceToComplex
  • SetTraceToIgnoreSelf
  • SetTraceToDrawDebug
  • SetTraceColor
  • SetTraceHitColor
  • SetTraceDrawTime
  • CopyShapeFromTrace
  • CopyTraceTypeFromTrace
  • CopyQueryFromTrace
  • CopyDebugFromTrace

Trace execution helpers

• Base and direction traces:
  • PerformTrace
  • PerformTraceInDirection
  • PerformTraceWithRotation
• Actor/location variants:
  • PerformTraceFromActors
  • PerformTraceFromActorToLocation
  • PerformTraceFromLocationToActor
  • PerformTraceDirection
  • PerformTraceDirectionActors
  • PerformTraceDirectionFromLocationToActor
  • PerformTraceDirectionFromActorToLocation
• Convenience directional traces:
  • PerformTraceForward
  • PerformTraceBackward
  • PerformTraceRight
  • PerformTraceLeft
  • PerformTraceComponentForward
  • PerformTraceComponentBackward
  • PerformTraceComponentRight
  • PerformTraceComponentLeft
• Async trace:
  • PerformAsyncTrace
  • IsValidTraceHandle
  • EqualEqual_PulseAsyncTraceHandle
  • NotEqual_PulseAsyncTraceHandle

UPulseVectorHelpers (PulseVectorHelpers.h)

UPulseVectorHelpers is the largest helper API and covers:

1. 3D geometry helpers: sphere/box helpers, nearest point calculations, min/max combination, grid snapping, inside-range checks.
2. 3D random generation: random points on/in sphere/box/circle/line/hollow variants.
3. Distance/sorting utilities: distance arrays, nearest/farthest element, sorted point outputs (3D and 2D).
4. 2D vector helpers: 2D variants of random point, nearest point, range and sorting methods.
5. Rotator helpers: combined min/max, look-at rotation helpers, random rotator generation, axis helpers, range checks.

Representative API entry points:

• GetSphereCenterAndRadius, GetBoxCenterAndExtent, GetBoxEdges
• RandomPointInSphere, RandomPointOnSphere, RandomPointInBox, RandomPointOnLine
• MakeDistances, MakeDistancesSquared, SortPointsByDistance, SortPointsByDistanceInline
• GetNearestOrFarthestPoint, GetNearestOrFarthestPointIndex
• RandomPointOnCircle, RandomPointInCircle, RandomPointOnHollowCircle
• RandomVectorInRange, RandomVectorInRangeStream
• GetNearestPointOnLine, GetNearestPointOnBox, GetNearestPointOnSphere
• MakeDistances2D, SortPointsByDistance2D, GetNearestOrFarthestPoint2D
• RandomRotator, RandomRotatorStream, RandomRotatorInRange
• FindLookAtRotationActors, FindLookAtRotationActorLocation, FindLookAtRotationLocationActor

For full signatures, use the header directly:

• Source/PulseGameCore/Public/PulseVectorHelpers.h