Show / Hide Table of Contents

Class KismetMathLibrary

Kismet Math Library

Inheritance
System.Object
UObject
BlueprintFunctionLibrary
KismetMathLibrary
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 KismetMathLibrary : BlueprintFunctionLibrary

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static KismetMathLibrary DefaultObject { get; }
Property Value
Type Description
KismetMathLibrary
| 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

Abs(Single)

Returns the absolute (positive) value of A

Declaration
public static float Abs(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

Abs_Int(Int32)

Returns the absolute (positive) value of A

Declaration
public static int Abs_Int(int A)
Parameters
Type Name Description
System.Int32 A
Returns
Type Description
System.Int32
| Improve this Doc View Source

Acos(Single)

Returns the inverse cosine (arccos) of A (result is in Radians)

Declaration
public static float Acos(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

Add_ByteByte(Byte, Byte)

Addition (A + B)

Declaration
public static byte Add_ByteByte(byte A, byte B)
Parameters
Type Name Description
System.Byte A
System.Byte B
Returns
Type Description
System.Byte
| Improve this Doc View Source

Add_DateTimeTimespan(FDateTime, Timespan)

Addition (A + B)

Declaration
public static FDateTime Add_DateTimeTimespan(FDateTime A, Timespan B)
Parameters
Type Name Description
FDateTime A
Timespan B
Returns
Type Description
FDateTime
| Improve this Doc View Source

Add_FloatFloat(Single, Single)

Addition (A + B)

Declaration
public static float Add_FloatFloat(float A, float B)
Parameters
Type Name Description
System.Single A
System.Single B
Returns
Type Description
System.Single
| Improve this Doc View Source

Add_IntInt(Int32, Int32)

Addition (A + B)

Declaration
public static int Add_IntInt(int A, int B)
Parameters
Type Name Description
System.Int32 A
System.Int32 B
Returns
Type Description
System.Int32
| Improve this Doc View Source

Add_TimespanTimespan(Timespan, Timespan)

Addition (A + B)

Declaration
public static Timespan Add_TimespanTimespan(Timespan A, Timespan B)
Parameters
Type Name Description
Timespan A
Timespan B
Returns
Type Description
Timespan
| Improve this Doc View Source

Add_Vector2DFloat(Vector2D, Single)

Returns Vector A added by B

Declaration
public static Vector2D Add_Vector2DFloat(Vector2D A, float B)
Parameters
Type Name Description
Vector2D A
System.Single B
Returns
Type Description
Vector2D
| Improve this Doc View Source

Add_Vector2DVector2D(Vector2D, Vector2D)

Returns addition of Vector A and Vector B (A + B)

Declaration
public static Vector2D Add_Vector2DVector2D(Vector2D A, Vector2D B)
Parameters
Type Name Description
Vector2D A
Vector2D B
Returns
Type Description
Vector2D
| Improve this Doc View Source

Add_VectorFloat(Vector, Single)

Adds a float to each component of a vector

Declaration
public static Vector Add_VectorFloat(Vector A, float B)
Parameters
Type Name Description
Vector A
System.Single B
Returns
Type Description
Vector
| Improve this Doc View Source

Add_VectorInt(Vector, Int32)

Adds an integer to each component of a vector

Declaration
public static Vector Add_VectorInt(Vector A, int B)
Parameters
Type Name Description
Vector A
System.Int32 B
Returns
Type Description
Vector
| Improve this Doc View Source

Add_VectorVector(Vector, Vector)

Vector addition

Declaration
public static Vector Add_VectorVector(Vector A, Vector B)
Parameters
Type Name Description
Vector A
Vector B
Returns
Type Description
Vector
| Improve this Doc View Source

And_IntInt(Int32, Int32)

Declaration
public static int And_IntInt(int A, int B)
Parameters
Type Name Description
System.Int32 A
System.Int32 B
Returns
Type Description
System.Int32
| Improve this Doc View Source

Asin(Single)

Returns the inverse sine (arcsin) of A (result is in Radians)

Declaration
public static float Asin(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

Atan(Single)

Returns the inverse tan (atan) (result is in Radians)

Declaration
public static float Atan(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

Atan2(Single, Single)

Returns the inverse tan (atan2) of A/B (result is in Radians)

Declaration
public static float Atan2(float A, float B)
Parameters
Type Name Description
System.Single A
System.Single B
Returns
Type Description
System.Single
| Improve this Doc View Source

BMax(Byte, Byte)

Returns the maximum value of A and B

Declaration
public static byte BMax(byte A, byte B)
Parameters
Type Name Description
System.Byte A
System.Byte B
Returns
Type Description
System.Byte
| Improve this Doc View Source

BMin(Byte, Byte)

Returns the minimum value of A and B

Declaration
public static byte BMin(byte A, byte B)
Parameters
Type Name Description
System.Byte A
System.Byte B
Returns
Type Description
System.Byte
| Improve this Doc View Source

BooleanAND(Boolean, Boolean)

Returns the logical AND of two values (A AND B)

Declaration
public static bool BooleanAND(bool A, bool B)
Parameters
Type Name Description
System.Boolean A
System.Boolean B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

BooleanNAND(Boolean, Boolean)

Returns the logical NAND of two values (A AND B)

Declaration
public static bool BooleanNAND(bool A, bool B)
Parameters
Type Name Description
System.Boolean A
System.Boolean B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

BooleanNOR(Boolean, Boolean)

Returns the logical Not OR of two values (A NOR B)

Declaration
public static bool BooleanNOR(bool A, bool B)
Parameters
Type Name Description
System.Boolean A
System.Boolean B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

BooleanOR(Boolean, Boolean)

Returns the logical OR of two values (A OR B)

Declaration
public static bool BooleanOR(bool A, bool B)
Parameters
Type Name Description
System.Boolean A
System.Boolean B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

BooleanXOR(Boolean, Boolean)

Returns the logical eXclusive OR of two values (A XOR B)

Declaration
public static bool BooleanXOR(bool A, bool B)
Parameters
Type Name Description
System.Boolean A
System.Boolean B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

BreakColor(LinearColor)

Breaks apart a color into individual RGB components (as well as alpha)

Declaration
public static (float, float, float, float) BreakColor(LinearColor InColor)
Parameters
Type Name Description
LinearColor InColor
Returns
Type Description
System.ValueTuple<System.Single, System.Single, System.Single, System.Single>
| Improve this Doc View Source

BreakDateTime(FDateTime)

Breaks a DateTime into its components

Declaration
public static (int, int, int, int, int, int, int) BreakDateTime(FDateTime InDateTime)
Parameters
Type Name Description
FDateTime InDateTime
Returns
Type Description
System.ValueTuple<System.Int32, System.Int32, System.Int32, System.Int32, System.Int32, System.Int32, System.Int32>
| Improve this Doc View Source

BreakFrameRate(FrameRate)

Breaks a FFrameRate into a numerator and denominator.

Declaration
public static (int, int) BreakFrameRate(FrameRate InFrameRate)
Parameters
Type Name Description
FrameRate InFrameRate
Returns
Type Description
System.ValueTuple<System.Int32, System.Int32>
| Improve this Doc View Source

BreakQualifiedFrameTime(QualifiedFrameTime)

Breaks a FQualifiedFrameTime into its component parts again.

Declaration
public static (FrameNumber, FrameRate, float) BreakQualifiedFrameTime(QualifiedFrameTime InFrameTime)
Parameters
Type Name Description
QualifiedFrameTime InFrameTime
Returns
Type Description
System.ValueTuple<FrameNumber, FrameRate, System.Single>
| Improve this Doc View Source

BreakRandomStream(RandomStream)

Breaks apart a random number generator

Declaration
public static int BreakRandomStream(RandomStream InRandomStream)
Parameters
Type Name Description
RandomStream InRandomStream
Returns
Type Description
System.Int32
| Improve this Doc View Source

BreakRotator(Rotator)

Breaks apart a rotator into {Roll, Pitch, Yaw} angles in degrees

Declaration
public static (float, float, float) BreakRotator(Rotator InRot)
Parameters
Type Name Description
Rotator InRot
Returns
Type Description
System.ValueTuple<System.Single, System.Single, System.Single>
| Improve this Doc View Source

BreakRotIntoAxes(Rotator)

Breaks apart a rotator into its component axes

Declaration
public static (Vector, Vector, Vector) BreakRotIntoAxes(Rotator InRot)
Parameters
Type Name Description
Rotator InRot
Returns
Type Description
System.ValueTuple<Vector, Vector, Vector>
| Improve this Doc View Source

BreakTimespan(Timespan)

Breaks a Timespan into its components

Declaration
public static (int, int, int, int, int) BreakTimespan(Timespan InTimespan)
Parameters
Type Name Description
Timespan InTimespan
Returns
Type Description
System.ValueTuple<System.Int32, System.Int32, System.Int32, System.Int32, System.Int32>
| Improve this Doc View Source

BreakTimespan2(Timespan)

Breaks a Timespan into its components

Declaration
public static (int, int, int, int, int) BreakTimespan2(Timespan InTimespan)
Parameters
Type Name Description
Timespan InTimespan
Returns
Type Description
System.ValueTuple<System.Int32, System.Int32, System.Int32, System.Int32, System.Int32>
| Improve this Doc View Source

BreakTransform(Transform)

Breaks apart a transform into location, rotation and scale

Declaration
public static (Vector, Rotator, Vector) BreakTransform(Transform InTransform)
Parameters
Type Name Description
Transform InTransform
Returns
Type Description
System.ValueTuple<Vector, Rotator, Vector>
| Improve this Doc View Source

BreakVector(Vector)

Breaks a vector apart into X, Y, Z

Declaration
public static (float, float, float) BreakVector(Vector InVec)
Parameters
Type Name Description
Vector InVec
Returns
Type Description
System.ValueTuple<System.Single, System.Single, System.Single>
| Improve this Doc View Source

BreakVector2D(Vector2D)

Breaks a 2D vector apart into X, Y.

Declaration
public static (float, float) BreakVector2D(Vector2D InVec)
Parameters
Type Name Description
Vector2D InVec
Returns
Type Description
System.ValueTuple<System.Single, System.Single>
| Improve this Doc View Source

CInterpTo(LinearColor, LinearColor, Single, Single)

Interpolates towards a varying target color smoothly.

Declaration
public static LinearColor CInterpTo(LinearColor Current, LinearColor Target, float DeltaTime, float InterpSpeed)
Parameters
Type Name Description
LinearColor Current
LinearColor Target
System.Single DeltaTime
System.Single InterpSpeed
Returns
Type Description
LinearColor
Remarks

@param Current Current Color @param Target Target Color @param DeltaTime Time since last tick @param InterpSpeed Interpolation speed @return New interpolated Color

| Improve this Doc View Source

Clamp(Int32, Int32, Int32)

Returns Value clamped to be between A and B (inclusive)

Declaration
public static int Clamp(int Value, int Min, int Max)
Parameters
Type Name Description
System.Int32 Value
System.Int32 Min
System.Int32 Max
Returns
Type Description
System.Int32
| Improve this Doc View Source

ClampAngle(Single, Single, Single)

Clamps an arbitrary angle to be between the given angles.

Declaration
public static float ClampAngle(float AngleDegrees, float MinAngleDegrees, float MaxAngleDegrees)
Parameters
Type Name Description
System.Single AngleDegrees
System.Single MinAngleDegrees
System.Single MaxAngleDegrees
Returns
Type Description
System.Single
Remarks

Will clamp to nearest boundary.

@param MinAngleDegrees "from" angle that defines the beginning of the range of valid angles (sweeping clockwise) @param MaxAngleDegrees "to" angle that defines the end of the range of valid angles @return Returns clamped angle in the range -180..180.

| Improve this Doc View Source

ClampAxis(Single)

Clamps an angle to the range of [0, 360].

Declaration
public static float ClampAxis(float Angle)
Parameters
Type Name Description
System.Single Angle
Returns
Type Description
System.Single
Remarks

@param Angle The angle to clamp. @return The clamped angle.

| Improve this Doc View Source

ClampVectorSize(Vector, Single, Single)

Clamp the vector size between a min and max length

Declaration
public static Vector ClampVectorSize(Vector A, float Min, float Max)
Parameters
Type Name Description
Vector A
System.Single Min
System.Single Max
Returns
Type Description
Vector
| Improve this Doc View Source

ClassIsChildOf(SubclassOf<UObject>, SubclassOf<UObject>)

Determine if a class is a child of another class.

Declaration
public static bool ClassIsChildOf(SubclassOf<UObject> TestClass, SubclassOf<UObject> ParentClass)
Parameters
Type Name Description
SubclassOf<UObject> TestClass
SubclassOf<UObject> ParentClass
Returns
Type Description
System.Boolean
Remarks

@return true if TestClass == ParentClass, or if TestClass is a child of ParentClass; false otherwise, or if either the value for either parameter is 'None'.

| Improve this Doc View Source

ComposeRotators(Rotator, Rotator)

Combine 2 rotations to give you the resulting rotation of first applying A, then B.

Declaration
public static Rotator ComposeRotators(Rotator A, Rotator B)
Parameters
Type Name Description
Rotator A
Rotator B
Returns
Type Description
Rotator
| Improve this Doc View Source

ComposeTransforms(Transform, Transform)

Compose two transforms in order: A * B.

Declaration
public static Transform ComposeTransforms(Transform A, Transform B)
Parameters
Type Name Description
Transform A
Transform B
Returns
Type Description
Transform
Remarks

Order matters when composing transforms: A * B will yield a transform that logically first applies A then B to any subsequent transformation.

Example: LocalToWorld = ComposeTransforms(DeltaRotation, LocalToWorld) will change rotation in local space by DeltaRotation. Example: LocalToWorld = ComposeTransforms(LocalToWorld, DeltaRotation) will change rotation in world space by DeltaRotation.

@return New transform: A * B

| Improve this Doc View Source

Conv_BoolToByte(Boolean)

Converts a bool to a byte

Declaration
public static byte Conv_BoolToByte(bool InBool)
Parameters
Type Name Description
System.Boolean InBool
Returns
Type Description
System.Byte
| Improve this Doc View Source

Conv_BoolToFloat(Boolean)

Converts a bool to a float (0.0f or 1.0f)

Declaration
public static float Conv_BoolToFloat(bool InBool)
Parameters
Type Name Description
System.Boolean InBool
Returns
Type Description
System.Single
| Improve this Doc View Source

Conv_BoolToInt(Boolean)

Converts a bool to an int

Declaration
public static int Conv_BoolToInt(bool InBool)
Parameters
Type Name Description
System.Boolean InBool
Returns
Type Description
System.Int32
| Improve this Doc View Source

Conv_ByteToFloat(Byte)

Converts a byte to a float

Declaration
public static float Conv_ByteToFloat(byte InByte)
Parameters
Type Name Description
System.Byte InByte
Returns
Type Description
System.Single
| Improve this Doc View Source

Conv_ByteToInt(Byte)

Converts a byte to an integer

Declaration
public static int Conv_ByteToInt(byte InByte)
Parameters
Type Name Description
System.Byte InByte
Returns
Type Description
System.Int32
| Improve this Doc View Source

Conv_ColorToLinearColor(Color)

Converts a color to LinearColor

Declaration
public static LinearColor Conv_ColorToLinearColor(Color InColor)
Parameters
Type Name Description
Color InColor
Returns
Type Description
LinearColor
| Improve this Doc View Source

Conv_FloatToLinearColor(Single)

Convert a float into a LinearColor, where each element is that float

Declaration
public static LinearColor Conv_FloatToLinearColor(float InFloat)
Parameters
Type Name Description
System.Single InFloat
Returns
Type Description
LinearColor
| Improve this Doc View Source

Conv_FloatToVector(Single)

Convert a float into a vector, where each element is that float

Declaration
public static Vector Conv_FloatToVector(float InFloat)
Parameters
Type Name Description
System.Single InFloat
Returns
Type Description
Vector
| Improve this Doc View Source

Conv_IntToBool(Int32)

Converts a int to a bool

Declaration
public static bool Conv_IntToBool(int InInt)
Parameters
Type Name Description
System.Int32 InInt
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Conv_IntToByte(Int32)

Converts an integer to a byte (if the integer is too large, returns the low 8 bits)

Declaration
public static byte Conv_IntToByte(int InInt)
Parameters
Type Name Description
System.Int32 InInt
Returns
Type Description
System.Byte
| Improve this Doc View Source

Conv_IntToFloat(Int32)

Converts an integer to a float

Declaration
public static float Conv_IntToFloat(int InInt)
Parameters
Type Name Description
System.Int32 InInt
Returns
Type Description
System.Single
| Improve this Doc View Source

Conv_IntToIntVector(Int32)

Converts an integer to an IntVector

Declaration
public static IntVector Conv_IntToIntVector(int InInt)
Parameters
Type Name Description
System.Int32 InInt
Returns
Type Description
IntVector
| Improve this Doc View Source

Conv_IntVectorToVector(IntVector)

Convert an IntVector to a vector

Declaration
public static Vector Conv_IntVectorToVector(IntVector InIntVector)
Parameters
Type Name Description
IntVector InIntVector
Returns
Type Description
Vector
| Improve this Doc View Source

Conv_LinearColorToColor(LinearColor)

Converts a LinearColor to a color

Declaration
public static Color Conv_LinearColorToColor(LinearColor InLinearColor)
Parameters
Type Name Description
LinearColor InLinearColor
Returns
Type Description
Color
| Improve this Doc View Source

Conv_LinearColorToVector(LinearColor)

Converts a LinearColor to a vector

Declaration
public static Vector Conv_LinearColorToVector(LinearColor InLinearColor)
Parameters
Type Name Description
LinearColor InLinearColor
Returns
Type Description
Vector
| Improve this Doc View Source

Conv_MatrixToRotator(Matrix)

Convert a Matrix to a Rotator

Declaration
public static Rotator Conv_MatrixToRotator(Matrix InMatrix)
Parameters
Type Name Description
Matrix InMatrix
Returns
Type Description
Rotator
| Improve this Doc View Source

Conv_MatrixToTransform(Matrix)

Convert a Matrix to a Transform

Declaration
public static Transform Conv_MatrixToTransform(Matrix InMatrix)
Parameters
Type Name Description
Matrix InMatrix
Returns
Type Description
Transform
| Improve this Doc View Source

Conv_RotatorToTransform(Rotator)

Convert Rotator to Transform

Declaration
public static Transform Conv_RotatorToTransform(Rotator InRotator)
Parameters
Type Name Description
Rotator InRotator
Returns
Type Description
Transform
| Improve this Doc View Source

Conv_RotatorToVector(Rotator)

Get the X direction vector after this rotation

Declaration
public static Vector Conv_RotatorToVector(Rotator InRot)
Parameters
Type Name Description
Rotator InRot
Returns
Type Description
Vector
| Improve this Doc View Source

Conv_Vector2DToVector(Vector2D, Single)

Convert a Vector2D to a Vector

Declaration
public static Vector Conv_Vector2DToVector(Vector2D InVector2D, float Z)
Parameters
Type Name Description
Vector2D InVector2D
System.Single Z
Returns
Type Description
Vector
| Improve this Doc View Source

Conv_VectorToLinearColor(Vector)

Converts a vector to LinearColor

Declaration
public static LinearColor Conv_VectorToLinearColor(Vector InVec)
Parameters
Type Name Description
Vector InVec
Returns
Type Description
LinearColor
| Improve this Doc View Source

Conv_VectorToRotator(Vector)

Create a rotator which orients X along the supplied direction vector

Declaration
public static Rotator Conv_VectorToRotator(Vector InVec)
Parameters
Type Name Description
Vector InVec
Returns
Type Description
Rotator
| Improve this Doc View Source

Conv_VectorToTransform(Vector)

Convert a vector to a transform. Uses vector as location

Declaration
public static Transform Conv_VectorToTransform(Vector InLocation)
Parameters
Type Name Description
Vector InLocation
Returns
Type Description
Transform
| Improve this Doc View Source

Conv_VectorToVector2D(Vector)

Convert a Vector to a Vector2D

Declaration
public static Vector2D Conv_VectorToVector2D(Vector InVector)
Parameters
Type Name Description
Vector InVector
Returns
Type Description
Vector2D
| Improve this Doc View Source

ConvertTransformToRelative(Transform, Transform)

Returns the given transform, converted to be relative to the given ParentTransform.

Declaration
public static Transform ConvertTransformToRelative(Transform Transform, Transform ParentTransform)
Parameters
Type Name Description
Transform Transform
Transform ParentTransform
Returns
Type Description
Transform
Remarks

Example: AToB = ConvertTransformToRelative(AToWorld, BToWorld) to compute A relative to B.

@param Transform The transform you wish to convert @param ParentTransform The transform the conversion is relative to (in the same space as Transform) @return The new relative transform

| Improve this Doc View Source

Cos(Single)

Returns the cosine of A (expects Radians)

Declaration
public static float Cos(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

CreateVectorFromYawPitch(Single, Single, Single)

Creates a directional vector from rotation values {Pitch, Yaw} supplied in degrees with specified Length

Declaration
public static Vector CreateVectorFromYawPitch(float Yaw, float Pitch, float Length)
Parameters
Type Name Description
System.Single Yaw
System.Single Pitch
System.Single Length
Returns
Type Description
Vector
| Improve this Doc View Source

Cross_VectorVector(Vector, Vector)

Returns the cross product of two 3d vectors

Declaration
public static Vector Cross_VectorVector(Vector A, Vector B)
Parameters
Type Name Description
Vector A
Vector B
Returns
Type Description
Vector
| Improve this Doc View Source

CrossProduct2D(Vector2D, Vector2D)

Returns the cross product of two 2d vectors

Declaration
public static float CrossProduct2D(Vector2D A, Vector2D B)
Parameters
Type Name Description
Vector2D A
Vector2D B
Returns
Type Description
System.Single
| Improve this Doc View Source

DateTimeFromIsoString(String)

Converts a date string in ISO-8601 format to a DateTime object

Declaration
public static (FDateTime, bool) DateTimeFromIsoString(string IsoString)
Parameters
Type Name Description
System.String IsoString
Returns
Type Description
System.ValueTuple<FDateTime, System.Boolean>
| Improve this Doc View Source

DateTimeFromString(String)

Converts a date string to a DateTime object

Declaration
public static (FDateTime, bool) DateTimeFromString(string DateTimeString)
Parameters
Type Name Description
System.String DateTimeString
Returns
Type Description
System.ValueTuple<FDateTime, System.Boolean>
| Improve this Doc View Source

DateTimeMaxValue()

Returns the maximum date and time value

Declaration
public static FDateTime DateTimeMaxValue()
Returns
Type Description
FDateTime
| Improve this Doc View Source

DateTimeMinValue()

Returns the minimum date and time value

Declaration
public static FDateTime DateTimeMinValue()
Returns
Type Description
FDateTime
| Improve this Doc View Source

DaysInMonth(Int32, Int32)

Returns the number of days in the given year and month

Declaration
public static int DaysInMonth(int Year, int Month)
Parameters
Type Name Description
System.Int32 Year
System.Int32 Month
Returns
Type Description
System.Int32
| Improve this Doc View Source

DaysInYear(Int32)

Returns the number of days in the given year

Declaration
public static int DaysInYear(int Year)
Parameters
Type Name Description
System.Int32 Year
Returns
Type Description
System.Int32
| Improve this Doc View Source

DegAcos(Single)

Returns the inverse cos (arccos) of A (result is in Degrees)

Declaration
public static float DegAcos(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

DegAsin(Single)

Returns the inverse sin (arcsin) of A (result is in Degrees)

Declaration
public static float DegAsin(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

DegAtan(Single)

Returns the inverse tan (atan) (result is in Degrees)

Declaration
public static float DegAtan(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

DegAtan2(Single, Single)

Returns the inverse tan (atan2) of A/B (result is in Degrees)

Declaration
public static float DegAtan2(float A, float B)
Parameters
Type Name Description
System.Single A
System.Single B
Returns
Type Description
System.Single
| Improve this Doc View Source

DegCos(Single)

Returns the cos of A (expects Degrees)

Declaration
public static float DegCos(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

DegreesToRadians(Single)

Returns radians value based on the input degrees

Declaration
public static float DegreesToRadians(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

DegSin(Single)

Returns the sin of A (expects Degrees)

Declaration
public static float DegSin(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

DegTan(Single)

Returns the tan of A (expects Degrees)

Declaration
public static float DegTan(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

Divide_ByteByte(Byte, Byte)

Division (A / B)

Declaration
public static byte Divide_ByteByte(byte A, byte B)
Parameters
Type Name Description
System.Byte A
System.Byte B
Returns
Type Description
System.Byte
| Improve this Doc View Source

Divide_FloatFloat(Single, Single)

Division (A / B)

Declaration
public static float Divide_FloatFloat(float A, float B)
Parameters
Type Name Description
System.Single A
System.Single B
Returns
Type Description
System.Single
| Improve this Doc View Source

Divide_IntInt(Int32, Int32)

Division (A / B)

Declaration
public static int Divide_IntInt(int A, int B)
Parameters
Type Name Description
System.Int32 A
System.Int32 B
Returns
Type Description
System.Int32
| Improve this Doc View Source

Divide_TimespanFloat(Timespan, Single)

Scalar division (A * s)

Declaration
public static Timespan Divide_TimespanFloat(Timespan A, float Scalar)
Parameters
Type Name Description
Timespan A
System.Single Scalar
Returns
Type Description
Timespan
| Improve this Doc View Source

Divide_Vector2DFloat(Vector2D, Single)

Returns Vector A divided by B

Declaration
public static Vector2D Divide_Vector2DFloat(Vector2D A, float B)
Parameters
Type Name Description
Vector2D A
System.Single B
Returns
Type Description
Vector2D
| Improve this Doc View Source

Divide_Vector2DVector2D(Vector2D, Vector2D)

Element-wise Vector divide (Result = {A.x/B.x, A.y/B.y})

Declaration
public static Vector2D Divide_Vector2DVector2D(Vector2D A, Vector2D B)
Parameters
Type Name Description
Vector2D A
Vector2D B
Returns
Type Description
Vector2D
| Improve this Doc View Source

Divide_VectorFloat(Vector, Single)

Vector divide by a float

Declaration
public static Vector Divide_VectorFloat(Vector A, float B)
Parameters
Type Name Description
Vector A
System.Single B
Returns
Type Description
Vector
| Improve this Doc View Source

Divide_VectorInt(Vector, Int32)

Vector divide by an integer

Declaration
public static Vector Divide_VectorInt(Vector A, int B)
Parameters
Type Name Description
Vector A
System.Int32 B
Returns
Type Description
Vector
| Improve this Doc View Source

Divide_VectorVector(Vector, Vector)

Element-wise Vector division (Result = {A.x/B.x, A.y/B.y, A.z/B.z})

Declaration
public static Vector Divide_VectorVector(Vector A, Vector B)
Parameters
Type Name Description
Vector A
Vector B
Returns
Type Description
Vector
| Improve this Doc View Source

Dot_VectorVector(Vector, Vector)

Returns the dot product of two 3d vectors

Declaration
public static float Dot_VectorVector(Vector A, Vector B)
Parameters
Type Name Description
Vector A
Vector B
Returns
Type Description
System.Single
| Improve this Doc View Source

DotProduct2D(Vector2D, Vector2D)

Returns the dot product of two 2d vectors

Declaration
public static float DotProduct2D(Vector2D A, Vector2D B)
Parameters
Type Name Description
Vector2D A
Vector2D B
Returns
Type Description
System.Single
| Improve this Doc View Source

Ease(Single, Single, Single, Byte, Single, Int32)

Easeing between A and B using a specified easing function

Declaration
public static float Ease(float A, float B, float Alpha, byte EasingFunc, float BlendExp, int Steps)
Parameters
Type Name Description
System.Single A
System.Single B
System.Single Alpha
System.Byte EasingFunc
System.Single BlendExp
System.Int32 Steps
Returns
Type Description
System.Single
| Improve this Doc View Source

EqualEqual_BoolBool(Boolean, Boolean)

Returns true if the values are equal (A == B)

Declaration
public static bool EqualEqual_BoolBool(bool A, bool B)
Parameters
Type Name Description
System.Boolean A
System.Boolean B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

EqualEqual_ByteByte(Byte, Byte)

Returns true if A is equal to B (A == B)

Declaration
public static bool EqualEqual_ByteByte(byte A, byte B)
Parameters
Type Name Description
System.Byte A
System.Byte B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

EqualEqual_ClassClass(SubclassOf<UObject>, SubclassOf<UObject>)

Returns true if A and B are equal (A == B)

Declaration
public static bool EqualEqual_ClassClass(SubclassOf<UObject> A, SubclassOf<UObject> B)
Parameters
Type Name Description
SubclassOf<UObject> A
SubclassOf<UObject> B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

EqualEqual_DateTimeDateTime(FDateTime, FDateTime)

Returns true if the values are equal (A == B)

Declaration
public static bool EqualEqual_DateTimeDateTime(FDateTime A, FDateTime B)
Parameters
Type Name Description
FDateTime A
FDateTime B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

EqualEqual_FloatFloat(Single, Single)

Returns true if A is exactly equal to B (A == B)

Declaration
public static bool EqualEqual_FloatFloat(float A, float B)
Parameters
Type Name Description
System.Single A
System.Single B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

EqualEqual_IntInt(Int32, Int32)

Returns true if A is equal to B (A == B)

Declaration
public static bool EqualEqual_IntInt(int A, int B)
Parameters
Type Name Description
System.Int32 A
System.Int32 B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

EqualEqual_NameName(Name, Name)

Returns true if A and B are equal (A == B)

Declaration
public static bool EqualEqual_NameName(Name A, Name B)
Parameters
Type Name Description
Name A
Name B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

EqualEqual_ObjectObject(UObject, UObject)

Returns true if A and B are equal (A == B)

Declaration
public static bool EqualEqual_ObjectObject(UObject A, UObject B)
Parameters
Type Name Description
UObject A
UObject B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

EqualEqual_RotatorRotator(Rotator, Rotator, Single)

Returns true if rotator A is equal to rotator B (A == B) within a specified error tolerance

Declaration
public static bool EqualEqual_RotatorRotator(Rotator A, Rotator B, float ErrorTolerance)
Parameters
Type Name Description
Rotator A
Rotator B
System.Single ErrorTolerance
Returns
Type Description
System.Boolean
| Improve this Doc View Source

EqualEqual_TimespanTimespan(Timespan, Timespan)

Returns true if the values are equal (A == B)

Declaration
public static bool EqualEqual_TimespanTimespan(Timespan A, Timespan B)
Parameters
Type Name Description
Timespan A
Timespan B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

EqualEqual_TransformTransform(Transform, Transform)

Returns true if transform A is equal to transform B

Declaration
public static bool EqualEqual_TransformTransform(Transform A, Transform B)
Parameters
Type Name Description
Transform A
Transform B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

EqualEqual_Vector2DVector2D(Vector2D, Vector2D, Single)

Returns true if vector2D A is equal to vector2D B (A == B) within a specified error tolerance

Declaration
public static bool EqualEqual_Vector2DVector2D(Vector2D A, Vector2D B, float ErrorTolerance)
Parameters
Type Name Description
Vector2D A
Vector2D B
System.Single ErrorTolerance
Returns
Type Description
System.Boolean
| Improve this Doc View Source

EqualEqual_VectorVector(Vector, Vector, Single)

Returns true if vector A is equal to vector B (A == B) within a specified error tolerance

Declaration
public static bool EqualEqual_VectorVector(Vector A, Vector B, float ErrorTolerance)
Parameters
Type Name Description
Vector A
Vector B
System.Single ErrorTolerance
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Exp(Single)

Returns exponential(e) to the power A (e^A)

Declaration
public static float Exp(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

FCeil(Single)

Rounds A to the smallest following integer

Declaration
public static int FCeil(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Int32
| Improve this Doc View Source

FClamp(Single, Single, Single)

Returns Value clamped between A and B (inclusive)

Declaration
public static float FClamp(float Value, float Min, float Max)
Parameters
Type Name Description
System.Single Value
System.Single Min
System.Single Max
Returns
Type Description
System.Single
| Improve this Doc View Source

FFloor(Single)

Rounds A to the largest previous integer

Declaration
public static int FFloor(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Int32
| Improve this Doc View Source

FindClosestPointOnLine(Vector, Vector, Vector)

Find the closest point on an infinite line to a given point.

Declaration
public static Vector FindClosestPointOnLine(Vector Point, Vector LineOrigin, Vector LineDirection)
Parameters
Type Name Description
Vector Point
Vector LineOrigin
Vector LineDirection
Returns
Type Description
Vector
Remarks

@param Point Point for which we find the closest point on the line. @param LineOrigin Point of reference on the line. @param LineDirection Direction of the line. Not required to be normalized. @return The closest point on the line to the given point.

| Improve this Doc View Source

FindClosestPointOnSegment(Vector, Vector, Vector)

Find the closest point on a segment to a given point.

Declaration
public static Vector FindClosestPointOnSegment(Vector Point, Vector SegmentStart, Vector SegmentEnd)
Parameters
Type Name Description
Vector Point
Vector SegmentStart
Vector SegmentEnd
Returns
Type Description
Vector
Remarks

@param Point Point for which we find the closest point on the segment. @param SegmentStart Start of the segment. @param SegmentEnd End of the segment. @return The closest point on the segment to the given point.

| Improve this Doc View Source

FindLookAtRotation(Vector, Vector)

Find a rotation for an object at Start location to point at Target location.

Declaration
public static Rotator FindLookAtRotation(Vector Start, Vector Target)
Parameters
Type Name Description
Vector Start
Vector Target
Returns
Type Description
Rotator
| Improve this Doc View Source

FindNearestPointsOnLineSegments(Vector, Vector, Vector, Vector)

Find closest points between 2 segments.

Declaration
public static (Vector, Vector) FindNearestPointsOnLineSegments(Vector Segment1Start, Vector Segment1End, Vector Segment2Start, Vector Segment2End)
Parameters
Type Name Description
Vector Segment1Start
Vector Segment1End
Vector Segment2Start
Vector Segment2End
Returns
Type Description
System.ValueTuple<Vector, Vector>
Remarks

@param Segment1Start Start of the 1st segment. @param Segment1End End of the 1st segment. @param Segment2Start Start of the 2nd segment. @param Segment2End End of the 2nd segment. @param Segment1Point Closest point on segment 1 to segment 2. @param Segment2Point Closest point on segment 2 to segment 1.

| Improve this Doc View Source

FInterpEaseInOut(Single, Single, Single, Single)

Interpolate between A and B, applying an ease in/out function. Exp controls the degree of the curve.

Declaration
public static float FInterpEaseInOut(float A, float B, float Alpha, float Exponent)
Parameters
Type Name Description
System.Single A
System.Single B
System.Single Alpha
System.Single Exponent
Returns
Type Description
System.Single
| Improve this Doc View Source

FInterpTo(Single, Single, Single, Single)

Tries to reach Target based on distance from Current position, giving a nice smooth feeling when tracking a position.

Declaration
public static float FInterpTo(float Current, float Target, float DeltaTime, float InterpSpeed)
Parameters
Type Name Description
System.Single Current
System.Single Target
System.Single DeltaTime
System.Single InterpSpeed
Returns
Type Description
System.Single
Remarks

@param Current Actual position @param Target Target position @param DeltaTime Time since last tick @param InterpSpeed Interpolation speed @return New interpolated position

| Improve this Doc View Source

FInterpTo_Constant(Single, Single, Single, Single)

Tries to reach Target at a constant rate.

Declaration
public static float FInterpTo_Constant(float Current, float Target, float DeltaTime, float InterpSpeed)
Parameters
Type Name Description
System.Single Current
System.Single Target
System.Single DeltaTime
System.Single InterpSpeed
Returns
Type Description
System.Single
Remarks

@param Current Actual position @param Target Target position @param DeltaTime Time since last tick @param InterpSpeed Interpolation speed @return New interpolated position

| Improve this Doc View Source

FixedTurn(Single, Single, Single)

Returns a new rotation component value @

Declaration
public static float FixedTurn(float InCurrent, float InDesired, float InDeltaRate)
Parameters
Type Name Description
System.Single InCurrent
System.Single InDesired
System.Single InDeltaRate
Returns
Type Description
System.Single
Remarks

param InCurrent is the current rotation value @param InDesired is the desired rotation value @param is the rotation amount to apply

@return a new rotation component value clamped in the range (-360,360)

| Improve this Doc View Source

FloatSpringInterp(Single, Single, FloatSpringState, Single, Single, Single, Single)

Uses a simple spring model to interpolate a float from Current to Target.

Declaration
public static float FloatSpringInterp(float Current, float Target, FloatSpringState SpringState, float Stiffness, float CriticalDampingFactor, float DeltaTime, float Mass)
Parameters
Type Name Description
System.Single Current
System.Single Target
FloatSpringState SpringState
System.Single Stiffness
System.Single CriticalDampingFactor
System.Single DeltaTime
System.Single Mass
Returns
Type Description
System.Single
Remarks

@param Current Current value @param Target Target value @param SpringState Data related to spring model (velocity, error, etc..) - Create a unique variable per spring @param Stiffness How stiff the spring model is (more stiffness means more oscillation around the target value) @param CriticalDampingFactor How much damping to apply to the spring (0 means no damping, 1 means critically damped which means no oscillation) @param Mass Multiplier that acts like mass on a spring

| Improve this Doc View Source

FMax(Single, Single)

Returns the maximum value of A and B

Declaration
public static float FMax(float A, float B)
Parameters
Type Name Description
System.Single A
System.Single B
Returns
Type Description
System.Single
| Improve this Doc View Source

FMin(Single, Single)

Returns the minimum value of A and B

Declaration
public static float FMin(float A, float B)
Parameters
Type Name Description
System.Single A
System.Single B
Returns
Type Description
System.Single
| Improve this Doc View Source

FMod(Single, Single)

Returns the number of times Divisor will go into Dividend (i.e., Dividend divided by Divisor), as well as the remainder

Declaration
public static (float, int) FMod(float Dividend, float Divisor)
Parameters
Type Name Description
System.Single Dividend
System.Single Divisor
Returns
Type Description
System.ValueTuple<System.Single, System.Int32>
| Improve this Doc View Source

Fraction(Single)

Returns the fractional part of a float.

Declaration
public static float Fraction(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

FromDays(Single)

Returns a time span that represents the specified number of days

Declaration
public static Timespan FromDays(float Days)
Parameters
Type Name Description
System.Single Days
Returns
Type Description
Timespan
| Improve this Doc View Source

FromHours(Single)

Returns a time span that represents the specified number of hours

Declaration
public static Timespan FromHours(float Hours)
Parameters
Type Name Description
System.Single Hours
Returns
Type Description
Timespan
| Improve this Doc View Source

FromMilliseconds(Single)

Returns a time span that represents the specified number of milliseconds

Declaration
public static Timespan FromMilliseconds(float Milliseconds)
Parameters
Type Name Description
System.Single Milliseconds
Returns
Type Description
Timespan
| Improve this Doc View Source

FromMinutes(Single)

Returns a time span that represents the specified number of minutes

Declaration
public static Timespan FromMinutes(float Minutes)
Parameters
Type Name Description
System.Single Minutes
Returns
Type Description
Timespan
| Improve this Doc View Source

FromSeconds(Single)

Returns a time span that represents the specified number of seconds

Declaration
public static Timespan FromSeconds(float Seconds)
Parameters
Type Name Description
System.Single Seconds
Returns
Type Description
Timespan
| Improve this Doc View Source

FTrunc(Single)

Rounds A to an integer with truncation towards zero. (e.g. -1.7 truncated to -1, 2.8 truncated to 2)

Declaration
public static int FTrunc(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Int32
| Improve this Doc View Source

FTruncVector(Vector)

Rounds A to an integer with truncation towards zero for each element in a vector. (e.g. -1.7 truncated to -1, 2.8 truncated to 2)

Declaration
public static IntVector FTruncVector(Vector InVector)
Parameters
Type Name Description
Vector InVector
Returns
Type Description
IntVector
| Improve this Doc View Source

GetAxes(Rotator)

Get the reference frame direction vectors (axes) described by this rotation

Declaration
public static (Vector, Vector, Vector) GetAxes(Rotator A)
Parameters
Type Name Description
Rotator A
Returns
Type Description
System.ValueTuple<Vector, Vector, Vector>
| Improve this Doc View Source

GetAzimuthAndElevation(Vector, Transform)

Breaks a direction vector apart into Azimuth (Yaw) and Elevation (Pitch) rotation values given in degrees.

Declaration
public static (float, float) GetAzimuthAndElevation(Vector InDirection, Transform ReferenceFrame)
Parameters
Type Name Description
Vector InDirection
Transform ReferenceFrame
Returns
Type Description
System.ValueTuple<System.Single, System.Single>
Remarks

(non-clamped) Relative to the provided reference frame (an Actor's WorldTransform for example)

| Improve this Doc View Source

GetDate(FDateTime)

Returns the date component of A

Declaration
public static FDateTime GetDate(FDateTime A)
Parameters
Type Name Description
FDateTime A
Returns
Type Description
FDateTime
| Improve this Doc View Source

GetDay(FDateTime)

Returns the day component of A (1 to 31)

Declaration
public static int GetDay(FDateTime A)
Parameters
Type Name Description
FDateTime A
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetDayOfYear(FDateTime)

Returns the day of year of A

Declaration
public static int GetDayOfYear(FDateTime A)
Parameters
Type Name Description
FDateTime A
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetDays(Timespan)

Returns the days component of A

Declaration
public static int GetDays(Timespan A)
Parameters
Type Name Description
Timespan A
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetDirectionUnitVector(Vector, Vector)

Find the unit direction vector from one position to another.

Declaration
public static Vector GetDirectionUnitVector(Vector From, Vector To)
Parameters
Type Name Description
Vector From
Vector To
Returns
Type Description
Vector
| Improve this Doc View Source

GetDuration(Timespan)

Returns the absolute value of A

Declaration
public static Timespan GetDuration(Timespan A)
Parameters
Type Name Description
Timespan A
Returns
Type Description
Timespan
| Improve this Doc View Source

GetForwardVector(Rotator)

Rotate the world forward vector by the given rotation

Declaration
public static Vector GetForwardVector(Rotator InRot)
Parameters
Type Name Description
Rotator InRot
Returns
Type Description
Vector
| Improve this Doc View Source

GetHour(FDateTime)

Returns the hour component of A (24h format)

Declaration
public static int GetHour(FDateTime A)
Parameters
Type Name Description
FDateTime A
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetHour12(FDateTime)

Returns the hour component of A (12h format)

Declaration
public static int GetHour12(FDateTime A)
Parameters
Type Name Description
FDateTime A
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetHours(Timespan)

Returns the hours component of A

Declaration
public static int GetHours(Timespan A)
Parameters
Type Name Description
Timespan A
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetMaxElement(Vector)

Find the maximum element (X, Y or Z) of a vector

Declaration
public static float GetMaxElement(Vector A)
Parameters
Type Name Description
Vector A
Returns
Type Description
System.Single
| Improve this Doc View Source

GetMillisecond(FDateTime)

Returns the millisecond component of A

Declaration
public static int GetMillisecond(FDateTime A)
Parameters
Type Name Description
FDateTime A
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetMilliseconds(Timespan)

Returns the milliseconds component of A

Declaration
public static int GetMilliseconds(Timespan A)
Parameters
Type Name Description
Timespan A
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetMinElement(Vector)

Find the minimum element (X, Y or Z) of a vector

Declaration
public static float GetMinElement(Vector A)
Parameters
Type Name Description
Vector A
Returns
Type Description
System.Single
| Improve this Doc View Source

GetMinute(FDateTime)

Returns the minute component of A

Declaration
public static int GetMinute(FDateTime A)
Parameters
Type Name Description
FDateTime A
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetMinutes(Timespan)

Returns the minutes component of A

Declaration
public static int GetMinutes(Timespan A)
Parameters
Type Name Description
Timespan A
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetMonth(FDateTime)

Returns the month component of A

Declaration
public static int GetMonth(FDateTime A)
Parameters
Type Name Description
FDateTime A
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetPI()

Returns the value of PI

Declaration
public static float GetPI()
Returns
Type Description
System.Single
| Improve this Doc View Source

GetPointDistanceToLine(Vector, Vector, Vector)

Find the distance from a point to the closest point on an infinite line.

Declaration
public static float GetPointDistanceToLine(Vector Point, Vector LineOrigin, Vector LineDirection)
Parameters
Type Name Description
Vector Point
Vector LineOrigin
Vector LineDirection
Returns
Type Description
System.Single
Remarks

@param Point Point for which we find the distance to the closest point on the line. @param LineOrigin Point of reference on the line. @param LineDirection Direction of the line. Not required to be normalized. @return The distance from the given point to the closest point on the line.

| Improve this Doc View Source

GetPointDistanceToSegment(Vector, Vector, Vector)

Find the distance from a point to the closest point on a segment.

Declaration
public static float GetPointDistanceToSegment(Vector Point, Vector SegmentStart, Vector SegmentEnd)
Parameters
Type Name Description
Vector Point
Vector SegmentStart
Vector SegmentEnd
Returns
Type Description
System.Single
Remarks

@param Point Point for which we find the distance to the closest point on the segment. @param SegmentStart Start of the segment. @param SegmentEnd End of the segment. @return The distance from the given point to the closest point on the segment.

| Improve this Doc View Source

GetReflectionVector(Vector, Vector)

Given a direction vector and a surface normal, returns the vector reflected across the surface normal.

Declaration
public static Vector GetReflectionVector(Vector Direction, Vector SurfaceNormal)
Parameters
Type Name Description
Vector Direction
Vector SurfaceNormal
Returns
Type Description
Vector
Remarks

Produces a result like shining a laser at a mirror!

@param Direction Direction vector the ray is coming from. @param SurfaceNormal A normal of the surface the ray should be reflected on.

@returns Reflected vector.

| Improve this Doc View Source

GetRightVector(Rotator)

Rotate the world right vector by the given rotation

Declaration
public static Vector GetRightVector(Rotator InRot)
Parameters
Type Name Description
Rotator InRot
Returns
Type Description
Vector
| Improve this Doc View Source

GetSecond(FDateTime)

Returns the second component of A

Declaration
public static int GetSecond(FDateTime A)
Parameters
Type Name Description
FDateTime A
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetSeconds(Timespan)

Returns the seconds component of A

Declaration
public static int GetSeconds(Timespan A)
Parameters
Type Name Description
Timespan A
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetSlopeDegreeAngles(Vector, Vector, Vector)

Returns Slope Pitch and Roll angles in degrees based on the following information: @

Declaration
public static (float, float) GetSlopeDegreeAngles(Vector MyRightYAxis, Vector FloorNormal, Vector UpVector)
Parameters
Type Name Description
Vector MyRightYAxis
Vector FloorNormal
Vector UpVector
Returns
Type Description
System.ValueTuple<System.Single, System.Single>
Remarks

param MyRightYAxis Right (Y) direction unit vector of Actor standing on Slope. @param FloorNormal Floor Normal (unit) vector. @param UpVector UpVector of reference frame. @outparam OutSlopePitchDegreeAngle Slope Pitch angle (degrees) @outparam OutSlopeRollDegreeAngle Slope Roll angle (degrees)

| Improve this Doc View Source

GetTAU()

Returns the value of TAU (= 2 * PI)

Declaration
public static float GetTAU()
Returns
Type Description
System.Single
| Improve this Doc View Source

GetTimeOfDay(FDateTime)

Returns the time elapsed since midnight of A

Declaration
public static Timespan GetTimeOfDay(FDateTime A)
Parameters
Type Name Description
FDateTime A
Returns
Type Description
Timespan
| Improve this Doc View Source

GetTotalDays(Timespan)

Returns the total number of days in A

Declaration
public static float GetTotalDays(Timespan A)
Parameters
Type Name Description
Timespan A
Returns
Type Description
System.Single
| Improve this Doc View Source

GetTotalHours(Timespan)

Returns the total number of hours in A

Declaration
public static float GetTotalHours(Timespan A)
Parameters
Type Name Description
Timespan A
Returns
Type Description
System.Single
| Improve this Doc View Source

GetTotalMilliseconds(Timespan)

Returns the total number of milliseconds in A

Declaration
public static float GetTotalMilliseconds(Timespan A)
Parameters
Type Name Description
Timespan A
Returns
Type Description
System.Single
| Improve this Doc View Source

GetTotalMinutes(Timespan)

Returns the total number of minutes in A

Declaration
public static float GetTotalMinutes(Timespan A)
Parameters
Type Name Description
Timespan A
Returns
Type Description
System.Single
| Improve this Doc View Source

GetTotalSeconds(Timespan)

Returns the total number of seconds in A

Declaration
public static float GetTotalSeconds(Timespan A)
Parameters
Type Name Description
Timespan A
Returns
Type Description
System.Single
| Improve this Doc View Source

GetUpVector(Rotator)

Rotate the world up vector by the given rotation

Declaration
public static Vector GetUpVector(Rotator InRot)
Parameters
Type Name Description
Rotator InRot
Returns
Type Description
Vector
| Improve this Doc View Source

GetVectorArrayAverage(Byte)

Find the average of an array of vectors

Declaration
public static Vector GetVectorArrayAverage(byte Vectors)
Parameters
Type Name Description
System.Byte Vectors
Returns
Type Description
Vector
| Improve this Doc View Source

GetYawPitchFromVector(Vector)

Breaks a vector apart into Yaw, Pitch rotation values given in degrees. (non-clamped)

Declaration
public static (float, float) GetYawPitchFromVector(Vector InVec)
Parameters
Type Name Description
Vector InVec
Returns
Type Description
System.ValueTuple<System.Single, System.Single>
| Improve this Doc View Source

GetYear(FDateTime)

Returns the year component of A

Declaration
public static int GetYear(FDateTime A)
Parameters
Type Name Description
FDateTime A
Returns
Type Description
System.Int32
| Improve this Doc View Source

Greater_ByteByte(Byte, Byte)

Returns true if A is greater than B (A > B)

Declaration
public static bool Greater_ByteByte(byte A, byte B)
Parameters
Type Name Description
System.Byte A
System.Byte B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Greater_DateTimeDateTime(FDateTime, FDateTime)

Returns true if A is greater than B (A > B)

Declaration
public static bool Greater_DateTimeDateTime(FDateTime A, FDateTime B)
Parameters
Type Name Description
FDateTime A
FDateTime B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Greater_FloatFloat(Single, Single)

Returns true if A is greater than B (A > B)

Declaration
public static bool Greater_FloatFloat(float A, float B)
Parameters
Type Name Description
System.Single A
System.Single B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Greater_IntInt(Int32, Int32)

Returns true if A is greater than B (A > B)

Declaration
public static bool Greater_IntInt(int A, int B)
Parameters
Type Name Description
System.Int32 A
System.Int32 B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Greater_TimespanTimespan(Timespan, Timespan)

Returns true if A is greater than B (A > B)

Declaration
public static bool Greater_TimespanTimespan(Timespan A, Timespan B)
Parameters
Type Name Description
Timespan A
Timespan B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GreaterEqual_ByteByte(Byte, Byte)

Returns true if A is greater than or equal to B (A >= B)

Declaration
public static bool GreaterEqual_ByteByte(byte A, byte B)
Parameters
Type Name Description
System.Byte A
System.Byte B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GreaterEqual_DateTimeDateTime(FDateTime, FDateTime)

Returns true if A is greater than or equal to B (A >= B)

Declaration
public static bool GreaterEqual_DateTimeDateTime(FDateTime A, FDateTime B)
Parameters
Type Name Description
FDateTime A
FDateTime B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GreaterEqual_FloatFloat(Single, Single)

Returns true if A is greater than or equal to B (A >= B)

Declaration
public static bool GreaterEqual_FloatFloat(float A, float B)
Parameters
Type Name Description
System.Single A
System.Single B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GreaterEqual_IntInt(Int32, Int32)

Returns true if A is greater than or equal to B (A >= B)

Declaration
public static bool GreaterEqual_IntInt(int A, int B)
Parameters
Type Name Description
System.Int32 A
System.Int32 B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GreaterEqual_TimespanTimespan(Timespan, Timespan)

Returns true if A is greater than or equal to B (A >= B)

Declaration
public static bool GreaterEqual_TimespanTimespan(Timespan A, Timespan B)
Parameters
Type Name Description
Timespan A
Timespan B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GreaterGreater_VectorRotator(Vector, Rotator)

Returns result of vector A rotated by Rotator B

Declaration
public static Vector GreaterGreater_VectorRotator(Vector A, Rotator B)
Parameters
Type Name Description
Vector A
Rotator B
Returns
Type Description
Vector
| Improve this Doc View Source

GridSnap_Float(Single, Single)

Snaps a value to the nearest grid multiple.

Declaration
public static float GridSnap_Float(float Location, float GridSize)
Parameters
Type Name Description
System.Single Location
System.Single GridSize
Returns
Type Description
System.Single
Remarks

E.g., Location = 5.1, GridSize = 10.0 : return value = 10.0 If GridSize is 0 Location is returned if GridSize is very small precision issues may occur.

| Improve this Doc View Source

HSVToRGB(Single, Single, Single, Single)

Make a color from individual color components (HSV space; Hue is [0..360) while Saturation and Value are 0..1)

Declaration
public static LinearColor HSVToRGB(float H, float S, float V, float A)
Parameters
Type Name Description
System.Single H
System.Single S
System.Single V
System.Single A
Returns
Type Description
LinearColor
| Improve this Doc View Source

HSVToRGB_Vector(LinearColor)

Converts a HSV linear color (where H is in R (0..360), S is in G (0..1), and V is in B (0..1)) to RGB

Declaration
public static LinearColor HSVToRGB_Vector(LinearColor HSV)
Parameters
Type Name Description
LinearColor HSV
Returns
Type Description
LinearColor
| Improve this Doc View Source

Hypotenuse(Single, Single)

Returns the hypotenuse of a right-angled triangle given the width and height.

Declaration
public static float Hypotenuse(float Width, float Height)
Parameters
Type Name Description
System.Single Width
System.Single Height
Returns
Type Description
System.Single
| Improve this Doc View Source

InRange_FloatFloat(Single, Single, Single, Boolean, Boolean)

Declaration
public static bool InRange_FloatFloat(float Value, float Min, float Max, bool InclusiveMin, bool InclusiveMax)
Parameters
Type Name Description
System.Single Value
System.Single Min
System.Single Max
System.Boolean InclusiveMin
System.Boolean InclusiveMax
Returns
Type Description
System.Boolean
| Improve this Doc View Source

InRange_IntInt(Int32, Int32, Int32, Boolean, Boolean)

Declaration
public static bool InRange_IntInt(int Value, int Min, int Max, bool InclusiveMin, bool InclusiveMax)
Parameters
Type Name Description
System.Int32 Value
System.Int32 Min
System.Int32 Max
System.Boolean InclusiveMin
System.Boolean InclusiveMax
Returns
Type Description
System.Boolean
| Improve this Doc View Source

InverseTransformDirection(Transform, Vector)

Transform a direction vector by the inverse of the supplied transform - will not change its length.

Declaration
public static Vector InverseTransformDirection(Transform T, Vector Direction)
Parameters
Type Name Description
Transform T
Vector Direction
Returns
Type Description
Vector
Remarks

For example, if T was an object's transform, this would transform a direction from world space to local space.

| Improve this Doc View Source

InverseTransformLocation(Transform, Vector)

Transform a position by the inverse of the supplied transform.

Declaration
public static Vector InverseTransformLocation(Transform T, Vector Location)
Parameters
Type Name Description
Transform T
Vector Location
Returns
Type Description
Vector
Remarks

For example, if T was an object's transform, this would transform a position from world space to local space.

| Improve this Doc View Source

InverseTransformRotation(Transform, Rotator)

Transform a rotator by the inverse of the supplied transform.

Declaration
public static Rotator InverseTransformRotation(Transform T, Rotator Rotation)
Parameters
Type Name Description
Transform T
Rotator Rotation
Returns
Type Description
Rotator
Remarks

For example, if T was an object's transform, this would transform a rotation from world space to local space.

| Improve this Doc View Source

InvertTransform(Transform)

Returns the inverse of the given transform T.

Declaration
public static Transform InvertTransform(Transform T)
Parameters
Type Name Description
Transform T
Returns
Type Description
Transform
Remarks

Example: Given a LocalToWorld transform, WorldToLocal will be returned.

@param T The transform you wish to invert @return The inverse of T.

| Improve this Doc View Source

IsAfternoon(FDateTime)

Returns whether A's time is in the afternoon

Declaration
public static bool IsAfternoon(FDateTime A)
Parameters
Type Name Description
FDateTime A
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsLeapYear(Int32)

Returns whether given year is a leap year

Declaration
public static bool IsLeapYear(int Year)
Parameters
Type Name Description
System.Int32 Year
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsMorning(FDateTime)

Returns whether A's time is in the morning

Declaration
public static bool IsMorning(FDateTime A)
Parameters
Type Name Description
FDateTime A
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsPointInBox(Vector, Vector, Vector)

Determines whether the given point is in a box.

Declaration
public static bool IsPointInBox(Vector Point, Vector BoxOrigin, Vector BoxExtent)
Parameters
Type Name Description
Vector Point
Vector BoxOrigin
Vector BoxExtent
Returns
Type Description
System.Boolean
Remarks

Includes points on the box.

@param Point Point to test @param BoxOrigin Origin of the box @param BoxExtent Extents of the box (distance in each axis from origin) @return Whether the point is in the box.

| Improve this Doc View Source

IsPointInBoxWithTransform(Vector, Transform, Vector)

Determines whether a given point is in a box with a given transform.

Declaration
public static bool IsPointInBoxWithTransform(Vector Point, Transform BoxWorldTransform, Vector BoxExtent)
Parameters
Type Name Description
Vector Point
Transform BoxWorldTransform
Vector BoxExtent
Returns
Type Description
System.Boolean
Remarks

Includes points on the box.

@param Point Point to test @param BoxWorldTransform Component-to-World transform of the box. @param BoxExtent Extents of the box (distance in each axis from origin), in component space. @return Whether the point is in the box.

| Improve this Doc View Source

Lerp(Single, Single, Single)

Linearly interpolates between A and B based on Alpha (100% of A when Alpha=0 and 100% of B when Alpha=1)

Declaration
public static float Lerp(float A, float B, float Alpha)
Parameters
Type Name Description
System.Single A
System.Single B
System.Single Alpha
Returns
Type Description
System.Single
| Improve this Doc View Source

Less_ByteByte(Byte, Byte)

Declaration
public static bool Less_ByteByte(byte A, byte B)
Parameters
Type Name Description
System.Byte A
System.Byte B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Less_DateTimeDateTime(FDateTime, FDateTime)

Declaration
public static bool Less_DateTimeDateTime(FDateTime A, FDateTime B)
Parameters
Type Name Description
FDateTime A
FDateTime B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Less_FloatFloat(Single, Single)

Declaration
public static bool Less_FloatFloat(float A, float B)
Parameters
Type Name Description
System.Single A
System.Single B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Less_IntInt(Int32, Int32)

Declaration
public static bool Less_IntInt(int A, int B)
Parameters
Type Name Description
System.Int32 A
System.Int32 B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Less_TimespanTimespan(Timespan, Timespan)

Declaration
public static bool Less_TimespanTimespan(Timespan A, Timespan B)
Parameters
Type Name Description
Timespan A
Timespan B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

LessEqual_ByteByte(Byte, Byte)

Declaration
public static bool LessEqual_ByteByte(byte A, byte B)
Parameters
Type Name Description
System.Byte A
System.Byte B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

LessEqual_DateTimeDateTime(FDateTime, FDateTime)

Declaration
public static bool LessEqual_DateTimeDateTime(FDateTime A, FDateTime B)
Parameters
Type Name Description
FDateTime A
FDateTime B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

LessEqual_FloatFloat(Single, Single)

Declaration
public static bool LessEqual_FloatFloat(float A, float B)
Parameters
Type Name Description
System.Single A
System.Single B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

LessEqual_IntInt(Int32, Int32)

Declaration
public static bool LessEqual_IntInt(int A, int B)
Parameters
Type Name Description
System.Int32 A
System.Int32 B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

LessEqual_TimespanTimespan(Timespan, Timespan)

Declaration
public static bool LessEqual_TimespanTimespan(Timespan A, Timespan B)
Parameters
Type Name Description
Timespan A
Timespan B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

LessLess_VectorRotator(Vector, Rotator)

Returns result of vector A rotated by the inverse of Rotator B

Declaration
public static Vector LessLess_VectorRotator(Vector A, Rotator B)
Parameters
Type Name Description
Vector A
Rotator B
Returns
Type Description
Vector
| Improve this Doc View Source

LinearColorLerp(LinearColor, LinearColor, Single)

Linearly interpolates between A and B based on Alpha (100% of A when Alpha=0 and 100% of B when Alpha=1)

Declaration
public static LinearColor LinearColorLerp(LinearColor A, LinearColor B, float Alpha)
Parameters
Type Name Description
LinearColor A
LinearColor B
System.Single Alpha
Returns
Type Description
LinearColor
| Improve this Doc View Source

LinearColorLerpUsingHSV(LinearColor, LinearColor, Single)

Linearly interpolates between two colors by the specified Alpha amount (100% of A when Alpha=0 and 100% of B when Alpha=1).

Declaration
public static LinearColor LinearColorLerpUsingHSV(LinearColor A, LinearColor B, float Alpha)
Parameters
Type Name Description
LinearColor A
LinearColor B
System.Single Alpha
Returns
Type Description
LinearColor
Remarks

The interpolation is performed in HSV color space taking the shortest path to the new color's hue. This can give better results than a normal lerp, but is much more expensive. The incoming colors are in RGB space, and the output color will be RGB. The alpha value will also be interpolated.

@param A The color and alpha to interpolate from as linear RGBA @param B The color and alpha to interpolate to as linear RGBA @param Alpha Scalar interpolation amount (usually between 0.0 and 1.0 inclusive)

@return The interpolated color in linear RGB space along with the interpolated alpha value

| Improve this Doc View Source

LinePlaneIntersection(Vector, Vector, Plane)

Computes the intersection point between a line and a plane.

Declaration
public static (float, Vector, bool) LinePlaneIntersection(Vector LineStart, Vector LineEnd, Plane APlane)
Parameters
Type Name Description
Vector LineStart
Vector LineEnd
Plane APlane
Returns
Type Description
System.ValueTuple<System.Single, Vector, System.Boolean>
Remarks

@param T - The t of the intersection between the line and the plane @param Intersection - The point of intersection between the line and the plane @return True if the intersection test was successful.

| Improve this Doc View Source

LinePlaneIntersection_OriginNormal(Vector, Vector, Vector, Vector)

Computes the intersection point between a line and a plane.

Declaration
public static (float, Vector, bool) LinePlaneIntersection_OriginNormal(Vector LineStart, Vector LineEnd, Vector PlaneOrigin, Vector PlaneNormal)
Parameters
Type Name Description
Vector LineStart
Vector LineEnd
Vector PlaneOrigin
Vector PlaneNormal
Returns
Type Description
System.ValueTuple<System.Single, Vector, System.Boolean>
Remarks

@param T - The t of the intersection between the line and the plane @param Intersection - The point of intersection between the line and the plane @return True if the intersection test was successful.

| Improve this Doc View Source

Log(Single, Single)

Returns log of A base B (if B^R == A, returns R)

Declaration
public static float Log(float A, float Base)
Parameters
Type Name Description
System.Single A
System.Single Base
Returns
Type Description
System.Single
| Improve this Doc View Source

Loge(Single)

Returns natural log of A (if e^R == A, returns R)

Declaration
public static float Loge(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

MakeBox(Vector, Vector)

Makes an FBox from Min and Max and sets IsValid to true

Declaration
public static Box MakeBox(Vector Min, Vector Max)
Parameters
Type Name Description
Vector Min
Vector Max
Returns
Type Description
Box
| Improve this Doc View Source

MakeBox2D(Vector2D, Vector2D)

Makes an FBox2D from Min and Max and sets IsValid to true

Declaration
public static Box2D MakeBox2D(Vector2D Min, Vector2D Max)
Parameters
Type Name Description
Vector2D Min
Vector2D Max
Returns
Type Description
Box2D
| Improve this Doc View Source

MakeColor(Single, Single, Single, Single)

Make a color from individual color components (RGB space)

Declaration
public static LinearColor MakeColor(float R, float G, float B, float A)
Parameters
Type Name Description
System.Single R
System.Single G
System.Single B
System.Single A
Returns
Type Description
LinearColor
| Improve this Doc View Source

MakeDateTime(Int32, Int32, Int32, Int32, Int32, Int32, Int32)

Makes a DateTime struct

Declaration
public static FDateTime MakeDateTime(int Year, int Month, int Day, int Hour, int Minute, int Second, int Millisecond)
Parameters
Type Name Description
System.Int32 Year
System.Int32 Month
System.Int32 Day
System.Int32 Hour
System.Int32 Minute
System.Int32 Second
System.Int32 Millisecond
Returns
Type Description
FDateTime
| Improve this Doc View Source

MakeFrameRate(Int32, Int32)

Creates a FFrameRate from a Numerator and a Denominator. Enforces that the Denominator is at least one.

Declaration
public static FrameRate MakeFrameRate(int Numerator, int Denominator)
Parameters
Type Name Description
System.Int32 Numerator
System.Int32 Denominator
Returns
Type Description
FrameRate
| Improve this Doc View Source

MakePlaneFromPointAndNormal(Vector, Vector)

Creates a plane with a facing direction of Normal at the given Point @

Declaration
public static Plane MakePlaneFromPointAndNormal(Vector Point, Vector Normal)
Parameters
Type Name Description
Vector Point
Vector Normal
Returns
Type Description
Plane
Remarks

param Point A point on the plane @param Normal The Normal of the plane at Point @return Plane instance

| Improve this Doc View Source

MakePulsatingValue(Single, Single, Single)

Simple function to create a pulsating scalar value @

Declaration
public static float MakePulsatingValue(float InCurrentTime, float InPulsesPerSecond, float InPhase)
Parameters
Type Name Description
System.Single InCurrentTime
System.Single InPulsesPerSecond
System.Single InPhase
Returns
Type Description
System.Single
Remarks

param InCurrentTime Current absolute time @param InPulsesPerSecond How many full pulses per second? @param InPhase Optional phase amount, between 0.0 and 1.0 (to synchronize pulses)

@return Pulsating value (0.0-1.0)

| Improve this Doc View Source

MakeQualifiedFrameTime(FrameNumber, FrameRate, Single)

Creates a FQualifiedFrameTime out of a frame number, frame rate, and optional 0-1 clamped subframe.

Declaration
public static QualifiedFrameTime MakeQualifiedFrameTime(FrameNumber Frame, FrameRate FrameRate, float SubFrame)
Parameters
Type Name Description
FrameNumber Frame
FrameRate FrameRate
System.Single SubFrame
Returns
Type Description
QualifiedFrameTime
| Improve this Doc View Source

MakeRandomStream(Int32)

Makes a SRand-based random number generator

Declaration
public static RandomStream MakeRandomStream(int InitialSeed)
Parameters
Type Name Description
System.Int32 InitialSeed
Returns
Type Description
RandomStream
| Improve this Doc View Source

MakeRotationFromAxes(Vector, Vector, Vector)

Build a reference frame from three axes

Declaration
public static Rotator MakeRotationFromAxes(Vector Forward, Vector Right, Vector Up)
Parameters
Type Name Description
Vector Forward
Vector Right
Vector Up
Returns
Type Description
Rotator
| Improve this Doc View Source

MakeRotator(Single, Single, Single)

Makes a rotator {Roll, Pitch, Yaw} from rotation values supplied in degrees

Declaration
public static Rotator MakeRotator(float Roll, float Pitch, float Yaw)
Parameters
Type Name Description
System.Single Roll
System.Single Pitch
System.Single Yaw
Returns
Type Description
Rotator
| Improve this Doc View Source

MakeRotFromX(Vector)

Builds a rotator given only a XAxis. Y and Z are unspecified but will be orthonormal. XAxis need not be normalized.

Declaration
public static Rotator MakeRotFromX(Vector X)
Parameters
Type Name Description
Vector X
Returns
Type Description
Rotator
| Improve this Doc View Source

MakeRotFromXY(Vector, Vector)

Builds a matrix with given X and Y axes. X will remain fixed, Y may be changed minimally to enforce orthogonality. Z will be computed. Inputs need not be normalized.

Declaration
public static Rotator MakeRotFromXY(Vector X, Vector Y)
Parameters
Type Name Description
Vector X
Vector Y
Returns
Type Description
Rotator
| Improve this Doc View Source

MakeRotFromXZ(Vector, Vector)

Builds a matrix with given X and Z axes. X will remain fixed, Z may be changed minimally to enforce orthogonality. Y will be computed. Inputs need not be normalized.

Declaration
public static Rotator MakeRotFromXZ(Vector X, Vector Z)
Parameters
Type Name Description
Vector X
Vector Z
Returns
Type Description
Rotator
| Improve this Doc View Source

MakeRotFromY(Vector)

Builds a rotation matrix given only a YAxis. X and Z are unspecified but will be orthonormal. YAxis need not be normalized.

Declaration
public static Rotator MakeRotFromY(Vector Y)
Parameters
Type Name Description
Vector Y
Returns
Type Description
Rotator
| Improve this Doc View Source

MakeRotFromYX(Vector, Vector)

Builds a matrix with given Y and X axes. Y will remain fixed, X may be changed minimally to enforce orthogonality. Z will be computed. Inputs need not be normalized.

Declaration
public static Rotator MakeRotFromYX(Vector Y, Vector X)
Parameters
Type Name Description
Vector Y
Vector X
Returns
Type Description
Rotator
| Improve this Doc View Source

MakeRotFromYZ(Vector, Vector)

Builds a matrix with given Y and Z axes. Y will remain fixed, Z may be changed minimally to enforce orthogonality. X will be computed. Inputs need not be normalized.

Declaration
public static Rotator MakeRotFromYZ(Vector Y, Vector Z)
Parameters
Type Name Description
Vector Y
Vector Z
Returns
Type Description
Rotator
| Improve this Doc View Source

MakeRotFromZ(Vector)

Builds a rotation matrix given only a ZAxis. X and Y are unspecified but will be orthonormal. ZAxis need not be normalized.

Declaration
public static Rotator MakeRotFromZ(Vector Z)
Parameters
Type Name Description
Vector Z
Returns
Type Description
Rotator
| Improve this Doc View Source

MakeRotFromZX(Vector, Vector)

Builds a matrix with given Z and X axes. Z will remain fixed, X may be changed minimally to enforce orthogonality. Y will be computed. Inputs need not be normalized.

Declaration
public static Rotator MakeRotFromZX(Vector Z, Vector X)
Parameters
Type Name Description
Vector Z
Vector X
Returns
Type Description
Rotator
| Improve this Doc View Source

MakeRotFromZY(Vector, Vector)

Builds a matrix with given Z and Y axes. Z will remain fixed, Y may be changed minimally to enforce orthogonality. X will be computed. Inputs need not be normalized.

Declaration
public static Rotator MakeRotFromZY(Vector Z, Vector Y)
Parameters
Type Name Description
Vector Z
Vector Y
Returns
Type Description
Rotator
| Improve this Doc View Source

MakeTimespan(Int32, Int32, Int32, Int32, Int32)

Makes a Timespan struct

Declaration
public static Timespan MakeTimespan(int Days, int Hours, int Minutes, int Seconds, int Milliseconds)
Parameters
Type Name Description
System.Int32 Days
System.Int32 Hours
System.Int32 Minutes
System.Int32 Seconds
System.Int32 Milliseconds
Returns
Type Description
Timespan
| Improve this Doc View Source

MakeTimespan2(Int32, Int32, Int32, Int32, Int32)

Makes a Timespan struct

Declaration
public static Timespan MakeTimespan2(int Days, int Hours, int Minutes, int Seconds, int FractionNano)
Parameters
Type Name Description
System.Int32 Days
System.Int32 Hours
System.Int32 Minutes
System.Int32 Seconds
System.Int32 FractionNano
Returns
Type Description
Timespan
| Improve this Doc View Source

MakeTransform(Vector, Rotator, Vector)

Make a transform from location, rotation and scale

Declaration
public static Transform MakeTransform(Vector Location, Rotator Rotation, Vector Scale)
Parameters
Type Name Description
Vector Location
Rotator Rotation
Vector Scale
Returns
Type Description
Transform
| Improve this Doc View Source

MakeVector(Single, Single, Single)

Makes a vector {X, Y, Z}

Declaration
public static Vector MakeVector(float X, float Y, float Z)
Parameters
Type Name Description
System.Single X
System.Single Y
System.Single Z
Returns
Type Description
Vector
| Improve this Doc View Source

MakeVector2D(Single, Single)

Makes a 2d vector {X, Y}

Declaration
public static Vector2D MakeVector2D(float X, float Y)
Parameters
Type Name Description
System.Single X
System.Single Y
Returns
Type Description
Vector2D
| Improve this Doc View Source

MapRangeClamped(Single, Single, Single, Single, Single)

Returns Value mapped from one range into another where the Value is clamped to the Input Range. (e.g. 0.5 normalized from the range 0->1 to 0->50 would result in 25)

Declaration
public static float MapRangeClamped(float Value, float InRangeA, float InRangeB, float OutRangeA, float OutRangeB)
Parameters
Type Name Description
System.Single Value
System.Single InRangeA
System.Single InRangeB
System.Single OutRangeA
System.Single OutRangeB
Returns
Type Description
System.Single
| Improve this Doc View Source

MapRangeUnclamped(Single, Single, Single, Single, Single)

Returns Value mapped from one range into another. (e.g. 20 normalized from the range 10->50 to 20->40 would result in 25)

Declaration
public static float MapRangeUnclamped(float Value, float InRangeA, float InRangeB, float OutRangeA, float OutRangeB)
Parameters
Type Name Description
System.Single Value
System.Single InRangeA
System.Single InRangeB
System.Single OutRangeA
System.Single OutRangeB
Returns
Type Description
System.Single
| Improve this Doc View Source

Matrix_GetOrigin(Matrix)

Get the origin of the co-ordinate system @

Declaration
public static Vector Matrix_GetOrigin(Matrix InMatrix)
Parameters
Type Name Description
Matrix InMatrix
Returns
Type Description
Vector
Remarks

return co-ordinate system origin

| Improve this Doc View Source

Max(Int32, Int32)

Returns the maximum value of A and B

Declaration
public static int Max(int A, int B)
Parameters
Type Name Description
System.Int32 A
System.Int32 B
Returns
Type Description
System.Int32
| Improve this Doc View Source

MaxOfByteArray(Byte)

Returns max of all array entries and the index at which it was found. Returns value of 0 and index of -1 if the supplied array is empty.

Declaration
public static (int, byte) MaxOfByteArray(byte ByteArray)
Parameters
Type Name Description
System.Byte ByteArray
Returns
Type Description
System.ValueTuple<System.Int32, System.Byte>
| Improve this Doc View Source

MaxOfFloatArray(Byte)

Returns max of all array entries and the index at which it was found. Returns value of 0 and index of -1 if the supplied array is empty.

Declaration
public static (int, float) MaxOfFloatArray(byte FloatArray)
Parameters
Type Name Description
System.Byte FloatArray
Returns
Type Description
System.ValueTuple<System.Int32, System.Single>
| Improve this Doc View Source

MaxOfIntArray(Byte)

Returns max of all array entries and the index at which it was found. Returns value of 0 and index of -1 if the supplied array is empty.

Declaration
public static (int, int) MaxOfIntArray(byte IntArray)
Parameters
Type Name Description
System.Byte IntArray
Returns
Type Description
System.ValueTuple<System.Int32, System.Int32>
| Improve this Doc View Source

Min(Int32, Int32)

Returns the minimum value of A and B

Declaration
public static int Min(int A, int B)
Parameters
Type Name Description
System.Int32 A
System.Int32 B
Returns
Type Description
System.Int32
| Improve this Doc View Source

MinimumAreaRectangle(UObject, Byte, Vector, Boolean)

Finds the minimum area rectangle that encloses all of the points in InVerts Uses algorithm found in http://www.

Declaration
public static (Vector, Rotator, float, float) MinimumAreaRectangle(UObject WorldContextObject, byte InVerts, Vector SampleSurfaceNormal, bool bDebugDraw)
Parameters
Type Name Description
UObject WorldContextObject
System.Byte InVerts
Vector SampleSurfaceNormal
System.Boolean bDebugDraw
Returns
Type Description
System.ValueTuple<Vector, Rotator, System.Single, System.Single>
Remarks

geometrictools.com/Documentation/MinimumAreaRectangle.pdf

@param InVerts - Points to enclose in the rectangle @outparam OutRectCenter - Center of the enclosing rectangle @outparam OutRectSideA - Vector oriented and sized to represent one edge of the enclosing rectangle, orthogonal to OutRectSideB @outparam OutRectSideB - Vector oriented and sized to represent one edge of the enclosing rectangle, orthogonal to OutRectSideA

| Improve this Doc View Source

MinOfByteArray(Byte)

Returns min of all array entries and the index at which it was found. Returns value of 0 and index of -1 if the supplied array is empty.

Declaration
public static (int, byte) MinOfByteArray(byte ByteArray)
Parameters
Type Name Description
System.Byte ByteArray
Returns
Type Description
System.ValueTuple<System.Int32, System.Byte>
| Improve this Doc View Source

MinOfFloatArray(Byte)

Returns min of all array entries and the index at which it was found. Returns value of 0 and index of -1 if the supplied array is empty.

Declaration
public static (int, float) MinOfFloatArray(byte FloatArray)
Parameters
Type Name Description
System.Byte FloatArray
Returns
Type Description
System.ValueTuple<System.Int32, System.Single>
| Improve this Doc View Source

MinOfIntArray(Byte)

Returns min of all array entries and the index at which it was found. Returns value of 0 and index of -1 if the supplied array is empty.

Declaration
public static (int, int) MinOfIntArray(byte IntArray)
Parameters
Type Name Description
System.Byte IntArray
Returns
Type Description
System.ValueTuple<System.Int32, System.Int32>
| Improve this Doc View Source

MirrorVectorByNormal(Vector, Vector)

Mirrors a vector by a normal

Declaration
public static Vector MirrorVectorByNormal(Vector InVect, Vector InNormal)
Parameters
Type Name Description
Vector InVect
Vector InNormal
Returns
Type Description
Vector
| Improve this Doc View Source

Multiply_ByteByte(Byte, Byte)

Multiplication (A * B)

Declaration
public static byte Multiply_ByteByte(byte A, byte B)
Parameters
Type Name Description
System.Byte A
System.Byte B
Returns
Type Description
System.Byte
| Improve this Doc View Source

Multiply_FloatFloat(Single, Single)

Multiplication (A * B)

Declaration
public static float Multiply_FloatFloat(float A, float B)
Parameters
Type Name Description
System.Single A
System.Single B
Returns
Type Description
System.Single
| Improve this Doc View Source

Multiply_IntFloat(Int32, Single)

Multiplication (A * B)

Declaration
public static float Multiply_IntFloat(int A, float B)
Parameters
Type Name Description
System.Int32 A
System.Single B
Returns
Type Description
System.Single
| Improve this Doc View Source

Multiply_IntInt(Int32, Int32)

Multiplication (A * B)

Declaration
public static int Multiply_IntInt(int A, int B)
Parameters
Type Name Description
System.Int32 A
System.Int32 B
Returns
Type Description
System.Int32
| Improve this Doc View Source

Multiply_LinearColorFloat(LinearColor, Single)

Element-wise multiplication of a linear color by a float (FR, FG, FB, FA)

Declaration
public static LinearColor Multiply_LinearColorFloat(LinearColor A, float B)
Parameters
Type Name Description
LinearColor A
System.Single B
Returns
Type Description
LinearColor
| Improve this Doc View Source

Multiply_LinearColorLinearColor(LinearColor, LinearColor)

Element-wise multiplication of two linear colors (RR, GG, BB, AA)

Declaration
public static LinearColor Multiply_LinearColorLinearColor(LinearColor A, LinearColor B)
Parameters
Type Name Description
LinearColor A
LinearColor B
Returns
Type Description
LinearColor
| Improve this Doc View Source

Multiply_RotatorFloat(Rotator, Single)

Returns rotator representing rotator A scaled by B

Declaration
public static Rotator Multiply_RotatorFloat(Rotator A, float B)
Parameters
Type Name Description
Rotator A
System.Single B
Returns
Type Description
Rotator
| Improve this Doc View Source

Multiply_RotatorInt(Rotator, Int32)

Returns rotator representing rotator A scaled by B

Declaration
public static Rotator Multiply_RotatorInt(Rotator A, int B)
Parameters
Type Name Description
Rotator A
System.Int32 B
Returns
Type Description
Rotator
| Improve this Doc View Source

Multiply_TimespanFloat(Timespan, Single)

Scalar multiplication (A * s)

Declaration
public static Timespan Multiply_TimespanFloat(Timespan A, float Scalar)
Parameters
Type Name Description
Timespan A
System.Single Scalar
Returns
Type Description
Timespan
| Improve this Doc View Source

Multiply_Vector2DFloat(Vector2D, Single)

Returns Vector A scaled by B

Declaration
public static Vector2D Multiply_Vector2DFloat(Vector2D A, float B)
Parameters
Type Name Description
Vector2D A
System.Single B
Returns
Type Description
Vector2D
| Improve this Doc View Source

Multiply_Vector2DVector2D(Vector2D, Vector2D)

Element-wise Vector multiplication (Result = {A.xB.x, A.yB.y})

Declaration
public static Vector2D Multiply_Vector2DVector2D(Vector2D A, Vector2D B)
Parameters
Type Name Description
Vector2D A
Vector2D B
Returns
Type Description
Vector2D
| Improve this Doc View Source

Multiply_VectorFloat(Vector, Single)

Scales Vector A by B

Declaration
public static Vector Multiply_VectorFloat(Vector A, float B)
Parameters
Type Name Description
Vector A
System.Single B
Returns
Type Description
Vector
| Improve this Doc View Source

Multiply_VectorInt(Vector, Int32)

Scales Vector A by B

Declaration
public static Vector Multiply_VectorInt(Vector A, int B)
Parameters
Type Name Description
Vector A
System.Int32 B
Returns
Type Description
Vector
| Improve this Doc View Source

Multiply_VectorVector(Vector, Vector)

Element-wise Vector multiplication (Result = {A.xB.x, A.yB.y, A.z*B.z})

Declaration
public static Vector Multiply_VectorVector(Vector A, Vector B)
Parameters
Type Name Description
Vector A
Vector B
Returns
Type Description
Vector
| Improve this Doc View Source

MultiplyByPi(Single)

Multiplies the input value by pi.

Declaration
public static float MultiplyByPi(float Value)
Parameters
Type Name Description
System.Single Value
Returns
Type Description
System.Single
| Improve this Doc View Source

MultiplyMultiply_FloatFloat(Single, Single)

Power (Base to the Exp-th power)

Declaration
public static float MultiplyMultiply_FloatFloat(float Base, float Exp)
Parameters
Type Name Description
System.Single Base
System.Single Exp
Returns
Type Description
System.Single
| Improve this Doc View Source

NearlyEqual_FloatFloat(Single, Single, Single)

Declaration
public static bool NearlyEqual_FloatFloat(float A, float B, float ErrorTolerance)
Parameters
Type Name Description
System.Single A
System.Single B
System.Single ErrorTolerance
Returns
Type Description
System.Boolean
| Improve this Doc View Source

NearlyEqual_TransformTransform(Transform, Transform, Single, Single, Single)

Returns true if transform A is nearly equal to B @

Declaration
public static bool NearlyEqual_TransformTransform(Transform A, Transform B, float LocationTolerance, float RotationTolerance, float Scale3DTolerance)
Parameters
Type Name Description
Transform A
Transform B
System.Single LocationTolerance
System.Single RotationTolerance
System.Single Scale3DTolerance
Returns
Type Description
System.Boolean
Remarks

param LocationTolerance How close position of transforms need to be to be considered equal @param RotationTolerance How close rotations of transforms need to be to be considered equal @param Scale3DTolerance How close scale of transforms need to be to be considered equal

| Improve this Doc View Source

NegateRotator(Rotator)

Negate a rotator

Declaration
public static Rotator NegateRotator(Rotator A)
Parameters
Type Name Description
Rotator A
Returns
Type Description
Rotator
| Improve this Doc View Source

NegateVector(Vector)

Negate a vector.

Declaration
public static Vector NegateVector(Vector A)
Parameters
Type Name Description
Vector A
Returns
Type Description
Vector
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static KismetMathLibrary New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
KismetMathLibrary
| Improve this Doc View Source

Normal(Vector)

Returns a unit normal version of the FVector A

Declaration
public static Vector Normal(Vector A)
Parameters
Type Name Description
Vector A
Returns
Type Description
Vector
| Improve this Doc View Source

Normal2D(Vector2D)

Returns a unit normal version of the vector2d A

Declaration
public static Vector2D Normal2D(Vector2D A)
Parameters
Type Name Description
Vector2D A
Returns
Type Description
Vector2D
| Improve this Doc View Source

NormalizeAxis(Single)

Clamps an angle to the range of [-180, 180].

Declaration
public static float NormalizeAxis(float Angle)
Parameters
Type Name Description
System.Single Angle
Returns
Type Description
System.Single
Remarks

@param Angle The Angle to clamp. @return The clamped angle.

| Improve this Doc View Source

NormalizedDeltaRotator(Rotator, Rotator)

Normalized A-B

Declaration
public static Rotator NormalizedDeltaRotator(Rotator A, Rotator B)
Parameters
Type Name Description
Rotator A
Rotator B
Returns
Type Description
Rotator
| Improve this Doc View Source

NormalizeToRange(Single, Single, Single)

Returns Value normalized to the given range. (e.g. 20 normalized to the range 10->50 would result in 0.25)

Declaration
public static float NormalizeToRange(float Value, float RangeMin, float RangeMax)
Parameters
Type Name Description
System.Single Value
System.Single RangeMin
System.Single RangeMax
Returns
Type Description
System.Single
| Improve this Doc View Source

Not_Int(Int32)

Bitwise NOT (~A)

Declaration
public static int Not_Int(int A)
Parameters
Type Name Description
System.Int32 A
Returns
Type Description
System.Int32
| Improve this Doc View Source

Not_PreBool(Boolean)

Returns the logical complement of the Boolean value (NOT A)

Declaration
public static bool Not_PreBool(bool A)
Parameters
Type Name Description
System.Boolean A
Returns
Type Description
System.Boolean
| Improve this Doc View Source

NotEqual_BoolBool(Boolean, Boolean)

Returns true if the values are not equal (A != B)

Declaration
public static bool NotEqual_BoolBool(bool A, bool B)
Parameters
Type Name Description
System.Boolean A
System.Boolean B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

NotEqual_ByteByte(Byte, Byte)

Returns true if A is not equal to B (A != B)

Declaration
public static bool NotEqual_ByteByte(byte A, byte B)
Parameters
Type Name Description
System.Byte A
System.Byte B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

NotEqual_ClassClass(SubclassOf<UObject>, SubclassOf<UObject>)

Returns true if A and B are not equal (A != B)

Declaration
public static bool NotEqual_ClassClass(SubclassOf<UObject> A, SubclassOf<UObject> B)
Parameters
Type Name Description
SubclassOf<UObject> A
SubclassOf<UObject> B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

NotEqual_DateTimeDateTime(FDateTime, FDateTime)

Returns true if the values are not equal (A != B)

Declaration
public static bool NotEqual_DateTimeDateTime(FDateTime A, FDateTime B)
Parameters
Type Name Description
FDateTime A
FDateTime B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

NotEqual_FloatFloat(Single, Single)

Returns true if A does not equal B (A != B)

Declaration
public static bool NotEqual_FloatFloat(float A, float B)
Parameters
Type Name Description
System.Single A
System.Single B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

NotEqual_IntInt(Int32, Int32)

Returns true if A is not equal to B (A != B)

Declaration
public static bool NotEqual_IntInt(int A, int B)
Parameters
Type Name Description
System.Int32 A
System.Int32 B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

NotEqual_NameName(Name, Name)

Returns true if A and B are not equal (A != B)

Declaration
public static bool NotEqual_NameName(Name A, Name B)
Parameters
Type Name Description
Name A
Name B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

NotEqual_ObjectObject(UObject, UObject)

Returns true if A and B are not equal (A != B)

Declaration
public static bool NotEqual_ObjectObject(UObject A, UObject B)
Parameters
Type Name Description
UObject A
UObject B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

NotEqual_RotatorRotator(Rotator, Rotator, Single)

Returns true if rotator A is not equal to rotator B (A != B) within a specified error tolerance

Declaration
public static bool NotEqual_RotatorRotator(Rotator A, Rotator B, float ErrorTolerance)
Parameters
Type Name Description
Rotator A
Rotator B
System.Single ErrorTolerance
Returns
Type Description
System.Boolean
| Improve this Doc View Source

NotEqual_TimespanTimespan(Timespan, Timespan)

Returns true if the values are not equal (A != B)

Declaration
public static bool NotEqual_TimespanTimespan(Timespan A, Timespan B)
Parameters
Type Name Description
Timespan A
Timespan B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

NotEqual_Vector2DVector2D(Vector2D, Vector2D, Single)

Returns true if vector2D A is not equal to vector2D B (A != B) within a specified error tolerance

Declaration
public static bool NotEqual_Vector2DVector2D(Vector2D A, Vector2D B, float ErrorTolerance)
Parameters
Type Name Description
Vector2D A
Vector2D B
System.Single ErrorTolerance
Returns
Type Description
System.Boolean
| Improve this Doc View Source

NotEqual_VectorVector(Vector, Vector, Single)

Returns true if vector A is not equal to vector B (A != B) within a specified error tolerance

Declaration
public static bool NotEqual_VectorVector(Vector A, Vector B, float ErrorTolerance)
Parameters
Type Name Description
Vector A
Vector B
System.Single ErrorTolerance
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Now()

Returns the local date and time on this computer

Declaration
public static FDateTime Now()
Returns
Type Description
FDateTime
| Improve this Doc View Source

Or_IntInt(Int32, Int32)

Bitwise OR (A | B)

Declaration
public static int Or_IntInt(int A, int B)
Parameters
Type Name Description
System.Int32 A
System.Int32 B
Returns
Type Description
System.Int32
| Improve this Doc View Source

Percent_ByteByte(Byte, Byte)

Modulo (A % B)

Declaration
public static byte Percent_ByteByte(byte A, byte B)
Parameters
Type Name Description
System.Byte A
System.Byte B
Returns
Type Description
System.Byte
| Improve this Doc View Source

Percent_FloatFloat(Single, Single)

Modulo (A % B)

Declaration
public static float Percent_FloatFloat(float A, float B)
Parameters
Type Name Description
System.Single A
System.Single B
Returns
Type Description
System.Single
| Improve this Doc View Source

Percent_IntInt(Int32, Int32)

Modulo (A % B)

Declaration
public static int Percent_IntInt(int A, int B)
Parameters
Type Name Description
System.Int32 A
System.Int32 B
Returns
Type Description
System.Int32
| Improve this Doc View Source

PerlinNoise1D(Single)

Generates a 1D Perlin noise from the given value.

Declaration
public static float PerlinNoise1D(float Value)
Parameters
Type Name Description
System.Single Value
Returns
Type Description
System.Single
Remarks

Returns a continuous random value between -1.0 and 1.0.

@param Value The input value that Perlin noise will be generated from. This is usually a steadily incrementing time value.

@return Perlin noise in the range of -1.0 to 1.0

| Improve this Doc View Source

PointsAreCoplanar(Byte, Single)

Determines whether a given set of points are coplanar, with a tolerance.

Declaration
public static bool PointsAreCoplanar(byte Points, float Tolerance)
Parameters
Type Name Description
System.Byte Points
System.Single Tolerance
Returns
Type Description
System.Boolean
Remarks

Any three points or less are always coplanar.

@param Points - The set of points to determine coplanarity for. @param Tolerance - Larger numbers means more variance is allowed.

@return Whether the points are relatively coplanar, based on the tolerance

| Improve this Doc View Source

ProjectPointOnToPlane(Vector, Vector, Vector)

Projects a point onto a plane defined by a point on the plane and a plane normal.

Declaration
public static Vector ProjectPointOnToPlane(Vector Point, Vector PlaneBase, Vector PlaneNormal)
Parameters
Type Name Description
Vector Point
Vector PlaneBase
Vector PlaneNormal
Returns
Type Description
Vector
Remarks

@param Point Point to project onto the plane. @param PlaneBase A point on the plane. @param PlaneNormal Normal of the plane. @return Point projected onto the plane.

| Improve this Doc View Source

ProjectVectorOnToPlane(Vector, Vector)

Projects a vector onto a plane defined by a normalized vector (PlaneNormal).

Declaration
public static Vector ProjectVectorOnToPlane(Vector V, Vector PlaneNormal)
Parameters
Type Name Description
Vector V
Vector PlaneNormal
Returns
Type Description
Vector
Remarks

@param V Vector to project onto the plane. @param PlaneNormal Normal of the plane. @return Vector projected onto the plane.

| Improve this Doc View Source

ProjectVectorOnToVector(Vector, Vector)

Projects one vector (V) onto another (Target) and returns the projected vector.

Declaration
public static Vector ProjectVectorOnToVector(Vector V, Vector Target)
Parameters
Type Name Description
Vector V
Vector Target
Returns
Type Description
Vector
Remarks

If Target is nearly zero in length, returns the zero vector.

@param V Vector to project. @param Target Vector on which we are projecting. @return V projected on to Target.

| Improve this Doc View Source

RadiansToDegrees(Single)

Returns degrees value based on the input radians

Declaration
public static float RadiansToDegrees(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

RandomBool()

Returns a uniformly distributed random bool

Declaration
public static bool RandomBool()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

RandomBoolFromStream(RandomStream)

Returns a random bool

Declaration
public static bool RandomBoolFromStream(RandomStream Stream)
Parameters
Type Name Description
RandomStream Stream
Returns
Type Description
System.Boolean
| Improve this Doc View Source

RandomBoolWithWeight(Single)

Get a random chance with the specified weight.

Declaration
public static bool RandomBoolWithWeight(float Weight)
Parameters
Type Name Description
System.Single Weight
Returns
Type Description
System.Boolean
Remarks

Range of weight is 0.0 - 1.0 E.g., Weight = .6 return value = True 60% of the time

| Improve this Doc View Source

RandomBoolWithWeightFromStream(Single, RandomStream)

Get a random chance with the specified weight.

Declaration
public static bool RandomBoolWithWeightFromStream(float Weight, RandomStream RandomStream)
Parameters
Type Name Description
System.Single Weight
RandomStream RandomStream
Returns
Type Description
System.Boolean
Remarks

Range of weight is 0.0 - 1.0 E.g., Weight = .6 return value = True 60% of the time

| Improve this Doc View Source

RandomFloat()

Returns a random float between 0 and 1

Declaration
public static float RandomFloat()
Returns
Type Description
System.Single
| Improve this Doc View Source

RandomFloatFromStream(RandomStream)

Returns a random float between 0 and 1

Declaration
public static float RandomFloatFromStream(RandomStream Stream)
Parameters
Type Name Description
RandomStream Stream
Returns
Type Description
System.Single
| Improve this Doc View Source

RandomFloatInRange(Single, Single)

Generate a random number between Min and Max

Declaration
public static float RandomFloatInRange(float Min, float Max)
Parameters
Type Name Description
System.Single Min
System.Single Max
Returns
Type Description
System.Single
| Improve this Doc View Source

RandomFloatInRangeFromStream(Single, Single, RandomStream)

Generate a random number between Min and Max

Declaration
public static float RandomFloatInRangeFromStream(float Min, float Max, RandomStream Stream)
Parameters
Type Name Description
System.Single Min
System.Single Max
RandomStream Stream
Returns
Type Description
System.Single
| Improve this Doc View Source

RandomInteger(Int32)

Returns a uniformly distributed random number between 0 and Max - 1

Declaration
public static int RandomInteger(int Max)
Parameters
Type Name Description
System.Int32 Max
Returns
Type Description
System.Int32
| Improve this Doc View Source

RandomIntegerFromStream(Int32, RandomStream)

Returns a uniformly distributed random number between 0 and Max - 1

Declaration
public static int RandomIntegerFromStream(int Max, RandomStream Stream)
Parameters
Type Name Description
System.Int32 Max
RandomStream Stream
Returns
Type Description
System.Int32
| Improve this Doc View Source

RandomIntegerInRange(Int32, Int32)

Declaration
public static int RandomIntegerInRange(int Min, int Max)
Parameters
Type Name Description
System.Int32 Min
System.Int32 Max
Returns
Type Description
System.Int32
| Improve this Doc View Source

RandomIntegerInRangeFromStream(Int32, Int32, RandomStream)

Declaration
public static int RandomIntegerInRangeFromStream(int Min, int Max, RandomStream Stream)
Parameters
Type Name Description
System.Int32 Min
System.Int32 Max
RandomStream Stream
Returns
Type Description
System.Int32
| Improve this Doc View Source

RandomPointInBoundingBox(Vector, Vector)

Returns a random point within the specified bounding box

Declaration
public static Vector RandomPointInBoundingBox(Vector Origin, Vector BoxExtent)
Parameters
Type Name Description
Vector Origin
Vector BoxExtent
Returns
Type Description
Vector
| Improve this Doc View Source

RandomRotator(Boolean)

Generates a random rotation, with optional random roll.

Declaration
public static Rotator RandomRotator(bool bRoll)
Parameters
Type Name Description
System.Boolean bRoll
Returns
Type Description
Rotator
| Improve this Doc View Source

RandomRotatorFromStream(Boolean, RandomStream)

Create a random rotation

Declaration
public static Rotator RandomRotatorFromStream(bool bRoll, RandomStream Stream)
Parameters
Type Name Description
System.Boolean bRoll
RandomStream Stream
Returns
Type Description
Rotator
| Improve this Doc View Source

RandomUnitVector()

Returns a random vector with length of 1

Declaration
public static Vector RandomUnitVector()
Returns
Type Description
Vector
| Improve this Doc View Source

RandomUnitVectorFromStream(RandomStream)

Returns a random vector with length of 1.0

Declaration
public static Vector RandomUnitVectorFromStream(RandomStream Stream)
Parameters
Type Name Description
RandomStream Stream
Returns
Type Description
Vector
| Improve this Doc View Source

RandomUnitVectorInConeInDegrees(Vector, Single)

Returns a random vector with length of 1, within the specified cone, with uniform random distribution.

Declaration
public static Vector RandomUnitVectorInConeInDegrees(Vector ConeDir, float ConeHalfAngleInDegrees)
Parameters
Type Name Description
Vector ConeDir
System.Single ConeHalfAngleInDegrees
Returns
Type Description
Vector
Remarks

@param ConeDir The base "center" direction of the cone. @param ConeHalfAngleInDegrees The half-angle of the cone (from ConeDir to edge), in degrees.

| Improve this Doc View Source

RandomUnitVectorInConeInDegreesFromStream(Vector, Single, RandomStream)

Returns a random vector with length of 1, within the specified cone, with uniform random distribution.

Declaration
public static Vector RandomUnitVectorInConeInDegreesFromStream(Vector ConeDir, float ConeHalfAngleInDegrees, RandomStream Stream)
Parameters
Type Name Description
Vector ConeDir
System.Single ConeHalfAngleInDegrees
RandomStream Stream
Returns
Type Description
Vector
Remarks

@param ConeDir The base "center" direction of the cone. @param ConeHalfAngleInDegrees The half-angle of the cone (from ConeDir to edge), in degrees. @param Stream The random stream from which to obtain the vector.

| Improve this Doc View Source

RandomUnitVectorInConeInRadians(Vector, Single)

Returns a random vector with length of 1, within the specified cone, with uniform random distribution.

Declaration
public static Vector RandomUnitVectorInConeInRadians(Vector ConeDir, float ConeHalfAngleInRadians)
Parameters
Type Name Description
Vector ConeDir
System.Single ConeHalfAngleInRadians
Returns
Type Description
Vector
Remarks

@param ConeDir The base "center" direction of the cone. @param ConeHalfAngleInRadians The half-angle of the cone (from ConeDir to edge), in radians.

| Improve this Doc View Source

RandomUnitVectorInConeInRadiansFromStream(Vector, Single, RandomStream)

Returns a random vector with length of 1, within the specified cone, with uniform random distribution.

Declaration
public static Vector RandomUnitVectorInConeInRadiansFromStream(Vector ConeDir, float ConeHalfAngleInRadians, RandomStream Stream)
Parameters
Type Name Description
Vector ConeDir
System.Single ConeHalfAngleInRadians
RandomStream Stream
Returns
Type Description
Vector
Remarks

@param ConeDir The base "center" direction of the cone. @param ConeHalfAngleInRadians The half-angle of the cone (from ConeDir to edge), in radians. @param Stream The random stream from which to obtain the vector.

| Improve this Doc View Source

RandomUnitVectorInEllipticalConeInDegrees(Vector, Single, Single)

Returns a random vector with length of 1, within the specified cone, with uniform random distribution.

Declaration
public static Vector RandomUnitVectorInEllipticalConeInDegrees(Vector ConeDir, float MaxYawInDegrees, float MaxPitchInDegrees)
Parameters
Type Name Description
Vector ConeDir
System.Single MaxYawInDegrees
System.Single MaxPitchInDegrees
Returns
Type Description
Vector
Remarks

The shape of the cone can be modified according to the yaw and pitch angles.

@param MaxYawInDegrees The yaw angle of the cone (from ConeDir to horizontal edge), in degrees. @param MaxPitchInDegrees The pitch angle of the cone (from ConeDir to vertical edge), in degrees.

| Improve this Doc View Source

RandomUnitVectorInEllipticalConeInDegreesFromStream(Vector, Single, Single, RandomStream)

Returns a random vector with length of 1, within the specified cone, with uniform random distribution.

Declaration
public static Vector RandomUnitVectorInEllipticalConeInDegreesFromStream(Vector ConeDir, float MaxYawInDegrees, float MaxPitchInDegrees, RandomStream Stream)
Parameters
Type Name Description
Vector ConeDir
System.Single MaxYawInDegrees
System.Single MaxPitchInDegrees
RandomStream Stream
Returns
Type Description
Vector
Remarks

The shape of the cone can be modified according to the yaw and pitch angles.

@param MaxYawInDegrees The yaw angle of the cone (from ConeDir to horizontal edge), in degrees. @param MaxPitchInDegrees The pitch angle of the cone (from ConeDir to vertical edge), in degrees. @param Stream The random stream from which to obtain the vector.

| Improve this Doc View Source

RandomUnitVectorInEllipticalConeInRadians(Vector, Single, Single)

Returns a random vector with length of 1, within the specified cone, with uniform random distribution.

Declaration
public static Vector RandomUnitVectorInEllipticalConeInRadians(Vector ConeDir, float MaxYawInRadians, float MaxPitchInRadians)
Parameters
Type Name Description
Vector ConeDir
System.Single MaxYawInRadians
System.Single MaxPitchInRadians
Returns
Type Description
Vector
Remarks

The shape of the cone can be modified according to the yaw and pitch angles.

@param MaxYawInRadians The yaw angle of the cone (from ConeDir to horizontal edge), in radians. @param MaxPitchInRadians The pitch angle of the cone (from ConeDir to vertical edge), in radians.

| Improve this Doc View Source

RandomUnitVectorInEllipticalConeInRadiansFromStream(Vector, Single, Single, RandomStream)

Returns a random vector with length of 1, within the specified cone, with uniform random distribution.

Declaration
public static Vector RandomUnitVectorInEllipticalConeInRadiansFromStream(Vector ConeDir, float MaxYawInRadians, float MaxPitchInRadians, RandomStream Stream)
Parameters
Type Name Description
Vector ConeDir
System.Single MaxYawInRadians
System.Single MaxPitchInRadians
RandomStream Stream
Returns
Type Description
Vector
Remarks

The shape of the cone can be modified according to the yaw and pitch angles.

@param MaxYawInRadians The yaw angle of the cone (from ConeDir to horizontal edge), in radians. @param MaxPitchInRadians The pitch angle of the cone (from ConeDir to vertical edge), in radians. @param Stream The random stream from which to obtain the vector.

| Improve this Doc View Source

REase(Rotator, Rotator, Single, Boolean, Byte, Single, Int32)

Easeing between A and B using a specified easing function

Declaration
public static Rotator REase(Rotator A, Rotator B, float Alpha, bool bShortestPath, byte EasingFunc, float BlendExp, int Steps)
Parameters
Type Name Description
Rotator A
Rotator B
System.Single Alpha
System.Boolean bShortestPath
System.Byte EasingFunc
System.Single BlendExp
System.Int32 Steps
Returns
Type Description
Rotator
| Improve this Doc View Source

ResetFloatSpringState(FloatSpringState)

Resets the state of a given spring

Declaration
public static void ResetFloatSpringState(FloatSpringState SpringState)
Parameters
Type Name Description
FloatSpringState SpringState
| Improve this Doc View Source

ResetRandomStream(RandomStream)

Reset a random stream

Declaration
public static void ResetRandomStream(RandomStream Stream)
Parameters
Type Name Description
RandomStream Stream
| Improve this Doc View Source

ResetVectorSpringState(VectorSpringState)

Resets the state of a given spring

Declaration
public static void ResetVectorSpringState(VectorSpringState SpringState)
Parameters
Type Name Description
VectorSpringState SpringState
| Improve this Doc View Source

RGBToHSV(LinearColor)

Breaks apart a color into individual HSV components (as well as alpha) (Hue is [0..360) while Saturation and Value are 0..1)

Declaration
public static (float, float, float, float) RGBToHSV(LinearColor InColor)
Parameters
Type Name Description
LinearColor InColor
Returns
Type Description
System.ValueTuple<System.Single, System.Single, System.Single, System.Single>
| Improve this Doc View Source

RGBToHSV_Vector(LinearColor)

Converts a RGB linear color to HSV (where H is in R (0..360), S is in G (0..1), and V is in B (0..1))

Declaration
public static LinearColor RGBToHSV_Vector(LinearColor RGB)
Parameters
Type Name Description
LinearColor RGB
Returns
Type Description
LinearColor
| Improve this Doc View Source

RInterpTo(Rotator, Rotator, Single, Single)

Tries to reach Target rotation based on Current rotation, giving a nice smooth feeling when rotating to Target rotation.

Declaration
public static Rotator RInterpTo(Rotator Current, Rotator Target, float DeltaTime, float InterpSpeed)
Parameters
Type Name Description
Rotator Current
Rotator Target
System.Single DeltaTime
System.Single InterpSpeed
Returns
Type Description
Rotator
Remarks

@param Current Actual rotation @param Target Target rotation @param DeltaTime Time since last tick @param InterpSpeed Interpolation speed @return New interpolated position

| Improve this Doc View Source

RInterpTo_Constant(Rotator, Rotator, Single, Single)

Tries to reach Target rotation at a constant rate.

Declaration
public static Rotator RInterpTo_Constant(Rotator Current, Rotator Target, float DeltaTime, float InterpSpeed)
Parameters
Type Name Description
Rotator Current
Rotator Target
System.Single DeltaTime
System.Single InterpSpeed
Returns
Type Description
Rotator
Remarks

@param Current Actual rotation @param Target Target rotation @param DeltaTime Time since last tick @param InterpSpeed Interpolation speed @return New interpolated position

| Improve this Doc View Source

RLerp(Rotator, Rotator, Single, Boolean)

Linearly interpolates between A and B based on Alpha (100% of A when Alpha=0 and 100% of B when Alpha=1)

Declaration
public static Rotator RLerp(Rotator A, Rotator B, float Alpha, bool bShortestPath)
Parameters
Type Name Description
Rotator A
Rotator B
System.Single Alpha
System.Boolean bShortestPath
Returns
Type Description
Rotator
| Improve this Doc View Source

RotateAngleAxis(Vector, Single, Vector)

Returns result of vector A rotated by AngleDeg around Axis

Declaration
public static Vector RotateAngleAxis(Vector InVect, float AngleDeg, Vector Axis)
Parameters
Type Name Description
Vector InVect
System.Single AngleDeg
Vector Axis
Returns
Type Description
Vector
| Improve this Doc View Source

RotatorFromAxisAndAngle(Vector, Single)

Create a rotation from an axis and and angle (in degrees)

Declaration
public static Rotator RotatorFromAxisAndAngle(Vector Axis, float Angle)
Parameters
Type Name Description
Vector Axis
System.Single Angle
Returns
Type Description
Rotator
| Improve this Doc View Source

Round(Single)

Rounds A to the nearest integer

Declaration
public static int Round(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Int32
| Improve this Doc View Source

SeedRandomStream(RandomStream)

Create a new random seed for a random stream

Declaration
public static void SeedRandomStream(RandomStream Stream)
Parameters
Type Name Description
RandomStream Stream
| Improve this Doc View Source

SelectClass(SubclassOf<UObject>, SubclassOf<UObject>, Boolean)

If bPickA is true, A is returned, otherwise B is

Declaration
public static SubclassOf<UObject> SelectClass(SubclassOf<UObject> A, SubclassOf<UObject> B, bool bSelectA)
Parameters
Type Name Description
SubclassOf<UObject> A
SubclassOf<UObject> B
System.Boolean bSelectA
Returns
Type Description
SubclassOf<UObject>
| Improve this Doc View Source

SelectColor(LinearColor, LinearColor, Boolean)

If bPickA is true, A is returned, otherwise B is

Declaration
public static LinearColor SelectColor(LinearColor A, LinearColor B, bool bPickA)
Parameters
Type Name Description
LinearColor A
LinearColor B
System.Boolean bPickA
Returns
Type Description
LinearColor
| Improve this Doc View Source

SelectFloat(Single, Single, Boolean)

If bPickA is true, A is returned, otherwise B is

Declaration
public static float SelectFloat(float A, float B, bool bPickA)
Parameters
Type Name Description
System.Single A
System.Single B
System.Boolean bPickA
Returns
Type Description
System.Single
| Improve this Doc View Source

SelectInt(Int32, Int32, Boolean)

If bPickA is true, A is returned, otherwise B is

Declaration
public static int SelectInt(int A, int B, bool bPickA)
Parameters
Type Name Description
System.Int32 A
System.Int32 B
System.Boolean bPickA
Returns
Type Description
System.Int32
| Improve this Doc View Source

SelectObject(UObject, UObject, Boolean)

If bPickA is true, A is returned, otherwise B is

Declaration
public static UObject SelectObject(UObject A, UObject B, bool bSelectA)
Parameters
Type Name Description
UObject A
UObject B
System.Boolean bSelectA
Returns
Type Description
UObject
| Improve this Doc View Source

SelectRotator(Rotator, Rotator, Boolean)

If bPickA is true, A is returned, otherwise B is

Declaration
public static Rotator SelectRotator(Rotator A, Rotator B, bool bPickA)
Parameters
Type Name Description
Rotator A
Rotator B
System.Boolean bPickA
Returns
Type Description
Rotator
| Improve this Doc View Source

SelectString(String, String, Boolean)

If bPickA is true, A is returned, otherwise B is

Declaration
public static string SelectString(string A, string B, bool bPickA)
Parameters
Type Name Description
System.String A
System.String B
System.Boolean bPickA
Returns
Type Description
System.String
| Improve this Doc View Source

SelectTransform(Transform, Transform, Boolean)

If bPickA is true, A is returned, otherwise B is

Declaration
public static Transform SelectTransform(Transform A, Transform B, bool bPickA)
Parameters
Type Name Description
Transform A
Transform B
System.Boolean bPickA
Returns
Type Description
Transform
| Improve this Doc View Source

SelectVector(Vector, Vector, Boolean)

If bPickA is true, A is returned, otherwise B is

Declaration
public static Vector SelectVector(Vector A, Vector B, bool bPickA)
Parameters
Type Name Description
Vector A
Vector B
System.Boolean bPickA
Returns
Type Description
Vector
| Improve this Doc View Source

SetRandomStreamSeed(RandomStream, Int32)

Set the seed of a random stream to a specific number

Declaration
public static void SetRandomStreamSeed(RandomStream Stream, int NewSeed)
Parameters
Type Name Description
RandomStream Stream
System.Int32 NewSeed
| Improve this Doc View Source

SignOfFloat(Single)

Declaration
public static float SignOfFloat(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

SignOfInteger(Int32)

Declaration
public static int SignOfInteger(int A)
Parameters
Type Name Description
System.Int32 A
Returns
Type Description
System.Int32
| Improve this Doc View Source

Sin(Single)

Returns the sine of A (expects Radians)

Declaration
public static float Sin(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

Sqrt(Single)

Returns square root of A

Declaration
public static float Sqrt(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

Square(Single)

Returns square of A (A*A)

Declaration
public static float Square(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

Subtract_ByteByte(Byte, Byte)

Subtraction (A - B)

Declaration
public static byte Subtract_ByteByte(byte A, byte B)
Parameters
Type Name Description
System.Byte A
System.Byte B
Returns
Type Description
System.Byte
| Improve this Doc View Source

Subtract_DateTimeDateTime(FDateTime, FDateTime)

Subtraction (A - B)

Declaration
public static Timespan Subtract_DateTimeDateTime(FDateTime A, FDateTime B)
Parameters
Type Name Description
FDateTime A
FDateTime B
Returns
Type Description
Timespan
| Improve this Doc View Source

Subtract_DateTimeTimespan(FDateTime, Timespan)

Subtraction (A - B)

Declaration
public static FDateTime Subtract_DateTimeTimespan(FDateTime A, Timespan B)
Parameters
Type Name Description
FDateTime A
Timespan B
Returns
Type Description
FDateTime
| Improve this Doc View Source

Subtract_FloatFloat(Single, Single)

Subtraction (A - B)

Declaration
public static float Subtract_FloatFloat(float A, float B)
Parameters
Type Name Description
System.Single A
System.Single B
Returns
Type Description
System.Single
| Improve this Doc View Source

Subtract_IntInt(Int32, Int32)

Subtraction (A - B)

Declaration
public static int Subtract_IntInt(int A, int B)
Parameters
Type Name Description
System.Int32 A
System.Int32 B
Returns
Type Description
System.Int32
| Improve this Doc View Source

Subtract_TimespanTimespan(Timespan, Timespan)

Subtraction (A - B)

Declaration
public static Timespan Subtract_TimespanTimespan(Timespan A, Timespan B)
Parameters
Type Name Description
Timespan A
Timespan B
Returns
Type Description
Timespan
| Improve this Doc View Source

Subtract_Vector2DFloat(Vector2D, Single)

Returns Vector A subtracted by B

Declaration
public static Vector2D Subtract_Vector2DFloat(Vector2D A, float B)
Parameters
Type Name Description
Vector2D A
System.Single B
Returns
Type Description
Vector2D
| Improve this Doc View Source

Subtract_Vector2DVector2D(Vector2D, Vector2D)

Returns subtraction of Vector B from Vector A (A - B)

Declaration
public static Vector2D Subtract_Vector2DVector2D(Vector2D A, Vector2D B)
Parameters
Type Name Description
Vector2D A
Vector2D B
Returns
Type Description
Vector2D
| Improve this Doc View Source

Subtract_VectorFloat(Vector, Single)

Subtracts a float from each component of a vector

Declaration
public static Vector Subtract_VectorFloat(Vector A, float B)
Parameters
Type Name Description
Vector A
System.Single B
Returns
Type Description
Vector
| Improve this Doc View Source

Subtract_VectorInt(Vector, Int32)

Subtracts an integer from each component of a vector

Declaration
public static Vector Subtract_VectorInt(Vector A, int B)
Parameters
Type Name Description
Vector A
System.Int32 B
Returns
Type Description
Vector
| Improve this Doc View Source

Subtract_VectorVector(Vector, Vector)

Vector subtraction

Declaration
public static Vector Subtract_VectorVector(Vector A, Vector B)
Parameters
Type Name Description
Vector A
Vector B
Returns
Type Description
Vector
| Improve this Doc View Source

Tan(Single)

Returns the tan of A (expects Radians)

Declaration
public static float Tan(float A)
Parameters
Type Name Description
System.Single A
Returns
Type Description
System.Single
| Improve this Doc View Source

TEase(Transform, Transform, Single, Byte, Single, Int32)

Ease between A and B using a specified easing function.

Declaration
public static Transform TEase(Transform A, Transform B, float Alpha, byte EasingFunc, float BlendExp, int Steps)
Parameters
Type Name Description
Transform A
Transform B
System.Single Alpha
System.Byte EasingFunc
System.Single BlendExp
System.Int32 Steps
Returns
Type Description
Transform
| Improve this Doc View Source

TimespanFromString(String)

Converts a time span string to a Timespan object

Declaration
public static (Timespan, bool) TimespanFromString(string TimespanString)
Parameters
Type Name Description
System.String TimespanString
Returns
Type Description
System.ValueTuple<Timespan, System.Boolean>
| Improve this Doc View Source

TimespanMaxValue()

Returns the maximum time span value

Declaration
public static Timespan TimespanMaxValue()
Returns
Type Description
Timespan
| Improve this Doc View Source

TimespanMinValue()

Returns the minimum time span value

Declaration
public static Timespan TimespanMinValue()
Returns
Type Description
Timespan
| Improve this Doc View Source

TimespanRatio(Timespan, Timespan)

Returns the ratio between two time spans (A / B), handles zero values

Declaration
public static float TimespanRatio(Timespan A, Timespan B)
Parameters
Type Name Description
Timespan A
Timespan B
Returns
Type Description
System.Single
| Improve this Doc View Source

TimespanZeroValue()

Returns a zero time span value

Declaration
public static Timespan TimespanZeroValue()
Returns
Type Description
Timespan
| Improve this Doc View Source

TInterpTo(Transform, Transform, Single, Single)

Tries to reach a target transform.

Declaration
public static Transform TInterpTo(Transform Current, Transform Target, float DeltaTime, float InterpSpeed)
Parameters
Type Name Description
Transform Current
Transform Target
System.Single DeltaTime
System.Single InterpSpeed
Returns
Type Description
Transform
| Improve this Doc View Source

TLerp(Transform, Transform, Single, Byte)

Linearly interpolates between A and B based on Alpha (100% of A when Alpha=0 and 100% of B when Alpha=1).

Declaration
public static Transform TLerp(Transform A, Transform B, float Alpha, byte InterpMode)
Parameters
Type Name Description
Transform A
Transform B
System.Single Alpha
System.Byte InterpMode
Returns
Type Description
Transform
| Improve this Doc View Source

Today()

Returns the local date on this computer

Declaration
public static FDateTime Today()
Returns
Type Description
FDateTime
| Improve this Doc View Source

Transform_Determinant(Transform)

Calculates the determinant of the transform (converts to FMatrix internally)

Declaration
public static float Transform_Determinant(Transform Transform)
Parameters
Type Name Description
Transform Transform
Returns
Type Description
System.Single
| Improve this Doc View Source

TransformDirection(Transform, Vector)

Transform a direction vector by the supplied transform - will not change its length.

Declaration
public static Vector TransformDirection(Transform T, Vector Direction)
Parameters
Type Name Description
Transform T
Vector Direction
Returns
Type Description
Vector
Remarks

For example, if T was an object's transform, this would transform a direction from local space to world space.

| Improve this Doc View Source

TransformLocation(Transform, Vector)

Transform a position by the supplied transform.

Declaration
public static Vector TransformLocation(Transform T, Vector Location)
Parameters
Type Name Description
Transform T
Vector Location
Returns
Type Description
Vector
Remarks

For example, if T was an object's transform, this would transform a position from local space to world space.

| Improve this Doc View Source

TransformRotation(Transform, Rotator)

Transform a rotator by the supplied transform.

Declaration
public static Rotator TransformRotation(Transform T, Rotator Rotation)
Parameters
Type Name Description
Transform T
Rotator Rotation
Returns
Type Description
Rotator
Remarks

For example, if T was an object's transform, this would transform a rotation from local space to world space.

| Improve this Doc View Source

UtcNow()

Returns the UTC date and time on this computer

Declaration
public static FDateTime UtcNow()
Returns
Type Description
FDateTime
| Improve this Doc View Source

VEase(Vector, Vector, Single, Byte, Single, Int32)

Easeing between A and B using a specified easing function

Declaration
public static Vector VEase(Vector A, Vector B, float Alpha, byte EasingFunc, float BlendExp, int Steps)
Parameters
Type Name Description
Vector A
Vector B
System.Single Alpha
System.Byte EasingFunc
System.Single BlendExp
System.Int32 Steps
Returns
Type Description
Vector
| Improve this Doc View Source

Vector2DInterpTo(Vector2D, Vector2D, Single, Single)

Tries to reach Target based on distance from Current position, giving a nice smooth feeling when tracking a position.

Declaration
public static Vector2D Vector2DInterpTo(Vector2D Current, Vector2D Target, float DeltaTime, float InterpSpeed)
Parameters
Type Name Description
Vector2D Current
Vector2D Target
System.Single DeltaTime
System.Single InterpSpeed
Returns
Type Description
Vector2D
Remarks

@param Current Actual position @param Target Target position @param DeltaTime Time since last tick @param InterpSpeed Interpolation speed @return New interpolated position

| Improve this Doc View Source

Vector2DInterpTo_Constant(Vector2D, Vector2D, Single, Single)

Tries to reach Target at a constant rate.

Declaration
public static Vector2D Vector2DInterpTo_Constant(Vector2D Current, Vector2D Target, float DeltaTime, float InterpSpeed)
Parameters
Type Name Description
Vector2D Current
Vector2D Target
System.Single DeltaTime
System.Single InterpSpeed
Returns
Type Description
Vector2D
Remarks

@param Current Actual position @param Target Target position @param DeltaTime Time since last tick @param InterpSpeed Interpolation speed @return New interpolated position

| Improve this Doc View Source

VectorSpringInterp(Vector, Vector, VectorSpringState, Single, Single, Single, Single)

Uses a simple spring model to interpolate a vector from Current to Target.

Declaration
public static Vector VectorSpringInterp(Vector Current, Vector Target, VectorSpringState SpringState, float Stiffness, float CriticalDampingFactor, float DeltaTime, float Mass)
Parameters
Type Name Description
Vector Current
Vector Target
VectorSpringState SpringState
System.Single Stiffness
System.Single CriticalDampingFactor
System.Single DeltaTime
System.Single Mass
Returns
Type Description
Vector
Remarks

@param Current Current value @param Target Target value @param SpringState Data related to spring model (velocity, error, etc..) - Create a unique variable per spring @param Stiffness How stiff the spring model is (more stiffness means more oscillation around the target value) @param CriticalDampingFactor How much damping to apply to the spring (0 means no damping, 1 means critically damped which means no oscillation) @param Mass Multiplier that acts like mass on a spring

| Improve this Doc View Source

VInterpTo(Vector, Vector, Single, Single)

Tries to reach Target based on distance from Current position, giving a nice smooth feeling when tracking a position.

Declaration
public static Vector VInterpTo(Vector Current, Vector Target, float DeltaTime, float InterpSpeed)
Parameters
Type Name Description
Vector Current
Vector Target
System.Single DeltaTime
System.Single InterpSpeed
Returns
Type Description
Vector
Remarks

@param Current Actual position @param Target Target position @param DeltaTime Time since last tick @param InterpSpeed Interpolation speed @return New interpolated position

| Improve this Doc View Source

VInterpTo_Constant(Vector, Vector, Single, Single)

Tries to reach Target at a constant rate.

Declaration
public static Vector VInterpTo_Constant(Vector Current, Vector Target, float DeltaTime, float InterpSpeed)
Parameters
Type Name Description
Vector Current
Vector Target
System.Single DeltaTime
System.Single InterpSpeed
Returns
Type Description
Vector
Remarks

@param Current Actual position @param Target Target position @param DeltaTime Time since last tick @param InterpSpeed Interpolation speed @return New interpolated position

| Improve this Doc View Source

VLerp(Vector, Vector, Single)

Linearly interpolates between A and B based on Alpha (100% of A when Alpha=0 and 100% of B when Alpha=1)

Declaration
public static Vector VLerp(Vector A, Vector B, float Alpha)
Parameters
Type Name Description
Vector A
Vector B
System.Single Alpha
Returns
Type Description
Vector
| Improve this Doc View Source

VSize(Vector)

Returns the length of the FVector

Declaration
public static float VSize(Vector A)
Parameters
Type Name Description
Vector A
Returns
Type Description
System.Single
| Improve this Doc View Source

VSize2D(Vector2D)

Returns the length of a 2d FVector.

Declaration
public static float VSize2D(Vector2D A)
Parameters
Type Name Description
Vector2D A
Returns
Type Description
System.Single
| Improve this Doc View Source

VSize2DSquared(Vector2D)

Returns the squared length of a 2d FVector.

Declaration
public static float VSize2DSquared(Vector2D A)
Parameters
Type Name Description
Vector2D A
Returns
Type Description
System.Single
| Improve this Doc View Source

VSizeSquared(Vector)

Returns the squared length of the FVector

Declaration
public static float VSizeSquared(Vector A)
Parameters
Type Name Description
Vector A
Returns
Type Description
System.Single
| Improve this Doc View Source

VSizeXY(Vector)

Returns the length of the FVector's in XY components.

Declaration
public static float VSizeXY(Vector A)
Parameters
Type Name Description
Vector A
Returns
Type Description
System.Single
| Improve this Doc View Source

Xor_IntInt(Int32, Int32)

Bitwise XOR (A ^ B)

Declaration
public static int Xor_IntInt(int A, int B)
Parameters
Type Name Description
System.Int32 A
System.Int32 B
Returns
Type Description
System.Int32

Operators

| Improve this Doc View Source

Implicit(IntPtr to KismetMathLibrary)

Convert from IntPtr to UObject

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