Class KismetSystemLibrary

Kismet System Library

Inheritance

System.Object

UObject

BlueprintFunctionLibrary

KismetSystemLibrary

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 KismetSystemLibrary : BlueprintFunctionLibrary

Properties

DefaultObject

Get UE4 Default Object for this Class

Declaration

public static KismetSystemLibrary DefaultObject { get; }

Property Value

Type	Description
KismetSystemLibrary

StaticClass

Get UE4 Class

Declaration

public static Class StaticClass { get; }

Property Value

Type	Description
Class

Methods

AddFloatHistorySample(Single, DebugFloatHistory)

Add Float History Sample

Declaration

public static DebugFloatHistory AddFloatHistorySample(float Value, DebugFloatHistory FloatHistory)

Parameters

Type	Name	Description
System.Single	Value
DebugFloatHistory	FloatHistory

Returns

Type	Description
DebugFloatHistory

BeginTransaction(String, Byte, UObject)

Begin a new undo transaction.

Declaration

public static int BeginTransaction(string Context, byte Description, UObject PrimaryObject)

Parameters

Type	Name	Description
System.String	Context
System.Byte	Description
UObject	PrimaryObject

Returns

Type	Description
System.Int32

Remarks

An undo transaction is defined as all actions which take place when the user selects "undo" a single time. @note If there is already an active transaction in progress, then this increments that transaction's action counter instead of beginning a new transaction. @note You must call TransactObject before modifying each object that should be included in this undo transaction. @note Only available in the editor.

@param Context The context for the undo session. Typically the tool/editor that caused the undo operation. @param Description The description for the undo session. This is the text that will appear in the "Edit" menu next to the Undo item. @param PrimaryObject The primary object that the undo session operators on (can be null, and mostly is).

@return The number of active actions when BeginTransaction was called (values greater than 0 indicate that there was already an existing undo transaction in progress), or -1 on failure.

BoxOverlapActors(UObject, Vector, Vector, Byte, SubclassOf<UObject>, Byte)

Returns an array of actors that overlap the given axis-aligned box.

Declaration

public static (IReadOnlyCollection<Actor>, bool) BoxOverlapActors(UObject WorldContextObject, Vector BoxPos, Vector BoxExtent, byte ObjectTypes, SubclassOf<UObject> ActorClassFilter, byte ActorsToIgnore)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	BoxPos
Vector	BoxExtent
System.Byte	ObjectTypes
SubclassOf<UObject>	ActorClassFilter
System.Byte	ActorsToIgnore

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<Actor>, System.Boolean>

Remarks

@param WorldContext World context @param BoxPos Center of box. @param BoxExtent Extents of box. @param Filter Option to restrict results to only static or only dynamic. For efficiency. @param ClassFilter If set, will only return results of this class or subclasses of it. @param ActorsToIgnore Ignore these actors in the list @param OutActors Returned array of actors. Unsorted. @return true if there was an overlap that passed the filters, false otherwise.

BoxOverlapComponents(UObject, Vector, Vector, Byte, SubclassOf<UObject>, Byte)

Returns an array of components that overlap the given axis-aligned box.

Declaration

public static (IReadOnlyCollection<PrimitiveComponent>, bool) BoxOverlapComponents(UObject WorldContextObject, Vector BoxPos, Vector Extent, byte ObjectTypes, SubclassOf<UObject> ComponentClassFilter, byte ActorsToIgnore)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	BoxPos
Vector	Extent
System.Byte	ObjectTypes
SubclassOf<UObject>	ComponentClassFilter
System.Byte	ActorsToIgnore

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<PrimitiveComponent>, System.Boolean>

Remarks

@param WorldContext World context @param BoxPos Center of box. @param BoxExtent Extents of box. @param Filter Option to restrict results to only static or only dynamic. For efficiency. @param ClassFilter If set, will only return results of this class or subclasses of it. @param ActorsToIgnore Ignore these actors in the list @param OutActors Returned array of actors. Unsorted. @return true if there was an overlap that passed the filters, false otherwise.

BoxTraceMulti(UObject, Vector, Vector, Vector, Rotator, Byte, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Sweeps a box along the given line and returns all hits encountered.

Declaration

public static (IReadOnlyCollection<HitResult>, bool) BoxTraceMulti(UObject WorldContextObject, Vector Start, Vector End, Vector HalfSize, Rotator Orientation, byte TraceChannel, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
Vector	HalfSize
Rotator	Orientation
System.Byte	TraceChannel
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<HitResult>, System.Boolean>

Remarks

This trace finds the objects that RESPONDS to the given TraceChannel

@param Start Start of line segment. @param End End of line segment. @param HalfSize Distance from the center of box along each axis @param Orientation Orientation of the box @param TraceChannel @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHits A list of hits, sorted along the trace from start to finish. The blocking hit will be the last hit, if there was one. @return True if there was a blocking hit, false otherwise.

BoxTraceMultiByProfile(UObject, Vector, Vector, Vector, Rotator, Name, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Sweep a box against the world and return all initial overlaps using a specific profile, then overlapping hits and then first blocking hit Results are sorted, so a blocking hit (if found) will be the last element of the array Only the single closest blocking result will be generated, no tests will be done after that @

Declaration

public static (IReadOnlyCollection<HitResult>, bool) BoxTraceMultiByProfile(UObject WorldContextObject, Vector Start, Vector End, Vector HalfSize, Rotator Orientation, Name ProfileName, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
Vector	HalfSize
Rotator	Orientation
Name	ProfileName
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<HitResult>, System.Boolean>

Remarks

param Start Start of line segment. @param End End of line segment. @param HalfSize Distance from the center of box along each axis @param Orientation Orientation of the box @param ProfileName The 'profile' used to determine which components to hit @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHits A list of hits, sorted along the trace from start to finish. The blocking hit will be the last hit, if there was one. @return True if there was a blocking hit, false otherwise.

BoxTraceMultiForObjects(UObject, Vector, Vector, Vector, Rotator, Byte, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Sweeps a box along the given line and returns all hits encountered.

Declaration

public static (IReadOnlyCollection<HitResult>, bool) BoxTraceMultiForObjects(UObject WorldContextObject, Vector Start, Vector End, Vector HalfSize, Rotator Orientation, byte ObjectTypes, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
Vector	HalfSize
Rotator	Orientation
System.Byte	ObjectTypes
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<HitResult>, System.Boolean>

Remarks

This only finds objects that are of a type specified by ObjectTypes.

@param Start Start of line segment. @param End End of line segment. @param Orientation @param HalfSize Radius of the sphere to sweep @param ObjectTypes Array of Object Types to trace @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHits A list of hits, sorted along the trace from start to finish. The blocking hit will be the last hit, if there was one. @return True if there was a hit, false otherwise.

BoxTraceSingle(UObject, Vector, Vector, Vector, Rotator, Byte, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Sweeps a box along the given line and returns the first blocking hit encountered.

Declaration

public static (HitResult, bool) BoxTraceSingle(UObject WorldContextObject, Vector Start, Vector End, Vector HalfSize, Rotator Orientation, byte TraceChannel, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
Vector	HalfSize
Rotator	Orientation
System.Byte	TraceChannel
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<HitResult, System.Boolean>

Remarks

This trace finds the objects that RESPONDS to the given TraceChannel

@param Start Start of line segment. @param End End of line segment. @param HalfSize Distance from the center of box along each axis @param Orientation Orientation of the box @param TraceChannel @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHit Properties of the trace hit. @return True if there was a hit, false otherwise.

BoxTraceSingleByProfile(UObject, Vector, Vector, Vector, Rotator, Name, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Sweep a box against the world and return the first blocking hit using a specific profile @

Declaration

public static (HitResult, bool) BoxTraceSingleByProfile(UObject WorldContextObject, Vector Start, Vector End, Vector HalfSize, Rotator Orientation, Name ProfileName, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
Vector	HalfSize
Rotator	Orientation
Name	ProfileName
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<HitResult, System.Boolean>

Remarks

param Start Start of line segment. @param End End of line segment. @param HalfSize Distance from the center of box along each axis @param Orientation Orientation of the box @param ProfileName The 'profile' used to determine which components to hit @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHit Properties of the trace hit. @return True if there was a hit, false otherwise.

BoxTraceSingleForObjects(UObject, Vector, Vector, Vector, Rotator, Byte, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Sweeps a box along the given line and returns the first hit encountered.

Declaration

public static (HitResult, bool) BoxTraceSingleForObjects(UObject WorldContextObject, Vector Start, Vector End, Vector HalfSize, Rotator Orientation, byte ObjectTypes, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
Vector	HalfSize
Rotator	Orientation
System.Byte	ObjectTypes
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<HitResult, System.Boolean>

Remarks

This only finds objects that are of a type specified by ObjectTypes.

@param Start Start of line segment. @param End End of line segment. @param Orientation @param HalfSize Radius of the sphere to sweep @param ObjectTypes Array of Object Types to trace @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHit Properties of the trace hit. @return True if there was a hit, false otherwise.

BreakSoftClassPath(SoftClassPath)

Gets the path string out of a Soft Class Path

Declaration

public static string BreakSoftClassPath(SoftClassPath InSoftClassPath)

Parameters

Type	Name	Description
SoftClassPath	InSoftClassPath

Returns

Type	Description
System.String

BreakSoftObjectPath(SoftObjectPath)

Gets the path string out of a Soft Object Path

Declaration

public static string BreakSoftObjectPath(SoftObjectPath InSoftObjectPath)

Parameters

Type	Name	Description
SoftObjectPath	InSoftObjectPath

Returns

Type	Description
System.String

CancelTransaction(Int32)

Cancel the current transaction, and no longer capture actions to be placed in the undo buffer.

Declaration

public static void CancelTransaction(int Index)

Parameters

Type	Name	Description
System.Int32	Index

Remarks

@note Only available in the editor.

@param Index The action counter to cancel transactions from (as returned by a call to BeginTransaction).

CanLaunchURL(String)

Can Launch URL

Declaration

public static bool CanLaunchURL(string URL)

Parameters

Type	Name	Description
System.String	URL

Returns

Type	Description
System.Boolean

CapsuleOverlapActors(UObject, Vector, Single, Single, Byte, SubclassOf<UObject>, Byte)

Returns an array of actors that overlap the given capsule.

Declaration

public static (IReadOnlyCollection<Actor>, bool) CapsuleOverlapActors(UObject WorldContextObject, Vector CapsulePos, float Radius, float HalfHeight, byte ObjectTypes, SubclassOf<UObject> ActorClassFilter, byte ActorsToIgnore)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	CapsulePos
System.Single	Radius
System.Single	HalfHeight
System.Byte	ObjectTypes
SubclassOf<UObject>	ActorClassFilter
System.Byte	ActorsToIgnore

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<Actor>, System.Boolean>

Remarks

@param WorldContext World context @param CapsulePos Center of the capsule. @param Radius Radius of capsule hemispheres and radius of center cylinder portion. @param HalfHeight Half-height of the capsule (from center of capsule to tip of hemisphere. @param Filter Option to restrict results to only static or only dynamic. For efficiency. @param ClassFilter If set, will only return results of this class or subclasses of it. @param ActorsToIgnore Ignore these actors in the list @param OutActors Returned array of actors. Unsorted. @return true if there was an overlap that passed the filters, false otherwise.

CapsuleOverlapComponents(UObject, Vector, Single, Single, Byte, SubclassOf<UObject>, Byte)

Returns an array of components that overlap the given capsule.

Declaration

public static (IReadOnlyCollection<PrimitiveComponent>, bool) CapsuleOverlapComponents(UObject WorldContextObject, Vector CapsulePos, float Radius, float HalfHeight, byte ObjectTypes, SubclassOf<UObject> ComponentClassFilter, byte ActorsToIgnore)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	CapsulePos
System.Single	Radius
System.Single	HalfHeight
System.Byte	ObjectTypes
SubclassOf<UObject>	ComponentClassFilter
System.Byte	ActorsToIgnore

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<PrimitiveComponent>, System.Boolean>

Remarks

@param WorldContext World context @param CapsulePos Center of the capsule. @param Radius Radius of capsule hemispheres and radius of center cylinder portion. @param HalfHeight Half-height of the capsule (from center of capsule to tip of hemisphere. @param Filter Option to restrict results to only static or only dynamic. For efficiency. @param ClassFilter If set, will only return results of this class or subclasses of it. @param ActorsToIgnore Ignore these actors in the list @param OutActors Returned array of actors. Unsorted. @return true if there was an overlap that passed the filters, false otherwise.

CapsuleTraceMulti(UObject, Vector, Vector, Single, Single, Byte, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Sweeps a capsule along the given line and returns all hits encountered up to and including the first blocking hit.

Declaration

public static (IReadOnlyCollection<HitResult>, bool) CapsuleTraceMulti(UObject WorldContextObject, Vector Start, Vector End, float Radius, float HalfHeight, byte TraceChannel, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
System.Single	Radius
System.Single	HalfHeight
System.Byte	TraceChannel
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<HitResult>, System.Boolean>

Remarks

This trace finds the objects that RESPOND to the given TraceChannel

@param WorldContext World context @param Start Start of line segment. @param End End of line segment. @param Radius Radius of the capsule to sweep @param HalfHeight Distance from center of capsule to tip of hemisphere endcap. @param TraceChannel @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHits A list of hits, sorted along the trace from start to finish. The blocking hit will be the last hit, if there was one. @return True if there was a blocking hit, false otherwise.

CapsuleTraceMultiByProfile(UObject, Vector, Vector, Single, Single, Name, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Sweep a capsule against the world and return all initial overlaps using a specific profile, then overlapping hits and then first blocking hit Results are sorted, so a blocking hit (if found) will be the last element of the array Only the single closest blocking result will be generated, no tests will be done after that @

Declaration

public static (IReadOnlyCollection<HitResult>, bool) CapsuleTraceMultiByProfile(UObject WorldContextObject, Vector Start, Vector End, float Radius, float HalfHeight, Name ProfileName, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
System.Single	Radius
System.Single	HalfHeight
Name	ProfileName
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<HitResult>, System.Boolean>

Remarks

param WorldContext World context @param Start Start of line segment. @param End End of line segment. @param Radius Radius of the capsule to sweep @param HalfHeight Distance from center of capsule to tip of hemisphere endcap. @param ProfileName The 'profile' used to determine which components to hit @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHits A list of hits, sorted along the trace from start to finish. The blocking hit will be the last hit, if there was one. @return True if there was a blocking hit, false otherwise.

CapsuleTraceMultiForObjects(UObject, Vector, Vector, Single, Single, Byte, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Sweeps a capsule along the given line and returns all hits encountered.

Declaration

public static (IReadOnlyCollection<HitResult>, bool) CapsuleTraceMultiForObjects(UObject WorldContextObject, Vector Start, Vector End, float Radius, float HalfHeight, byte ObjectTypes, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
System.Single	Radius
System.Single	HalfHeight
System.Byte	ObjectTypes
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<HitResult>, System.Boolean>

Remarks

This only finds objects that are of a type specified by ObjectTypes.

@param WorldContext World context @param Start Start of line segment. @param End End of line segment. @param Radius Radius of the capsule to sweep @param HalfHeight Distance from center of capsule to tip of hemisphere endcap. @param ObjectTypes Array of Object Types to trace @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHits A list of hits, sorted along the trace from start to finish. The blocking hit will be the last hit, if there was one. @return True if there was a hit, false otherwise.

CapsuleTraceSingle(UObject, Vector, Vector, Single, Single, Byte, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Sweeps a capsule along the given line and returns the first blocking hit encountered.

Declaration

public static (HitResult, bool) CapsuleTraceSingle(UObject WorldContextObject, Vector Start, Vector End, float Radius, float HalfHeight, byte TraceChannel, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
System.Single	Radius
System.Single	HalfHeight
System.Byte	TraceChannel
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<HitResult, System.Boolean>

Remarks

This trace finds the objects that RESPOND to the given TraceChannel

@param WorldContext World context @param Start Start of line segment. @param End End of line segment. @param Radius Radius of the capsule to sweep @param HalfHeight Distance from center of capsule to tip of hemisphere endcap. @param TraceChannel @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHit Properties of the trace hit. @return True if there was a hit, false otherwise.

CapsuleTraceSingleByProfile(UObject, Vector, Vector, Single, Single, Name, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Sweep a capsule against the world and return the first blocking hit using a specific profile @

Declaration

public static (HitResult, bool) CapsuleTraceSingleByProfile(UObject WorldContextObject, Vector Start, Vector End, float Radius, float HalfHeight, Name ProfileName, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
System.Single	Radius
System.Single	HalfHeight
Name	ProfileName
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<HitResult, System.Boolean>

Remarks

param WorldContext World context @param Start Start of line segment. @param End End of line segment. @param Radius Radius of the capsule to sweep @param HalfHeight Distance from center of capsule to tip of hemisphere endcap. @param ProfileName The 'profile' used to determine which components to hit @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHit Properties of the trace hit. @return True if there was a hit, false otherwise.

CapsuleTraceSingleForObjects(UObject, Vector, Vector, Single, Single, Byte, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Sweeps a capsule along the given line and returns the first hit encountered.

Declaration

public static (HitResult, bool) CapsuleTraceSingleForObjects(UObject WorldContextObject, Vector Start, Vector End, float Radius, float HalfHeight, byte ObjectTypes, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
System.Single	Radius
System.Single	HalfHeight
System.Byte	ObjectTypes
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<HitResult, System.Boolean>

Remarks

This only finds objects that are of a type specified by ObjectTypes.

@param WorldContext World context @param Start Start of line segment. @param End End of line segment. @param Radius Radius of the capsule to sweep @param HalfHeight Distance from center of capsule to tip of hemisphere endcap. @param ObjectTypes Array of Object Types to trace @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHit Properties of the trace hit. @return True if there was a hit, false otherwise.

CollectGarbage()

Deletes all unreferenced objects, keeping only referenced objects (this command will be queued and happen at the end of the frame)

Declaration

public static void CollectGarbage()

Remarks

Note: This can be a slow operation, and should only be performed where a hitch would be acceptable

ComponentOverlapActors(PrimitiveComponent, Transform, Byte, SubclassOf<UObject>, Byte)

Returns an array of actors that overlap the given component.

Declaration

public static (IReadOnlyCollection<Actor>, bool) ComponentOverlapActors(PrimitiveComponent Component, Transform ComponentTransform, byte ObjectTypes, SubclassOf<UObject> ActorClassFilter, byte ActorsToIgnore)

Parameters

Type	Name	Description
PrimitiveComponent	Component
Transform	ComponentTransform
System.Byte	ObjectTypes
SubclassOf<UObject>	ActorClassFilter
System.Byte	ActorsToIgnore

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<Actor>, System.Boolean>

Remarks

@param Component Component to test with. @param ComponentTransform Defines where to place the component for overlap testing. @param Filter Option to restrict results to only static or only dynamic. For efficiency. @param ClassFilter If set, will only return results of this class or subclasses of it. @param ActorsToIgnore Ignore these actors in the list @param OutActors Returned array of actors. Unsorted. @return true if there was an overlap that passed the filters, false otherwise.

ComponentOverlapComponents(PrimitiveComponent, Transform, Byte, SubclassOf<UObject>, Byte)

Returns an array of components that overlap the given component.

Declaration

public static (IReadOnlyCollection<PrimitiveComponent>, bool) ComponentOverlapComponents(PrimitiveComponent Component, Transform ComponentTransform, byte ObjectTypes, SubclassOf<UObject> ComponentClassFilter, byte ActorsToIgnore)

Parameters

Type	Name	Description
PrimitiveComponent	Component
Transform	ComponentTransform
System.Byte	ObjectTypes
SubclassOf<UObject>	ComponentClassFilter
System.Byte	ActorsToIgnore

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<PrimitiveComponent>, System.Boolean>

Remarks

@param Component Component to test with. @param ComponentTransform Defines where to place the component for overlap testing. @param Filter Option to restrict results to only static or only dynamic. For efficiency. @param ClassFilter If set, will only return results of this class or subclasses of it. @param ActorsToIgnore Ignore these actors in the list @param OutActors Returned array of actors. Unsorted. @return true if there was an overlap that passed the filters, false otherwise.

ControlScreensaver(Boolean)

Allows or inhibits screensaver @

Declaration

public static void ControlScreensaver(bool bAllowScreenSaver)

Parameters

Type	Name	Description
System.Boolean	bAllowScreenSaver

Remarks

param bAllowScreenSaver If false, don't allow screensaver if possible, otherwise allow default behavior

Conv_ClassToSoftClassReference(SubclassOf<UObject>)

Conv Class to Soft Class Reference

Declaration

public static byte Conv_ClassToSoftClassReference(SubclassOf<UObject> Class)

Parameters

Type	Name	Description
SubclassOf<UObject>	Class

Returns

Type	Description
System.Byte

Conv_InterfaceToObject(Byte)

Converts an interfance into an object

Declaration

public static UObject Conv_InterfaceToObject(byte Interface)

Parameters

Type	Name	Description
System.Byte	Interface

Returns

Type	Description
UObject

Conv_ObjectToSoftObjectReference(UObject)

Conv Object to Soft Object Reference

Declaration

public static byte Conv_ObjectToSoftObjectReference(UObject UObject)

Parameters

Type	Name	Description
UObject	UObject

Returns

Type	Description
System.Byte

Conv_PrimaryAssetIdToString(PrimaryAssetId)

Converts a Primary Asset Id to a string. The other direction is not provided because it cannot be validated

Declaration

public static string Conv_PrimaryAssetIdToString(PrimaryAssetId PrimaryAssetId)

Parameters

Type	Name	Description
PrimaryAssetId	PrimaryAssetId

Returns

Type	Description
System.String

Conv_PrimaryAssetTypeToString(PrimaryAssetType)

Converts a Primary Asset Type to a string. The other direction is not provided because it cannot be validated

Declaration

public static string Conv_PrimaryAssetTypeToString(PrimaryAssetType PrimaryAssetType)

Parameters

Type	Name	Description
PrimaryAssetType	PrimaryAssetType

Returns

Type	Description
System.String

Conv_SoftClassReferenceToClass(Byte)

Conv Soft Class Reference to Class

Declaration

public static SubclassOf<UObject> Conv_SoftClassReferenceToClass(byte SoftClass)

Parameters

Type	Name	Description
System.Byte	SoftClass

Returns

Type	Description
SubclassOf<UObject>

Conv_SoftClassReferenceToString(Byte)

Converts a Soft Class Reference to a string. The other direction is not provided because it cannot be validated

Declaration

public static string Conv_SoftClassReferenceToString(byte SoftClassReference)

Parameters

Type	Name	Description
System.Byte	SoftClassReference

Returns

Type	Description
System.String

Conv_SoftObjectReferenceToObject(Byte)

Conv Soft Object Reference to Object

Declaration

public static UObject Conv_SoftObjectReferenceToObject(byte SoftObject)

Parameters

Type	Name	Description
System.Byte	SoftObject

Returns

Type	Description
UObject

Conv_SoftObjectReferenceToString(Byte)

Converts a Soft Object Reference to a string. The other direction is not provided because it cannot be validated

Declaration

public static string Conv_SoftObjectReferenceToString(byte SoftObjectReference)

Parameters

Type	Name	Description
System.Byte	SoftObjectReference

Returns

Type	Description
System.String

ConvertToAbsolutePath(String)

Converts passed in filename to use a absolute path

Declaration

public static string ConvertToAbsolutePath(string Filename)

Parameters

Type	Name	Description
System.String	Filename

Returns

Type	Description
System.String

ConvertToRelativePath(String)

Converts passed in filename to use a relative path

Declaration

public static string ConvertToRelativePath(string Filename)

Parameters

Type	Name	Description
System.String	Filename

Returns

Type	Description
System.String

CreateCopyForUndoBuffer(UObject)

Mark as modified.

Declaration

public static void CreateCopyForUndoBuffer(UObject ObjectToModify)

Parameters

Type	Name	Description
UObject	ObjectToModify

Delay(UObject, Single, LatentActionInfo)

Perform a latent action with a delay (specified in seconds).

Declaration

public static void Delay(UObject WorldContextObject, float Duration, LatentActionInfo LatentInfo)

Parameters

Type	Name	Description
UObject	WorldContextObject
System.Single	Duration
LatentActionInfo	LatentInfo

Remarks

Calling again while it is counting down will be ignored.

@param WorldContext World context. @param Duration length of delay (in seconds). @param LatentInfo The latent action.

DoesImplementInterface(UObject, SubclassOf<Interface>)

Does Implement Interface

Declaration

public static bool DoesImplementInterface(UObject TestObject, SubclassOf<Interface> Interface)

Parameters

Type	Name	Description
UObject	TestObject
SubclassOf<Interface>	Interface

Returns

Type	Description
System.Boolean

DrawDebugArrow(UObject, Vector, Vector, Single, LinearColor, Single, Single)

Draw directional arrow, pointing from LineStart to LineEnd.

Declaration

public static void DrawDebugArrow(UObject WorldContextObject, Vector LineStart, Vector LineEnd, float ArrowSize, LinearColor LineColor, float Duration, float Thickness)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	LineStart
Vector	LineEnd
System.Single	ArrowSize
LinearColor	LineColor
System.Single	Duration
System.Single	Thickness

DrawDebugBox(UObject, Vector, Vector, LinearColor, Rotator, Single, Single)

Draw a debug box

Declaration

public static void DrawDebugBox(UObject WorldContextObject, Vector Center, Vector Extent, LinearColor LineColor, Rotator Rotation, float Duration, float Thickness)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Center
Vector	Extent
LinearColor	LineColor
Rotator	Rotation
System.Single	Duration
System.Single	Thickness

DrawDebugCamera(CameraActor, LinearColor, Single)

Draw a debug camera shape.

Declaration

public static void DrawDebugCamera(CameraActor CameraActor, LinearColor CameraColor, float Duration)

Parameters

Type	Name	Description
CameraActor	CameraActor
LinearColor	CameraColor
System.Single	Duration

DrawDebugCapsule(UObject, Vector, Single, Single, Rotator, LinearColor, Single, Single)

Draw a debug capsule

Declaration

public static void DrawDebugCapsule(UObject WorldContextObject, Vector Center, float HalfHeight, float Radius, Rotator Rotation, LinearColor LineColor, float Duration, float Thickness)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Center
System.Single	HalfHeight
System.Single	Radius
Rotator	Rotation
LinearColor	LineColor
System.Single	Duration
System.Single	Thickness

DrawDebugCircle(UObject, Vector, Single, Int32, LinearColor, Single, Single, Vector, Vector, Boolean)

Draw a debug circle!

Declaration

public static void DrawDebugCircle(UObject WorldContextObject, Vector Center, float Radius, int NumSegments, LinearColor LineColor, float Duration, float Thickness, Vector YAxis, Vector ZAxis, bool bDrawAxis)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Center
System.Single	Radius
System.Int32	NumSegments
LinearColor	LineColor
System.Single	Duration
System.Single	Thickness
Vector	YAxis
Vector	ZAxis
System.Boolean	bDrawAxis

DrawDebugCone(UObject, Vector, Vector, Single, Single, Single, Int32, LinearColor, Single, Single)

Draw a debug cone

Declaration

public static void DrawDebugCone(UObject WorldContextObject, Vector Origin, Vector Direction, float Length, float AngleWidth, float AngleHeight, int NumSides, LinearColor LineColor, float Duration, float Thickness)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Origin
Vector	Direction
System.Single	Length
System.Single	AngleWidth
System.Single	AngleHeight
System.Int32	NumSides
LinearColor	LineColor
System.Single	Duration
System.Single	Thickness

DrawDebugConeInDegrees(UObject, Vector, Vector, Single, Single, Single, Int32, LinearColor, Single, Single)

Draw a debug cone

Declaration

public static void DrawDebugConeInDegrees(UObject WorldContextObject, Vector Origin, Vector Direction, float Length, float AngleWidth, float AngleHeight, int NumSides, LinearColor LineColor, float Duration, float Thickness)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Origin
Vector	Direction
System.Single	Length
System.Single	AngleWidth
System.Single	AngleHeight
System.Int32	NumSides
LinearColor	LineColor
System.Single	Duration
System.Single	Thickness

Remarks

Angles are specified in degrees

DrawDebugCoordinateSystem(UObject, Vector, Rotator, Single, Single, Single)

Draw a debug coordinate system.

Declaration

public static void DrawDebugCoordinateSystem(UObject WorldContextObject, Vector AxisLoc, Rotator AxisRot, float Scale, float Duration, float Thickness)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	AxisLoc
Rotator	AxisRot
System.Single	Scale
System.Single	Duration
System.Single	Thickness

DrawDebugCylinder(UObject, Vector, Vector, Single, Int32, LinearColor, Single, Single)

Draw a debug cylinder

Declaration

public static void DrawDebugCylinder(UObject WorldContextObject, Vector Start, Vector End, float Radius, int Segments, LinearColor LineColor, float Duration, float Thickness)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
System.Single	Radius
System.Int32	Segments
LinearColor	LineColor
System.Single	Duration
System.Single	Thickness

DrawDebugFloatHistoryLocation(UObject, DebugFloatHistory, Vector, Vector2D, LinearColor, Single)

Draws a 2D Histogram of size 'DrawSize' based FDebugFloatHistory struct, using DrawLocation for the location in the world, rotation will face camera of first player.

Declaration

public static void DrawDebugFloatHistoryLocation(UObject WorldContextObject, DebugFloatHistory FloatHistory, Vector DrawLocation, Vector2D DrawSize, LinearColor DrawColor, float Duration)

Parameters

Type	Name	Description
UObject	WorldContextObject
DebugFloatHistory	FloatHistory
Vector	DrawLocation
Vector2D	DrawSize
LinearColor	DrawColor
System.Single	Duration

DrawDebugFloatHistoryTransform(UObject, DebugFloatHistory, Transform, Vector2D, LinearColor, Single)

Draws a 2D Histogram of size 'DrawSize' based FDebugFloatHistory struct, using DrawTransform for the position in the world.

Declaration

public static void DrawDebugFloatHistoryTransform(UObject WorldContextObject, DebugFloatHistory FloatHistory, Transform DrawTransform, Vector2D DrawSize, LinearColor DrawColor, float Duration)

Parameters

Type	Name	Description
UObject	WorldContextObject
DebugFloatHistory	FloatHistory
Transform	DrawTransform
Vector2D	DrawSize
LinearColor	DrawColor
System.Single	Duration

DrawDebugFrustum(UObject, Transform, LinearColor, Single, Single)

Draws a debug frustum.

Declaration

public static void DrawDebugFrustum(UObject WorldContextObject, Transform FrustumTransform, LinearColor FrustumColor, float Duration, float Thickness)

Parameters

Type	Name	Description
UObject	WorldContextObject
Transform	FrustumTransform
LinearColor	FrustumColor
System.Single	Duration
System.Single	Thickness

DrawDebugLine(UObject, Vector, Vector, LinearColor, Single, Single)

Draw a debug line

Declaration

public static void DrawDebugLine(UObject WorldContextObject, Vector LineStart, Vector LineEnd, LinearColor LineColor, float Duration, float Thickness)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	LineStart
Vector	LineEnd
LinearColor	LineColor
System.Single	Duration
System.Single	Thickness

DrawDebugPlane(UObject, Plane, Vector, Single, LinearColor, Single)

Draws a debug plane.

Declaration

public static void DrawDebugPlane(UObject WorldContextObject, Plane PlaneCoordinates, Vector Location, float Size, LinearColor PlaneColor, float Duration)

Parameters

Type	Name	Description
UObject	WorldContextObject
Plane	PlaneCoordinates
Vector	Location
System.Single	Size
LinearColor	PlaneColor
System.Single	Duration

DrawDebugPoint(UObject, Vector, Single, LinearColor, Single)

Draw a debug point

Declaration

public static void DrawDebugPoint(UObject WorldContextObject, Vector Position, float Size, LinearColor PointColor, float Duration)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Position
System.Single	Size
LinearColor	PointColor
System.Single	Duration

DrawDebugSphere(UObject, Vector, Single, Int32, LinearColor, Single, Single)

Draw a debug sphere

Declaration

public static void DrawDebugSphere(UObject WorldContextObject, Vector Center, float Radius, int Segments, LinearColor LineColor, float Duration, float Thickness)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Center
System.Single	Radius
System.Int32	Segments
LinearColor	LineColor
System.Single	Duration
System.Single	Thickness

DrawDebugString(UObject, Vector, String, Actor, LinearColor, Single)

Draw a debug string at a 3d world location.

Declaration

public static void DrawDebugString(UObject WorldContextObject, Vector TextLocation, string Text, Actor TestBaseActor, LinearColor TextColor, float Duration)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	TextLocation
System.String	Text
Actor	TestBaseActor
LinearColor	TextColor
System.Single	Duration

EndTransaction()

Attempt to end the current undo transaction.

Declaration

public static int EndTransaction()

Returns

Type	Description
System.Int32

Remarks

Only successful if the transaction's action counter is 1. @note Only available in the editor.

@return The number of active actions when EndTransaction was called (a value of 1 indicates that the transaction was successfully closed), or -1 on failure.

EqualEqual_PrimaryAssetId(PrimaryAssetId, PrimaryAssetId)

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

Declaration

public static bool EqualEqual_PrimaryAssetId(PrimaryAssetId A, PrimaryAssetId B)

Parameters

Type	Name	Description
PrimaryAssetId	A
PrimaryAssetId	B

Returns

Type	Description
System.Boolean

EqualEqual_PrimaryAssetType(PrimaryAssetType, PrimaryAssetType)

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

Declaration

public static bool EqualEqual_PrimaryAssetType(PrimaryAssetType A, PrimaryAssetType B)

Parameters

Type	Name	Description
PrimaryAssetType	A
PrimaryAssetType	B

Returns

Type	Description
System.Boolean

EqualEqual_SoftClassReference(Byte, Byte)

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

Declaration

public static bool EqualEqual_SoftClassReference(byte A, byte B)

Parameters

Type	Name	Description
System.Byte	A
System.Byte	B

Returns

Type	Description
System.Boolean

EqualEqual_SoftObjectReference(Byte, Byte)

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

Declaration

public static bool EqualEqual_SoftObjectReference(byte A, byte B)

Parameters

Type	Name	Description
System.Byte	A
System.Byte	B

Returns

Type	Description
System.Boolean

ExecuteConsoleCommand(UObject, String, PlayerController)

Executes a console command, optionally on a specific controller @

Declaration

public static void ExecuteConsoleCommand(UObject WorldContextObject, string Command, PlayerController SpecificPlayer)

Parameters

Type	Name	Description
UObject	WorldContextObject
System.String	Command
PlayerController	SpecificPlayer

Remarks

param Command Command to send to the console @param SpecificPlayer If specified, the console command will be routed through the specified player

FlushDebugStrings(UObject)

Removes all debug strings.

Declaration

public static void FlushDebugStrings(UObject WorldContextObject)

Parameters

Type	Name	Description
UObject	WorldContextObject

Remarks

@param WorldContext World context

FlushPersistentDebugLines(UObject)

Flush all persistent debug lines and shapes.

Declaration

public static void FlushPersistentDebugLines(UObject WorldContextObject)

Parameters

Type	Name	Description
UObject	WorldContextObject

Remarks

@param WorldContext World context

ForceCloseAdBanner()

Forces closed any displayed ad.

Declaration

public static void ForceCloseAdBanner()

Remarks

Can lead to loss of revenue (iOS and Android only)

GetActorBounds(Actor)

Get Actor Bounds

Declaration

public static (Vector, Vector) GetActorBounds(Actor Actor)

Parameters

Type	Name	Description
Actor	Actor

Returns

Type	Description
System.ValueTuple<Vector, Vector>

GetActorListFromComponentList(Byte, SubclassOf<UObject>)

Returns an array of unique actors represented by the given list of components.

Declaration

public static IReadOnlyCollection<Actor> GetActorListFromComponentList(byte ComponentList, SubclassOf<UObject> ActorClassFilter)

Parameters

Type	Name	Description
System.Byte	ComponentList
SubclassOf<UObject>	ActorClassFilter

Returns

Type	Description
System.Collections.Generic.IReadOnlyCollection<Actor>

Remarks

@param ComponentList List of components. @param ClassFilter If set, will only return results of this class or subclasses of it. @param OutActorList Start of line segment.

GetAdIDCount()

Retrieves the total number of Ad IDs that can be selected between

Declaration

public static int GetAdIDCount()

Returns

Type	Description
System.Int32

GetClassDisplayName(SubclassOf<UObject>)

Returns the display name of a class

Declaration

public static string GetClassDisplayName(SubclassOf<UObject> Class)

Parameters

Type	Name	Description
SubclassOf<UObject>	Class

Returns

Type	Description
System.String

GetClassFromPrimaryAssetId(PrimaryAssetId)

Returns the Blueprint Class associated with a Primary Asset Id, this will only return a valid object if it is in memory, it will not load it

Declaration

public static SubclassOf<UObject> GetClassFromPrimaryAssetId(PrimaryAssetId PrimaryAssetId)

Parameters

Type	Name	Description
PrimaryAssetId	PrimaryAssetId

Returns

Type	Description
SubclassOf<UObject>

GetCommandLine()

Returns the command line that the process was launched with.

Declaration

public static string GetCommandLine()

Returns

Type	Description
System.String

GetComponentBounds(SceneComponent)

Get bounds

Declaration

public static (Vector, Vector, float) GetComponentBounds(SceneComponent Component)

Parameters

Type	Name	Description
SceneComponent	Component

Returns

Type	Description
System.ValueTuple<Vector, Vector, System.Single>

GetConsoleVariableFloatValue(UObject, String)

Attempts to retrieve the value of the specified float console variable, if it exists.

Declaration

public static float GetConsoleVariableFloatValue(UObject WorldContextObject, string VariableName)

Parameters

Type	Name	Description
UObject	WorldContextObject
System.String	VariableName

Returns

Type	Description
System.Single

Remarks

@param VariableName Name of the console variable to find. @return The value if found, 0 otherwise.

GetConsoleVariableIntValue(UObject, String)

Attempts to retrieve the value of the specified integer console variable, if it exists.

Declaration

public static int GetConsoleVariableIntValue(UObject WorldContextObject, string VariableName)

Parameters

Type	Name	Description
UObject	WorldContextObject
System.String	VariableName

Returns

Type	Description
System.Int32

Remarks

@param VariableName Name of the console variable to find. @return The value if found, 0 otherwise.

GetConvenientWindowedResolutions()

Gets the list of windowed resolutions which are convenient for the current primary display size.

Declaration

public static (IReadOnlyCollection<IntPoint>, bool) GetConvenientWindowedResolutions()

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<IntPoint>, System.Boolean>

Remarks

@return true if successfully queried the device for available resolutions.

GetCurrentBundleState(PrimaryAssetId, Boolean)

Returns the list of loaded bundles for a given Primary Asset.

Declaration

public static (IReadOnlyCollection<Name>, bool) GetCurrentBundleState(PrimaryAssetId PrimaryAssetId, bool bForceCurrentState)

Parameters

Type	Name	Description
PrimaryAssetId	PrimaryAssetId
System.Boolean	bForceCurrentState

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<Name>, System.Boolean>

Remarks

This will return false if the asset is not loaded at all. If ForceCurrentState is true it will return the current state even if a load is in process

GetDefaultLanguage()

Get the default language (for localization) used by this platform @

Declaration

public static string GetDefaultLanguage()

Returns

Type	Description
System.String

Remarks

note This is typically the same as GetDefaultLocale unless the platform distinguishes between the two @note This should be returned in IETF language tag form:

• A two-letter ISO 639-1 language code (eg, "zh")
• An optional four-letter ISO 15924 script code (eg, "Hans")
• An optional two-letter ISO 3166-1 country code (eg, "CN") @return The language as an IETF language tag (eg, "zh-Hans-CN")

GetDefaultLocale()

Get the default locale (for internationalization) used by this platform @

Declaration

public static string GetDefaultLocale()

Returns

Type	Description
System.String

Remarks

note This should be returned in IETF language tag form:

• A two-letter ISO 639-1 language code (eg, "zh")
• An optional four-letter ISO 15924 script code (eg, "Hans")
• An optional two-letter ISO 3166-1 country code (eg, "CN") @return The locale as an IETF language tag (eg, "zh-Hans-CN")

GetDeviceId()

Returns the platform specific unique device id

Declaration

public static string GetDeviceId()

Returns

Type	Description
System.String

GetDisplayName(UObject)

Returns the display name (or actor label), for displaying as a debugging aid.

Declaration

public static string GetDisplayName(UObject UObject)

Parameters

Type	Name	Description
UObject	UObject

Returns

Type	Description
System.String

Remarks

Note: In editor builds, this is the actor label. In non-editor builds, this is the actual object name. This function should not be used to uniquely identify actors! It is not localized and should not be used for display to an end user of a game.

GetEngineVersion()

Engine build number, for displaying to end users.

Declaration

public static string GetEngineVersion()

Returns

Type	Description
System.String

GetGameBundleId()

Retrieves the game's platform-specific bundle identifier or package name of the game @

Declaration

public static string GetGameBundleId()

Returns

Type	Description
System.String

Remarks

return The game's bundle identifier or package name.

GetGameName()

Get the name of the current game

Declaration

public static string GetGameName()

Returns

Type	Description
System.String

GetGameTimeInSeconds(UObject)

Get the current game time, in seconds.

Declaration

public static float GetGameTimeInSeconds(UObject WorldContextObject)

Parameters

Type	Name	Description
UObject	WorldContextObject

Returns

Type	Description
System.Single

Remarks

This stops when the game is paused and is affected by slomo.

@param WorldContextObject World context

GetLocalCurrencyCode()

Returns the currency code associated with the device's locale @

Declaration

public static string GetLocalCurrencyCode()

Returns

Type	Description
System.String

Remarks

return the currency code associated with the device's locale

GetLocalCurrencySymbol()

Returns the currency symbol associated with the device's locale @

Declaration

public static string GetLocalCurrencySymbol()

Returns

Type	Description
System.String

Remarks

return the currency symbol associated with the device's locale

GetMinYResolutionFor3DView()

Gets the smallest Y resolution we want to support in the 3D view, clamped within reasons @

Declaration

public static int GetMinYResolutionFor3DView()

Returns

Type	Description
System.Int32

Remarks

return value in pixels

GetMinYResolutionForUI()

Gets the smallest Y resolution we want to support in the UI, clamped within reasons @

Declaration

public static int GetMinYResolutionForUI()

Returns

Type	Description
System.Int32

Remarks

return value in pixels

GetObjectFromPrimaryAssetId(PrimaryAssetId)

Returns the Object associated with a Primary Asset Id, this will only return a valid object if it is in memory, it will not load it

Declaration

public static UObject GetObjectFromPrimaryAssetId(PrimaryAssetId PrimaryAssetId)

Parameters

Type	Name	Description
PrimaryAssetId	PrimaryAssetId

Returns

Type	Description
UObject

GetObjectName(UObject)

Returns the actual object name.

Declaration

public static string GetObjectName(UObject UObject)

Parameters

Type	Name	Description
UObject	UObject

Returns

Type	Description
System.String

GetPathName(UObject)

Returns the full path to the specified object.

Declaration

public static string GetPathName(UObject UObject)

Parameters

Type	Name	Description
UObject	UObject

Returns

Type	Description
System.String

GetPlatformUserName()

Get the current user name from the OS

Declaration

public static string GetPlatformUserName()

Returns

Type	Description
System.String

GetPreferredLanguages()

Returns an array of the user's preferred languages in order of preference @

Declaration

public static IReadOnlyCollection<string> GetPreferredLanguages()

Returns

Type	Description
System.Collections.Generic.IReadOnlyCollection<System.String>

Remarks

return An array of language IDs ordered from most preferred to least

GetPrimaryAssetIdFromClass(SubclassOf<UObject>)

Returns the Primary Asset Id for a Class, this can return an invalid one if not registered

Declaration

public static PrimaryAssetId GetPrimaryAssetIdFromClass(SubclassOf<UObject> Class)

Parameters

Type	Name	Description
SubclassOf<UObject>	Class

Returns

Type	Description
PrimaryAssetId

GetPrimaryAssetIdFromObject(UObject)

Returns the Primary Asset Id for an Object, this can return an invalid one if not registered

Declaration

public static PrimaryAssetId GetPrimaryAssetIdFromObject(UObject UObject)

Parameters

Type	Name	Description
UObject	UObject

Returns

Type	Description
PrimaryAssetId

GetPrimaryAssetIdFromSoftClassReference(Byte)

Returns the Primary Asset Id for a Soft Class Reference, this can return an invalid one if not registered

Declaration

public static PrimaryAssetId GetPrimaryAssetIdFromSoftClassReference(byte SoftClassReference)

Parameters

Type	Name	Description
System.Byte	SoftClassReference

Returns

Type	Description
PrimaryAssetId

GetPrimaryAssetIdFromSoftObjectReference(Byte)

Returns the Primary Asset Id for a Soft Object Reference, this can return an invalid one if not registered

Declaration

public static PrimaryAssetId GetPrimaryAssetIdFromSoftObjectReference(byte SoftObjectReference)

Parameters

Type	Name	Description
System.Byte	SoftObjectReference

Returns

Type	Description
PrimaryAssetId

GetPrimaryAssetIdList(PrimaryAssetType)

Returns list of PrimaryAssetIds for a PrimaryAssetType

Declaration

public static IReadOnlyCollection<PrimaryAssetId> GetPrimaryAssetIdList(PrimaryAssetType PrimaryAssetType)

Parameters

Type	Name	Description
PrimaryAssetType	PrimaryAssetType

Returns

Type	Description
System.Collections.Generic.IReadOnlyCollection<PrimaryAssetId>

GetPrimaryAssetsWithBundleState(Byte, Byte, Byte, Boolean)

Returns the list of assets that are in a given bundle state.

Declaration

public static IReadOnlyCollection<PrimaryAssetId> GetPrimaryAssetsWithBundleState(byte RequiredBundles, byte ExcludedBundles, byte ValidTypes, bool bForceCurrentState)

Parameters

Type	Name	Description
System.Byte	RequiredBundles
System.Byte	ExcludedBundles
System.Byte	ValidTypes
System.Boolean	bForceCurrentState

Returns

Type	Description
System.Collections.Generic.IReadOnlyCollection<PrimaryAssetId>

Remarks

Required Bundles must be specified If ExcludedBundles is not empty, it will not return any assets in those bundle states If ValidTypes is not empty, it will only return assets of those types If ForceCurrentState is true it will use the current state even if a load is in process

GetProjectContentDirectory()

Get the content directory of the current project

Declaration

public static string GetProjectContentDirectory()

Returns

Type	Description
System.String

GetProjectDirectory()

Get the directory of the current project

Declaration

public static string GetProjectDirectory()

Returns

Type	Description
System.String

GetProjectSavedDirectory()

Get the saved directory of the current project

Declaration

public static string GetProjectSavedDirectory()

Returns

Type	Description
System.String

GetRenderingDetailMode()

Get the clamped state of r.

Declaration

public static int GetRenderingDetailMode()

Returns

Type	Description
System.Int32

Remarks

DetailMode, see console variable help (allows for scalability, cannot be used in construction scripts) 0: low, show only object with DetailMode low or higher 1: medium, show all object with DetailMode medium or higher 2: high, show all objects

GetRenderingMaterialQualityLevel()

Get the clamped state of r.

Declaration

public static int GetRenderingMaterialQualityLevel()

Returns

Type	Description
System.Int32

Remarks

MaterialQualityLevel, see console variable help (allows for scalability, cannot be used in construction scripts) 0: low 1: high 2: medium

GetSoftClassReferenceFromPrimaryAssetId(PrimaryAssetId)

Returns the Blueprint Class Id associated with a Primary Asset Id, this works even if the asset is not loaded

Declaration

public static byte GetSoftClassReferenceFromPrimaryAssetId(PrimaryAssetId PrimaryAssetId)

Parameters

Type	Name	Description
PrimaryAssetId	PrimaryAssetId

Returns

Type	Description
System.Byte

GetSoftObjectReferenceFromPrimaryAssetId(PrimaryAssetId)

Returns the Object Id associated with a Primary Asset Id, this works even if the asset is not loaded

Declaration

public static byte GetSoftObjectReferenceFromPrimaryAssetId(PrimaryAssetId PrimaryAssetId)

Parameters

Type	Name	Description
PrimaryAssetId	PrimaryAssetId

Returns

Type	Description
System.Byte

GetSupportedFullscreenResolutions()

Gets the list of support fullscreen resolutions.

Declaration

public static (IReadOnlyCollection<IntPoint>, bool) GetSupportedFullscreenResolutions()

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<IntPoint>, System.Boolean>

Remarks

@return true if successfully queried the device for available resolutions.

GetUniqueDeviceId()

Returns the platform specific unique device id

Declaration

public static string GetUniqueDeviceId()

Returns

Type	Description
System.String

GetVolumeButtonsHandledBySystem()

Returns true if system default handling of volume up and volume down buttons enabled (Android only)

Declaration

public static bool GetVolumeButtonsHandledBySystem()

Returns

Type	Description
System.Boolean

HideAdBanner()

Hides the ad banner (iAd on iOS, or AdMob on Android).

Declaration

public static void HideAdBanner()

Remarks

Will force close the ad if it's open (iOS and Android only)

IsControllerAssignedToGamepad(Int32)

Returns true if controller id assigned to a gamepad (Android only)

Declaration

public static bool IsControllerAssignedToGamepad(int ControllerId)

Parameters

Type	Name	Description
System.Int32	ControllerId

Returns

Type	Description
System.Boolean

IsDedicatedServer(UObject)

Returns whether this is running on a dedicated server

Declaration

public static bool IsDedicatedServer(UObject WorldContextObject)

Parameters

Type	Name	Description
UObject	WorldContextObject

Returns

Type	Description
System.Boolean

IsInterstitialAdAvailable()

Returns true if the requested interstitial ad is loaded and ready

Declaration

public static bool IsInterstitialAdAvailable()

Returns

Type	Description
System.Boolean

Remarks

(Android only)

IsInterstitialAdRequested()

Returns true if the requested interstitial ad has been successfully requested (false if load request fails)

Declaration

public static bool IsInterstitialAdRequested()

Returns

Type	Description
System.Boolean

Remarks

(Android only)

IsLoggedIn(PlayerController)

Returns whether the player is logged in to the currently active online subsystem.

Declaration

public static bool IsLoggedIn(PlayerController SpecificPlayer)

Parameters

Type	Name	Description
PlayerController	SpecificPlayer

Returns

Type	Description
System.Boolean

Remarks

@param Player Specific player's login status to get. May not be supported on all platforms. If null, defaults to the player with ControllerId 0.

IsPackagedForDistribution()

Returns whether this is a build that is packaged for distribution

Declaration

public static bool IsPackagedForDistribution()

Returns

Type	Description
System.Boolean

IsScreensaverEnabled()

Returns true if screen saver is enabled.

Declaration

public static bool IsScreensaverEnabled()

Returns

Type	Description
System.Boolean

IsServer(UObject)

Returns whether the world this object is in is the host or not

Declaration

public static bool IsServer(UObject WorldContextObject)

Parameters

Type	Name	Description
UObject	WorldContextObject

Returns

Type	Description
System.Boolean

IsStandalone(UObject)

Returns whether this game instance is stand alone (no networking).

Declaration

public static bool IsStandalone(UObject WorldContextObject)

Parameters

Type	Name	Description
UObject	WorldContextObject

Returns

Type	Description
System.Boolean

IsUnattended()

Returns true if running unattended (-unattended is on the command line) @

Declaration

public static bool IsUnattended()

Returns

Type	Description
System.Boolean

Remarks

return Unattended state

IsValid(UObject)

Return true if the object is usable : non-null and not pending kill

Declaration

public static bool IsValid(UObject UObject)

Parameters

Type	Name	Description
UObject	UObject

Returns

Type	Description
System.Boolean

IsValidClass(SubclassOf<UObject>)

Return true if the class is usable : non-null and not pending kill

Declaration

public static bool IsValidClass(SubclassOf<UObject> Class)

Parameters

Type	Name	Description
SubclassOf<UObject>	Class

Returns

Type	Description
System.Boolean

IsValidPrimaryAssetId(PrimaryAssetId)

Returns true if the Primary Asset Id is valid

Declaration

public static bool IsValidPrimaryAssetId(PrimaryAssetId PrimaryAssetId)

Parameters

Type	Name	Description
PrimaryAssetId	PrimaryAssetId

Returns

Type	Description
System.Boolean

IsValidPrimaryAssetType(PrimaryAssetType)

Returns list of Primary Asset Ids for a PrimaryAssetType

Declaration

public static bool IsValidPrimaryAssetType(PrimaryAssetType PrimaryAssetType)

Parameters

Type	Name	Description
PrimaryAssetType	PrimaryAssetType

Returns

Type	Description
System.Boolean

IsValidSoftClassReference(Byte)

Returns true if the Soft Class Reference is not null

Declaration

public static bool IsValidSoftClassReference(byte SoftClassReference)

Parameters

Type	Name	Description
System.Byte	SoftClassReference

Returns

Type	Description
System.Boolean

IsValidSoftObjectReference(Byte)

Returns true if the Soft Object Reference is not null

Declaration

public static bool IsValidSoftObjectReference(byte SoftObjectReference)

Parameters

Type	Name	Description
System.Byte	SoftObjectReference

Returns

Type	Description
System.Boolean

K2_ClearAndInvalidateTimerHandle(UObject, TimerHandle)

Clears a set timer.

Declaration

public static void K2_ClearAndInvalidateTimerHandle(UObject WorldContextObject, TimerHandle Handle)

Parameters

Type	Name	Description
UObject	WorldContextObject
TimerHandle	Handle

Remarks

@param Handle The handle of the timer to clear.

K2_ClearTimer(UObject, String)

Clears a set timer.

Declaration

public static void K2_ClearTimer(UObject UObject, string FunctionName)

Parameters

Type	Name	Description
UObject	UObject
System.String	FunctionName

Remarks

@param Object Object that implements the delegate function. Defaults to self (this blueprint) @param FunctionName Delegate function name. Can be a K2 function or a Custom Event.

K2_ClearTimerDelegate(Byte)

Clears a set timer.

Declaration

public static void K2_ClearTimerDelegate(byte Delegate)

Parameters

Type	Name	Description
System.Byte	Delegate

Remarks

@param Event Can be a K2 function or a Custom Event.

K2_ClearTimerHandle(UObject, TimerHandle)

Clears a set timer.

Declaration

public static void K2_ClearTimerHandle(UObject WorldContextObject, TimerHandle Handle)

Parameters

Type	Name	Description
UObject	WorldContextObject
TimerHandle	Handle

Remarks

@param Handle The handle of the timer to clear.

K2_GetTimerElapsedTime(UObject, String)

Returns elapsed time for the given delegate (time since current countdown iteration began).

Declaration

public static float K2_GetTimerElapsedTime(UObject UObject, string FunctionName)

Parameters

Type	Name	Description
UObject	UObject
System.String	FunctionName

Returns

Type	Description
System.Single

Remarks

@param Object Object that implements the delegate function. Defaults to self (this blueprint) @param FunctionName Delegate function name. Can be a K2 function or a Custom Event. @return How long has elapsed since the current iteration of the timer began.

K2_GetTimerElapsedTimeDelegate(Byte)

Returns elapsed time for the given delegate (time since current countdown iteration began).

Declaration

public static float K2_GetTimerElapsedTimeDelegate(byte Delegate)

Parameters

Type	Name	Description
System.Byte	Delegate

Returns

Type	Description
System.Single

Remarks

@param Event Can be a K2 function or a Custom Event. @return How long has elapsed since the current iteration of the timer began.

K2_GetTimerElapsedTimeHandle(UObject, TimerHandle)

Returns elapsed time for the given handle (time since current countdown iteration began).

Declaration

public static float K2_GetTimerElapsedTimeHandle(UObject WorldContextObject, TimerHandle Handle)

Parameters

Type	Name	Description
UObject	WorldContextObject
TimerHandle	Handle

Returns

Type	Description
System.Single

Remarks

@param Handle The handle of the timer to get the elapsed time of. @return How long has elapsed since the current iteration of the timer began.

K2_GetTimerRemainingTime(UObject, String)

Returns time until the timer will next execute its delegate.

Declaration

public static float K2_GetTimerRemainingTime(UObject UObject, string FunctionName)

Parameters

Type	Name	Description
UObject	UObject
System.String	FunctionName

Returns

Type	Description
System.Single

Remarks

@param Object Object that implements the delegate function. Defaults to self (this blueprint) @param FunctionName Delegate function name. Can be a K2 function or a Custom Event. @return How long is remaining in the current iteration of the timer.

K2_GetTimerRemainingTimeDelegate(Byte)

Returns time until the timer will next execute its delegate.

Declaration

public static float K2_GetTimerRemainingTimeDelegate(byte Delegate)

Parameters

Type	Name	Description
System.Byte	Delegate

Returns

Type	Description
System.Single

Remarks

@param Event Can be a K2 function or a Custom Event. @return How long is remaining in the current iteration of the timer.

K2_GetTimerRemainingTimeHandle(UObject, TimerHandle)

Returns time until the timer will next execute its handle.

Declaration

public static float K2_GetTimerRemainingTimeHandle(UObject WorldContextObject, TimerHandle Handle)

Parameters

Type	Name	Description
UObject	WorldContextObject
TimerHandle	Handle

Returns

Type	Description
System.Single

Remarks

@param Handle The handle of the timer to time remaining of. @return How long is remaining in the current iteration of the timer.

K2_InvalidateTimerHandle(TimerHandle)

Invalidate the supplied TimerHandle and return it.

Declaration

public static TimerHandle K2_InvalidateTimerHandle(TimerHandle Handle)

Parameters

Type	Name	Description
TimerHandle	Handle

Returns

Type	Description
TimerHandle

Remarks

@param Handle The handle of the timer to invalidate. @return Return the invalidated timer handle for convenience.

K2_IsTimerActive(UObject, String)

Returns true if a timer exists and is active for the given delegate, false otherwise.

Declaration

public static bool K2_IsTimerActive(UObject UObject, string FunctionName)

Parameters

Type	Name	Description
UObject	UObject
System.String	FunctionName

Returns

Type	Description
System.Boolean

Remarks

@param Object Object that implements the delegate function. Defaults to self (this blueprint) @param FunctionName Delegate function name. Can be a K2 function or a Custom Event. @return True if the timer exists and is active.

K2_IsTimerActiveDelegate(Byte)

Returns true if a timer exists and is active for the given delegate, false otherwise.

Declaration

public static bool K2_IsTimerActiveDelegate(byte Delegate)

Parameters

Type	Name	Description
System.Byte	Delegate

Returns

Type	Description
System.Boolean

Remarks

@param Event Can be a K2 function or a Custom Event. @return True if the timer exists and is active.

K2_IsTimerActiveHandle(UObject, TimerHandle)

Returns true if a timer exists and is active for the given handle, false otherwise.

Declaration

public static bool K2_IsTimerActiveHandle(UObject WorldContextObject, TimerHandle Handle)

Parameters

Type	Name	Description
UObject	WorldContextObject
TimerHandle	Handle

Returns

Type	Description
System.Boolean

Remarks

@param Handle The handle of the timer to check whether it is active. @return True if the timer exists and is active.

K2_IsTimerPaused(UObject, String)

Returns true if a timer exists and is paused for the given delegate, false otherwise.

Declaration

public static bool K2_IsTimerPaused(UObject UObject, string FunctionName)

Parameters

Type	Name	Description
UObject	UObject
System.String	FunctionName

Returns

Type	Description
System.Boolean

Remarks

@param Object Object that implements the delegate function. Defaults to self (this blueprint) @param FunctionName Delegate function name. Can be a K2 function or a Custom Event. @return True if the timer exists and is paused.

K2_IsTimerPausedDelegate(Byte)

Returns true if a timer exists and is paused for the given delegate, false otherwise.

Declaration

public static bool K2_IsTimerPausedDelegate(byte Delegate)

Parameters

Type	Name	Description
System.Byte	Delegate

Returns

Type	Description
System.Boolean

Remarks

@param Event Can be a K2 function or a Custom Event. @return True if the timer exists and is paused.

K2_IsTimerPausedHandle(UObject, TimerHandle)

Returns true if a timer exists and is paused for the given handle, false otherwise.

Declaration

public static bool K2_IsTimerPausedHandle(UObject WorldContextObject, TimerHandle Handle)

Parameters

Type	Name	Description
UObject	WorldContextObject
TimerHandle	Handle

Returns

Type	Description
System.Boolean

Remarks

@param Handle The handle of the timer to check whether it is paused. @return True if the timer exists and is paused.

K2_IsValidTimerHandle(TimerHandle)

Returns whether the timer handle is valid.

Declaration

public static bool K2_IsValidTimerHandle(TimerHandle Handle)

Parameters

Type	Name	Description
TimerHandle	Handle

Returns

Type	Description
System.Boolean

Remarks

This does not indicate that there is an active timer that this handle references, but rather that it once referenced a valid timer. @param Handle The handle of the timer to check validity of. @return Whether the timer handle is valid.

K2_PauseTimer(UObject, String)

Pauses a set timer at its current elapsed time.

Declaration

public static void K2_PauseTimer(UObject UObject, string FunctionName)

Parameters

Type	Name	Description
UObject	UObject
System.String	FunctionName

Remarks

@param Object Object that implements the delegate function. Defaults to self (this blueprint) @param FunctionName Delegate function name. Can be a K2 function or a Custom Event.

K2_PauseTimerDelegate(Byte)

Pauses a set timer at its current elapsed time.

Declaration

public static void K2_PauseTimerDelegate(byte Delegate)

Parameters

Type	Name	Description
System.Byte	Delegate

Remarks

@param Event Can be a K2 function or a Custom Event.

K2_PauseTimerHandle(UObject, TimerHandle)

Pauses a set timer at its current elapsed time.

Declaration

public static void K2_PauseTimerHandle(UObject WorldContextObject, TimerHandle Handle)

Parameters

Type	Name	Description
UObject	WorldContextObject
TimerHandle	Handle

Remarks

@param Handle The handle of the timer to pause.

K2_SetTimer(UObject, String, Single, Boolean)

Declaration

public static TimerHandle K2_SetTimer(UObject UObject, string FunctionName, float Time, bool bLooping)

Parameters

Type	Name	Description
UObject	UObject
System.String	FunctionName
System.Single	Time
System.Boolean	bLooping

Returns

Type	Description
TimerHandle

K2_SetTimerDelegate(Byte, Single, Boolean)

Declaration

public static TimerHandle K2_SetTimerDelegate(byte Delegate, float Time, bool bLooping)

Parameters

Type	Name	Description
System.Byte	Delegate
System.Single	Time
System.Boolean	bLooping

Returns

Type	Description
TimerHandle

K2_TimerExists(UObject, String)

Returns true is a timer for the given delegate exists, false otherwise.

Declaration

public static bool K2_TimerExists(UObject UObject, string FunctionName)

Parameters

Type	Name	Description
UObject	UObject
System.String	FunctionName

Returns

Type	Description
System.Boolean

Remarks

@param Object Object that implements the delegate function. Defaults to self (this blueprint) @param FunctionName Delegate function name. Can be a K2 function or a Custom Event. @return True if the timer exists.

K2_TimerExistsDelegate(Byte)

Returns true is a timer for the given delegate exists, false otherwise.

Declaration

public static bool K2_TimerExistsDelegate(byte Delegate)

Parameters

Type	Name	Description
System.Byte	Delegate

Returns

Type	Description
System.Boolean

Remarks

@param Event Can be a K2 function or a Custom Event. @return True if the timer exists.

K2_TimerExistsHandle(UObject, TimerHandle)

Returns true is a timer for the given handle exists, false otherwise.

Declaration

public static bool K2_TimerExistsHandle(UObject WorldContextObject, TimerHandle Handle)

Parameters

Type	Name	Description
UObject	WorldContextObject
TimerHandle	Handle

Returns

Type	Description
System.Boolean

Remarks

@param Handle The handle to check whether it exists. @return True if the timer exists.

K2_UnPauseTimer(UObject, String)

Resumes a paused timer from its current elapsed time.

Declaration

public static void K2_UnPauseTimer(UObject UObject, string FunctionName)

Parameters

Type	Name	Description
UObject	UObject
System.String	FunctionName

Remarks

@param Object Object that implements the delegate function. Defaults to self (this blueprint) @param FunctionName Delegate function name. Can be a K2 function or a Custom Event.

K2_UnPauseTimerDelegate(Byte)

Resumes a paused timer from its current elapsed time.

Declaration

public static void K2_UnPauseTimerDelegate(byte Delegate)

Parameters

Type	Name	Description
System.Byte	Delegate

Remarks

@param Event Can be a K2 function or a Custom Event.

K2_UnPauseTimerHandle(UObject, TimerHandle)

Resumes a paused timer from its current elapsed time.

Declaration

public static void K2_UnPauseTimerHandle(UObject WorldContextObject, TimerHandle Handle)

Parameters

Type	Name	Description
UObject	WorldContextObject
TimerHandle	Handle

Remarks

@param Handle The handle of the timer to unpause.

LaunchURL(String)

Opens the specified URL in the platform's web browser of choice

Declaration

public static void LaunchURL(string URL)

Parameters

Type	Name	Description
System.String	URL

LineTraceMulti(UObject, Vector, Vector, Byte, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Does a collision trace along the given line and returns all hits encountered up to and including the first blocking hit.

Declaration

public static (IReadOnlyCollection<HitResult>, bool) LineTraceMulti(UObject WorldContextObject, Vector Start, Vector End, byte TraceChannel, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
System.Byte	TraceChannel
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<HitResult>, System.Boolean>

Remarks

This trace finds the objects that RESPOND to the given TraceChannel

@param WorldContext World context @param Start Start of line segment. @param End End of line segment. @param TraceChannel The channel to trace @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHit Properties of the trace hit. @return True if there was a blocking hit, false otherwise.

LineTraceMultiByProfile(UObject, Vector, Vector, Name, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Trace a ray against the world using a specific profile and return overlapping hits and then first blocking hit Results are sorted, so a blocking hit (if found) will be the last element of the array Only the single closest blocking result will be generated, no tests will be done after that @

Declaration

public static (IReadOnlyCollection<HitResult>, bool) LineTraceMultiByProfile(UObject WorldContextObject, Vector Start, Vector End, Name ProfileName, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
Name	ProfileName
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<HitResult>, System.Boolean>

Remarks

param WorldContext World context @param Start Start of line segment. @param End End of line segment. @param ProfileName The 'profile' used to determine which components to hit @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHit Properties of the trace hit. @return True if there was a blocking hit, false otherwise.

LineTraceMultiForObjects(UObject, Vector, Vector, Byte, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Does a collision trace along the given line and returns all hits encountered.

Declaration

public static (IReadOnlyCollection<HitResult>, bool) LineTraceMultiForObjects(UObject WorldContextObject, Vector Start, Vector End, byte ObjectTypes, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
System.Byte	ObjectTypes
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<HitResult>, System.Boolean>

Remarks

This only finds objects that are of a type specified by ObjectTypes.

@param WorldContext World context @param Start Start of line segment. @param End End of line segment. @param ObjectTypes Array of Object Types to trace @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHit Properties of the trace hit. @return True if there was a hit, false otherwise.

LineTraceSingle(UObject, Vector, Vector, Byte, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Does a collision trace along the given line and returns the first blocking hit encountered.

Declaration

public static (HitResult, bool) LineTraceSingle(UObject WorldContextObject, Vector Start, Vector End, byte TraceChannel, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
System.Byte	TraceChannel
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<HitResult, System.Boolean>

Remarks

This trace finds the objects that RESPONDS to the given TraceChannel

@param WorldContext World context @param Start Start of line segment. @param End End of line segment. @param TraceChannel @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHit Properties of the trace hit. @return True if there was a hit, false otherwise.

LineTraceSingleByProfile(UObject, Vector, Vector, Name, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Trace a ray against the world using a specific profile and return the first blocking hit @

Declaration

public static (HitResult, bool) LineTraceSingleByProfile(UObject WorldContextObject, Vector Start, Vector End, Name ProfileName, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
Name	ProfileName
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<HitResult, System.Boolean>

Remarks

param WorldContext World context @param Start Start of line segment. @param End End of line segment. @param ProfileName The 'profile' used to determine which components to hit @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHit Properties of the trace hit. @return True if there was a hit, false otherwise.

LineTraceSingleForObjects(UObject, Vector, Vector, Byte, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Does a collision trace along the given line and returns the first hit encountered.

Declaration

public static (HitResult, bool) LineTraceSingleForObjects(UObject WorldContextObject, Vector Start, Vector End, byte ObjectTypes, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
System.Byte	ObjectTypes
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<HitResult, System.Boolean>

Remarks

This only finds objects that are of a type specified by ObjectTypes.

@param WorldContext World context @param Start Start of line segment. @param End End of line segment. @param ObjectTypes Array of Object Types to trace @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHit Properties of the trace hit. @return True if there was a hit, false otherwise.

LoadAsset(UObject, Byte, Byte, LatentActionInfo)

Load Asset

Declaration

public static void LoadAsset(UObject WorldContextObject, byte Asset, byte OnLoaded, LatentActionInfo LatentInfo)

Parameters

Type	Name	Description
UObject	WorldContextObject
System.Byte	Asset
System.Byte	OnLoaded
LatentActionInfo	LatentInfo

LoadAssetClass(UObject, Byte, Byte, LatentActionInfo)

Load Asset Class

Declaration

public static void LoadAssetClass(UObject WorldContextObject, byte AssetClass, byte OnLoaded, LatentActionInfo LatentInfo)

Parameters

Type	Name	Description
UObject	WorldContextObject
System.Byte	AssetClass
System.Byte	OnLoaded
LatentActionInfo	LatentInfo

LoadInterstitialAd(Int32)

Will load a fullscreen interstitial AdMob ad.

Declaration

public static void LoadInterstitialAd(int AdIdIndex)

Parameters

Type	Name	Description
System.Int32	AdIdIndex

Remarks

Call this before using ShowInterstitialAd (Android only)

@param AdIdIndex The index of the ID to select for the ad to show

MakeLiteralBool(Boolean)

Creates a literal bool @

Declaration

public static bool MakeLiteralBool(bool Value)

Parameters

Type	Name	Description
System.Boolean	Value

Returns

Type	Description
System.Boolean

Remarks

param Value value to set the bool to @return The literal bool

MakeLiteralByte(Byte)

Creates a literal byte @

Declaration

public static byte MakeLiteralByte(byte Value)

Parameters

Type	Name	Description
System.Byte	Value

Returns

Type	Description
System.Byte

Remarks

param Value value to set the byte to @return The literal byte

MakeLiteralFloat(Single)

Creates a literal float @

Declaration

public static float MakeLiteralFloat(float Value)

Parameters

Type	Name	Description
System.Single	Value

Returns

Type	Description
System.Single

Remarks

param Value value to set the float to @return The literal float

MakeLiteralInt(Int32)

Creates a literal integer @

Declaration

public static int MakeLiteralInt(int Value)

Parameters

Type	Name	Description
System.Int32	Value

Returns

Type	Description
System.Int32

Remarks

param Value value to set the integer to @return The literal integer

MakeLiteralName(Name)

Creates a literal name @

Declaration

public static Name MakeLiteralName(Name Value)

Parameters

Type	Name	Description
Name	Value

Returns

Type	Description
Name

Remarks

param Value value to set the name to @return The literal name

MakeLiteralString(String)

Creates a literal string @

Declaration

public static string MakeLiteralString(string Value)

Parameters

Type	Name	Description
System.String	Value

Returns

Type	Description
System.String

Remarks

param Value value to set the string to @return The literal string

MakeLiteralText(Byte)

Creates a literal FText @

Declaration

public static byte MakeLiteralText(byte Value)

Parameters

Type	Name	Description
System.Byte	Value

Returns

Type	Description
System.Byte

Remarks

param Value value to set the FText to @return The literal FText

MakeSoftClassPath(String)

Builds a SoftClassPath struct. Generally you should be using Soft Class References/Ptr types instead

Declaration

public static SoftClassPath MakeSoftClassPath(string PathString)

Parameters

Type	Name	Description
System.String	PathString

Returns

Type	Description
SoftClassPath

MakeSoftObjectPath(String)

Builds a SoftObjectPath struct. Generally you should be using Soft Object References/Ptr types instead

Declaration

public static SoftObjectPath MakeSoftObjectPath(string PathString)

Parameters

Type	Name	Description
System.String	PathString

Returns

Type	Description
SoftObjectPath

MoveComponentTo(SceneComponent, Vector, Rotator, Boolean, Boolean, Single, Boolean, Byte, LatentActionInfo)

• Interpolate a component to the specified relative location and rotation over the course of OverTime seconds.

Declaration

public static void MoveComponentTo(SceneComponent Component, Vector TargetRelativeLocation, Rotator TargetRelativeRotation, bool bEaseOut, bool bEaseIn, float OverTime, bool bForceShortestRotationPath, byte MoveAction, LatentActionInfo LatentInfo)

Parameters

Type	Name	Description
SceneComponent	Component
Vector	TargetRelativeLocation
Rotator	TargetRelativeRotation
System.Boolean	bEaseOut
System.Boolean	bEaseIn
System.Single	OverTime
System.Boolean	bForceShortestRotationPath
System.Byte	MoveAction
LatentActionInfo	LatentInfo

Remarks

• @param Component Component to interpolate
• @param TargetRelativeLocation Relative target location
• @param TargetRelativeRotation Relative target rotation
• @param bEaseOut if true we will ease out (ie end slowly) during interpolation
• @param bEaseIn if true we will ease in (ie start slowly) during interpolation
• @param OverTime duration of interpolation
• @param bForceShortestRotationPath if true we will always use the shortest path for rotation
• @param MoveAction required movement behavior @see EMoveComponentAction
• @param LatentInfo The latent action

New(UObject, Name)

Spawn an object of this class

Declaration

public static KismetSystemLibrary New(UObject obj = null, Name name = default(Name))

Parameters

Type	Name	Description
UObject	obj
Name	name

Returns

Type	Description
KismetSystemLibrary

NormalizeFilename(String)

Convert all / and \ to TEXT("/")

Declaration

public static string NormalizeFilename(string InFilename)

Parameters

Type	Name	Description
System.String	InFilename

Returns

Type	Description
System.String

NotEqual_PrimaryAssetId(PrimaryAssetId, PrimaryAssetId)

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

Declaration

public static bool NotEqual_PrimaryAssetId(PrimaryAssetId A, PrimaryAssetId B)

Parameters

Type	Name	Description
PrimaryAssetId	A
PrimaryAssetId	B

Returns

Type	Description
System.Boolean

NotEqual_PrimaryAssetType(PrimaryAssetType, PrimaryAssetType)

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

Declaration

public static bool NotEqual_PrimaryAssetType(PrimaryAssetType A, PrimaryAssetType B)

Parameters

Type	Name	Description
PrimaryAssetType	A
PrimaryAssetType	B

Returns

Type	Description
System.Boolean

NotEqual_SoftClassReference(Byte, Byte)

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

Declaration

public static bool NotEqual_SoftClassReference(byte A, byte B)

Parameters

Type	Name	Description
System.Byte	A
System.Byte	B

Returns

Type	Description
System.Boolean

NotEqual_SoftObjectReference(Byte, Byte)

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

Declaration

public static bool NotEqual_SoftObjectReference(byte A, byte B)

Parameters

Type	Name	Description
System.Byte	A
System.Byte	B

Returns

Type	Description
System.Boolean

PrintString(UObject, String, Boolean, Boolean, LinearColor, Single)

Prints a string to the log, and optionally, to the screen If Print To Log is true, it will be visible in the Output Log window.

Declaration

public static void PrintString(UObject WorldContextObject, string InString, bool bPrintToScreen, bool bPrintToLog, LinearColor TextColor, float Duration)

Parameters

Type	Name	Description
UObject	WorldContextObject
System.String	InString
System.Boolean	bPrintToScreen
System.Boolean	bPrintToLog
LinearColor	TextColor
System.Single	Duration

Remarks

Otherwise it will be logged only as 'Verbose', so it generally won't show up.

@param InString The string to log out @param bPrintToScreen Whether or not to print the output to the screen @param bPrintToLog Whether or not to print the output to the log @param bPrintToConsole Whether or not to print the output to the console @param TextColor Whether or not to print the output to the console @param Duration The display duration (if Print to Screen is True). Using negative number will result in loading the duration time from the config.

PrintText(UObject, Byte, Boolean, Boolean, LinearColor, Single)

Prints text to the log, and optionally, to the screen If Print To Log is true, it will be visible in the Output Log window.

Declaration

public static void PrintText(UObject WorldContextObject, byte InText, bool bPrintToScreen, bool bPrintToLog, LinearColor TextColor, float Duration)

Parameters

Type	Name	Description
UObject	WorldContextObject
System.Byte	InText
System.Boolean	bPrintToScreen
System.Boolean	bPrintToLog
LinearColor	TextColor
System.Single	Duration

Remarks

Otherwise it will be logged only as 'Verbose', so it generally won't show up.

@param InText The text to log out @param bPrintToScreen Whether or not to print the output to the screen @param bPrintToLog Whether or not to print the output to the log @param bPrintToConsole Whether or not to print the output to the console @param TextColor Whether or not to print the output to the console @param Duration The display duration (if Print to Screen is True). Using negative number will result in loading the duration time from the config.

PrintWarning(String)

Prints a warning string to the log and the screen.

Declaration

public static void PrintWarning(string InString)

Parameters

Type	Name	Description
System.String	InString

Remarks

Meant to be used as a way to inform the user that they misused the node.

WARNING!! Don't change the signature of this function without fixing up all nodes using it in the compiler

@param InString The string to log out

QuitGame(UObject, PlayerController, Byte, Boolean)

Exit the current game @

Declaration

public static void QuitGame(UObject WorldContextObject, PlayerController SpecificPlayer, byte QuitPreference, bool bIgnorePlatformRestrictions)

Parameters

Type	Name	Description
UObject	WorldContextObject
PlayerController	SpecificPlayer
System.Byte	QuitPreference
System.Boolean	bIgnorePlatformRestrictions

Remarks

param SpecificPlayer The specific player to quit the game. If not specified, player 0 will quit. @param QuitPreference Form of quitting. @param bIgnorePlatformRestrictions Ignores and best-practices based on platform (e.g PS4 games should never quit). Non-shipping only

RegisterForRemoteNotifications()

Requests permission to send remote notifications to the user's device.

Declaration

public static void RegisterForRemoteNotifications()

Remarks

(Android and iOS only)

ResetGamepadAssignments()

Resets the gamepad to player controller id assignments (Android only)

Declaration

public static void ResetGamepadAssignments()

ResetGamepadAssignmentToController(Int32)

• Resets the gamepad assignment to player controller id (Android only)

Declaration

public static void ResetGamepadAssignmentToController(int ControllerId)

Parameters

Type	Name	Description
System.Int32	ControllerId

RetriggerableDelay(UObject, Single, LatentActionInfo)

Perform a latent action with a retriggerable delay (specified in seconds).

Declaration

public static void RetriggerableDelay(UObject WorldContextObject, float Duration, LatentActionInfo LatentInfo)

Parameters

Type	Name	Description
UObject	WorldContextObject
System.Single	Duration
LatentActionInfo	LatentInfo

Remarks

Calling again while it is counting down will reset the countdown to Duration.

@param WorldContext World context. @param Duration length of delay (in seconds). @param LatentInfo The latent action.

SetBoolPropertyByName(UObject, Name, Boolean)

Set a bool property by name

Declaration

public static void SetBoolPropertyByName(UObject UObject, Name PropertyName, bool Value)

Parameters

Type	Name	Description
UObject	UObject
Name	PropertyName
System.Boolean	Value

SetBytePropertyByName(UObject, Name, Byte)

Set an uint8 or enum property by name

Declaration

public static void SetBytePropertyByName(UObject UObject, Name PropertyName, byte Value)

Parameters

Type	Name	Description
UObject	UObject
Name	PropertyName
System.Byte	Value

SetClassPropertyByName(UObject, Name, SubclassOf<UObject>)

Set a CLASS property by name

Declaration

public static void SetClassPropertyByName(UObject UObject, Name PropertyName, SubclassOf<UObject> Value)

Parameters

Type	Name	Description
UObject	UObject
Name	PropertyName
SubclassOf<UObject>	Value

SetCollisionProfileNameProperty(UObject, Name, CollisionProfileName)

Set a CollisionProfileName property by name

Declaration

public static void SetCollisionProfileNameProperty(UObject UObject, Name PropertyName, CollisionProfileName Value)

Parameters

Type	Name	Description
UObject	UObject
Name	PropertyName
CollisionProfileName	Value

SetFloatPropertyByName(UObject, Name, Single)

Set a float property by name

Declaration

public static void SetFloatPropertyByName(UObject UObject, Name PropertyName, float Value)

Parameters

Type	Name	Description
UObject	UObject
Name	PropertyName
System.Single	Value

SetInterfacePropertyByName(UObject, Name, Byte)

Set an INTERFACE property by name

Declaration

public static void SetInterfacePropertyByName(UObject UObject, Name PropertyName, byte Value)

Parameters

Type	Name	Description
UObject	UObject
Name	PropertyName
System.Byte	Value

SetIntPropertyByName(UObject, Name, Int32)

Set an int32 property by name

Declaration

public static void SetIntPropertyByName(UObject UObject, Name PropertyName, int Value)

Parameters

Type	Name	Description
UObject	UObject
Name	PropertyName
System.Int32	Value

SetLinearColorPropertyByName(UObject, Name, LinearColor)

Set a LINEAR COLOR property by name

Declaration

public static void SetLinearColorPropertyByName(UObject UObject, Name PropertyName, LinearColor Value)

Parameters

Type	Name	Description
UObject	UObject
Name	PropertyName
LinearColor	Value

SetNamePropertyByName(UObject, Name, Name)

Set a NAME property by name

Declaration

public static void SetNamePropertyByName(UObject UObject, Name PropertyName, Name Value)

Parameters

Type	Name	Description
UObject	UObject
Name	PropertyName
Name	Value

SetObjectPropertyByName(UObject, Name, UObject)

Set an OBJECT property by name

Declaration

public static void SetObjectPropertyByName(UObject UObject, Name PropertyName, UObject Value)

Parameters

Type	Name	Description
UObject	UObject
Name	PropertyName
UObject	Value

SetRotatorPropertyByName(UObject, Name, Rotator)

Set a ROTATOR property by name

Declaration

public static void SetRotatorPropertyByName(UObject UObject, Name PropertyName, Rotator Value)

Parameters

Type	Name	Description
UObject	UObject
Name	PropertyName
Rotator	Value

SetSoftClassPropertyByName(UObject, Name, Byte)

Set a SOFTCLASS property by name

Declaration

public static void SetSoftClassPropertyByName(UObject UObject, Name PropertyName, byte Value)

Parameters

Type	Name	Description
UObject	UObject
Name	PropertyName
System.Byte	Value

SetSoftObjectPropertyByName(UObject, Name, Byte)

Set a SOFTOBJECT property by name

Declaration

public static void SetSoftObjectPropertyByName(UObject UObject, Name PropertyName, byte Value)

Parameters

Type	Name	Description
UObject	UObject
Name	PropertyName
System.Byte	Value

SetStringPropertyByName(UObject, Name, String)

Set a STRING property by name

Declaration

public static void SetStringPropertyByName(UObject UObject, Name PropertyName, string Value)

Parameters

Type	Name	Description
UObject	UObject
Name	PropertyName
System.String	Value

SetStructurePropertyByName(UObject, Name, GenericStruct)

Set a custom structure property by name

Declaration

public static void SetStructurePropertyByName(UObject UObject, Name PropertyName, GenericStruct Value)

Parameters

Type	Name	Description
UObject	UObject
Name	PropertyName
GenericStruct	Value

SetSuppressViewportTransitionMessage(UObject, Boolean)

Sets the state of the transition message rendered by the viewport.

Declaration

public static void SetSuppressViewportTransitionMessage(UObject WorldContextObject, bool bState)

Parameters

Type	Name	Description
UObject	WorldContextObject
System.Boolean	bState

Remarks

(The blue text displayed when the game is paused and so forth.)

@param WorldContextObject World context @param State set true to suppress transition message

SetTextPropertyByName(UObject, Name, Byte)

Set a TEXT property by name

Declaration

public static void SetTextPropertyByName(UObject UObject, Name PropertyName, byte Value)

Parameters

Type	Name	Description
UObject	UObject
Name	PropertyName
System.Byte	Value

SetTransformPropertyByName(UObject, Name, Transform)

Set a TRANSFORM property by name

Declaration

public static void SetTransformPropertyByName(UObject UObject, Name PropertyName, Transform Value)

Parameters

Type	Name	Description
UObject	UObject
Name	PropertyName
Transform	Value

SetUserActivity(UserActivity)

Tells the engine what the user is doing for debug, analytics, etc.

Declaration

public static void SetUserActivity(UserActivity UserActivity)

Parameters

Type	Name	Description
UserActivity	UserActivity

SetVectorPropertyByName(UObject, Name, Vector)

Set a VECTOR property by name

Declaration

public static void SetVectorPropertyByName(UObject UObject, Name PropertyName, Vector Value)

Parameters

Type	Name	Description
UObject	UObject
Name	PropertyName
Vector	Value

SetVolumeButtonsHandledBySystem(Boolean)

Allows or inhibits system default handling of volume up and volume down buttons (Android only) @

Declaration

public static void SetVolumeButtonsHandledBySystem(bool bEnabled)

Parameters

Type	Name	Description
System.Boolean	bEnabled

Remarks

param bEnabled If true, allow Android to handle volume up and down events

SetWindowTitle(Byte)

Sets the game window title

Declaration

public static void SetWindowTitle(byte Title)

Parameters

Type	Name	Description
System.Byte	Title

ShowAdBanner(Int32, Boolean)

Will show an ad banner (iAd on iOS, or AdMob on Android) on the top or bottom of screen, on top of the GL view (doesn't resize the view) (iOS and Android only) @

Declaration

public static void ShowAdBanner(int AdIdIndex, bool bShowOnBottomOfScreen)

Parameters

Type	Name	Description
System.Int32	AdIdIndex
System.Boolean	bShowOnBottomOfScreen

Remarks

param AdIdIndex The index of the ID to select for the ad to show @param bShowOnBottomOfScreen If true, the iAd will be shown at the bottom of the screen, top otherwise

ShowInterstitialAd()

Shows the loaded interstitial ad (loaded with LoadInterstitialAd)

Declaration

public static void ShowInterstitialAd()

Remarks

(Android only)

ShowPlatformSpecificAchievementsScreen(PlayerController)

Displays the built-in achievements GUI (iOS and Android only; this function may be renamed or moved in a future release) @

Declaration

public static void ShowPlatformSpecificAchievementsScreen(PlayerController SpecificPlayer)

Parameters

Type	Name	Description
PlayerController	SpecificPlayer

Remarks

param SpecificPlayer Specific player's achievements to show. May not be supported on all platforms. If null, defaults to the player with ControllerId 0

ShowPlatformSpecificLeaderboardScreen(String)

Displays the built-in leaderboard GUI (iOS and Android only; this function may be renamed or moved in a future release)

Declaration

public static void ShowPlatformSpecificLeaderboardScreen(string CategoryName)

Parameters

Type	Name	Description
System.String	CategoryName

SphereOverlapActors(UObject, Vector, Single, Byte, SubclassOf<UObject>, Byte)

Returns an array of actors that overlap the given sphere.

Declaration

public static (IReadOnlyCollection<Actor>, bool) SphereOverlapActors(UObject WorldContextObject, Vector SpherePos, float SphereRadius, byte ObjectTypes, SubclassOf<UObject> ActorClassFilter, byte ActorsToIgnore)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	SpherePos
System.Single	SphereRadius
System.Byte	ObjectTypes
SubclassOf<UObject>	ActorClassFilter
System.Byte	ActorsToIgnore

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<Actor>, System.Boolean>

Remarks

@param WorldContext World context @param SpherePos Center of sphere. @param SphereRadius Size of sphere. @param Filter Option to restrict results to only static or only dynamic. For efficiency. @param ClassFilter If set, will only return results of this class or subclasses of it. @param ActorsToIgnore Ignore these actors in the list @param OutActors Returned array of actors. Unsorted. @return true if there was an overlap that passed the filters, false otherwise.

SphereOverlapComponents(UObject, Vector, Single, Byte, SubclassOf<UObject>, Byte)

Returns an array of components that overlap the given sphere.

Declaration

public static (IReadOnlyCollection<PrimitiveComponent>, bool) SphereOverlapComponents(UObject WorldContextObject, Vector SpherePos, float SphereRadius, byte ObjectTypes, SubclassOf<UObject> ComponentClassFilter, byte ActorsToIgnore)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	SpherePos
System.Single	SphereRadius
System.Byte	ObjectTypes
SubclassOf<UObject>	ComponentClassFilter
System.Byte	ActorsToIgnore

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<PrimitiveComponent>, System.Boolean>

Remarks

@param WorldContext World context @param SpherePos Center of sphere. @param SphereRadius Size of sphere. @param Filter Option to restrict results to only static or only dynamic. For efficiency. @param ClassFilter If set, will only return results of this class or subclasses of it. @param ActorsToIgnore Ignore these actors in the list @param OutActors Returned array of actors. Unsorted. @return true if there was an overlap that passed the filters, false otherwise.

SphereTraceMulti(UObject, Vector, Vector, Single, Byte, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Sweeps a sphere along the given line and returns all hits encountered up to and including the first blocking hit.

Declaration

public static (IReadOnlyCollection<HitResult>, bool) SphereTraceMulti(UObject WorldContextObject, Vector Start, Vector End, float Radius, byte TraceChannel, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
System.Single	Radius
System.Byte	TraceChannel
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<HitResult>, System.Boolean>

Remarks

This trace finds the objects that RESPOND to the given TraceChannel

@param WorldContext World context @param Start Start of line segment. @param End End of line segment. @param Radius Radius of the sphere to sweep @param TraceChannel @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHits A list of hits, sorted along the trace from start to finish. The blocking hit will be the last hit, if there was one. @return True if there was a blocking hit, false otherwise.

SphereTraceMultiByProfile(UObject, Vector, Vector, Single, Name, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Sweep a sphere against the world and return all initial overlaps using a specific profile, then overlapping hits and then first blocking hit Results are sorted, so a blocking hit (if found) will be the last element of the array Only the single closest blocking result will be generated, no tests will be done after that @

Declaration

public static (IReadOnlyCollection<HitResult>, bool) SphereTraceMultiByProfile(UObject WorldContextObject, Vector Start, Vector End, float Radius, Name ProfileName, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
System.Single	Radius
Name	ProfileName
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<HitResult>, System.Boolean>

Remarks

param WorldContext World context @param Start Start of line segment. @param End End of line segment. @param Radius Radius of the sphere to sweep @param ProfileName The 'profile' used to determine which components to hit @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHits A list of hits, sorted along the trace from start to finish. The blocking hit will be the last hit, if there was one. @return True if there was a blocking hit, false otherwise.

SphereTraceMultiForObjects(UObject, Vector, Vector, Single, Byte, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Sweeps a sphere along the given line and returns all hits encountered.

Declaration

public static (IReadOnlyCollection<HitResult>, bool) SphereTraceMultiForObjects(UObject WorldContextObject, Vector Start, Vector End, float Radius, byte ObjectTypes, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
System.Single	Radius
System.Byte	ObjectTypes
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<HitResult>, System.Boolean>

Remarks

This only finds objects that are of a type specified by ObjectTypes.

@param WorldContext World context @param Start Start of line segment. @param End End of line segment. @param Radius Radius of the sphere to sweep @param ObjectTypes Array of Object Types to trace @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHits A list of hits, sorted along the trace from start to finish. The blocking hit will be the last hit, if there was one. @return True if there was a hit, false otherwise.

SphereTraceSingle(UObject, Vector, Vector, Single, Byte, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Sweeps a sphere along the given line and returns the first blocking hit encountered.

Declaration

public static (HitResult, bool) SphereTraceSingle(UObject WorldContextObject, Vector Start, Vector End, float Radius, byte TraceChannel, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
System.Single	Radius
System.Byte	TraceChannel
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<HitResult, System.Boolean>

Remarks

This trace finds the objects that RESPONDS to the given TraceChannel

@param Start Start of line segment. @param End End of line segment. @param Radius Radius of the sphere to sweep @param TraceChannel @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHit Properties of the trace hit. @return True if there was a hit, false otherwise.

SphereTraceSingleByProfile(UObject, Vector, Vector, Single, Name, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Sweep a sphere against the world and return the first blocking hit using a specific profile @

Declaration

public static (HitResult, bool) SphereTraceSingleByProfile(UObject WorldContextObject, Vector Start, Vector End, float Radius, Name ProfileName, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
System.Single	Radius
Name	ProfileName
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<HitResult, System.Boolean>

Remarks

param Start Start of line segment. @param End End of line segment. @param Radius Radius of the sphere to sweep @param ProfileName The 'profile' used to determine which components to hit @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHit Properties of the trace hit. @return True if there was a hit, false otherwise.

SphereTraceSingleForObjects(UObject, Vector, Vector, Single, Byte, Boolean, Byte, Byte, Boolean, LinearColor, LinearColor, Single)

Sweeps a sphere along the given line and returns the first hit encountered.

Declaration

public static (HitResult, bool) SphereTraceSingleForObjects(UObject WorldContextObject, Vector Start, Vector End, float Radius, byte ObjectTypes, bool bTraceComplex, byte ActorsToIgnore, byte DrawDebugType, bool bIgnoreSelf, LinearColor TraceColor, LinearColor TraceHitColor, float DrawTime)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Start
Vector	End
System.Single	Radius
System.Byte	ObjectTypes
System.Boolean	bTraceComplex
System.Byte	ActorsToIgnore
System.Byte	DrawDebugType
System.Boolean	bIgnoreSelf
LinearColor	TraceColor
LinearColor	TraceHitColor
System.Single	DrawTime

Returns

Type	Description
System.ValueTuple<HitResult, System.Boolean>

Remarks

This only finds objects that are of a type specified by ObjectTypes.

@param Start Start of line segment. @param End End of line segment. @param Radius Radius of the sphere to sweep @param ObjectTypes Array of Object Types to trace @param bTraceComplex True to test against complex collision, false to test against simplified collision. @param OutHit Properties of the trace hit. @return True if there was a hit, false otherwise.

StackTrace()

Prints a stack trace to the log, so you can see how a blueprint got to this node

Declaration

public static void StackTrace()

TransactObject(UObject)

Notify the current transaction (if any) that this object is about to be modified and should be placed into the undo buffer.

Declaration

public static void TransactObject(UObject UObject)

Parameters

Type	Name	Description
UObject	UObject

Remarks

@note Internally this calls Modify on the given object, so will also mark the owner package dirty. @note Only available in the editor.

@param Object The object that is about to be modified.

UnloadPrimaryAsset(PrimaryAssetId)

Unloads a primary asset, which allows it to be garbage collected if nothing else is referencing it

Declaration

public static void UnloadPrimaryAsset(PrimaryAssetId PrimaryAssetId)

Parameters

Type	Name	Description
PrimaryAssetId	PrimaryAssetId

UnloadPrimaryAssetList(Byte)

Unloads a primary asset, which allows it to be garbage collected if nothing else is referencing it

Declaration

public static void UnloadPrimaryAssetList(byte PrimaryAssetIdList)

Parameters

Type	Name	Description
System.Byte	PrimaryAssetIdList

UnregisterForRemoteNotifications()

Requests Requests unregistering from receiving remote notifications to the user's device.

Declaration

public static void UnregisterForRemoteNotifications()

Remarks

(Android only)

Operators

Implicit(IntPtr to KismetSystemLibrary)

Convert from IntPtr to UObject

Declaration

public static implicit operator KismetSystemLibrary(IntPtr p)

Parameters

Type	Name	Description
System.IntPtr	p

Returns

Type	Description
KismetSystemLibrary