UKismetSystemLibrary

class Engine Blueprint Since 4.0

Inherits: UObjectBase › UObjectBaseUtility › UObject › UBlueprintFunctionLibrary › UKismetSystemLibrary

#include "Kismet/KismetSystemLibrary.h"

Description

Blueprint function library providing general-purpose engine utilities: object validity/identity queries, debug drawing, timers, platform and build information, string/path helpers, and print/log nodes. Most functions are exposed to Blueprints as the 'Utilities' category.

Caveats & Gotchas

• Being a UBlueprintFunctionLibrary, it exposes only static functions with no instance state — never instantiate it or store references to it.
• Many of its debug-oriented functions (StackTrace, PrintString, debug drawing) compile out or become no-ops in shipping builds; don't rely on them for gameplay logic that must run in shipped games.

Functions (292)

Components

1 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::MoveComponentTo	Latently interpolates a scene component to a target relative location and rotation over a fixed duration.

Collision

38 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::BoxTraceMulti	Sweeps an oriented box from Start to End against the given Trace Channel and returns every hit encountered, including overlaps before the first blocking hit.
public	function	UKismetSystemLibrary::BoxTraceSingle	Sweeps an oriented box from Start to End against the given Trace Channel and returns the first blocking hit encountered.
public	function	UKismetSystemLibrary::CapsuleTraceMulti	Sweeps a capsule from Start to End against the given Trace Channel and returns every hit encountered, including overlaps before the first blocking hit.
public	function	UKismetSystemLibrary::CapsuleTraceSingle	Sweeps a capsule from Start to End against the given Trace Channel and returns the first blocking hit encountered.
public	function	UKismetSystemLibrary::LineTraceMulti	Performs a line trace between Start and End against the given Trace Channel and returns every hit up to and including the first blocking hit.
public	function	UKismetSystemLibrary::LineTraceSingle	Performs a line trace between Start and End against the given Trace Channel and returns the first blocking hit encountered.
public	function	UKismetSystemLibrary::SphereTraceMulti	Sweeps a sphere of the given Radius from Start to End against the given Trace Channel and returns every hit encountered, including overlaps before the first blocking hit.
public	function	UKismetSystemLibrary::SphereTraceSingle	Sweeps a sphere of the given Radius from Start to End against the given Trace Channel and returns the first blocking hit encountered.
public	function	UKismetSystemLibrary::BoxOverlapActors	Finds every actor whose collision overlaps the given axis-aligned box.
public	function	UKismetSystemLibrary::BoxOverlapActorsWithOrientation	Finds every actor whose collision overlaps the given box at an arbitrary world-space orientation.
public	function	UKismetSystemLibrary::BoxOverlapComponents	Finds every primitive component whose collision overlaps the given axis-aligned box.
public	function	UKismetSystemLibrary::BoxOverlapComponentsWithOrientation	Finds every primitive component whose collision overlaps the given box at an arbitrary world-space orientation.
public	function	UKismetSystemLibrary::BoxTraceMultiByProfile	Sweeps an oriented box from Start to End against the world using a named Collision Profile and returns all overlapping hits plus the first blocking hit.
public	function	UKismetSystemLibrary::BoxTraceMultiForObjects	Sweeps an oriented box from Start to End and returns every hit against components whose collision responds to one of the given Object Types.
public	function	UKismetSystemLibrary::BoxTraceSingleByProfile	Sweeps an oriented box from Start to End against the world using a named Collision Profile and returns the first blocking hit.
public	function	UKismetSystemLibrary::BoxTraceSingleForObjects	Sweeps an oriented box from Start to End and returns the first hit against a component whose collision responds to one of the given Object Types.
public	function	UKismetSystemLibrary::CapsuleOverlapActors	Finds every actor whose collision overlaps the given axis-aligned capsule.
public	function	UKismetSystemLibrary::CapsuleOverlapActorsWithOrientation	Finds every actor whose collision overlaps the given capsule at an arbitrary world-space orientation.
public	function	UKismetSystemLibrary::CapsuleOverlapComponents	Finds every primitive component whose collision overlaps the given axis-aligned capsule.
public	function	UKismetSystemLibrary::CapsuleOverlapComponentsWithOrientation	Finds every primitive component whose collision overlaps the given capsule at an arbitrary world-space orientation.
public	function	UKismetSystemLibrary::CapsuleTraceMultiByProfile	Sweeps a capsule against the world using a collision profile rather than a trace channel or object type, returning every overlap and the first blocking hit sorted along the sweep.
public	function	UKismetSystemLibrary::CapsuleTraceMultiForObjects	Sweeps a capsule from Start to End and returns every hit against components whose collision responds to one of the given Object Types.
public	function	UKismetSystemLibrary::CapsuleTraceSingleByProfile	Sweeps a capsule from Start to End against the world using a named Collision Profile and returns the first blocking hit.
public	function	UKismetSystemLibrary::CapsuleTraceSingleForObjects	Sweeps a capsule from Start to End and returns the first hit against a component whose collision responds to one of the given Object Types.
public	function	UKismetSystemLibrary::ComponentOverlapActors	Finds every actor whose collision overlaps Component's shape as if it were placed at ComponentTransform, without actually moving Component.
public	function	UKismetSystemLibrary::ComponentOverlapComponents	Finds every primitive component whose collision overlaps Component's shape as if it were placed at ComponentTransform, without actually moving Component.
public	function	UKismetSystemLibrary::GetActorBounds deprecated	Computes the world-space bounding box that encloses all of an actor's components combined.
public	function	UKismetSystemLibrary::GetComponentBounds	Computes the world-space bounding box and sphere for a single scene component, including its attached children.
public	function	UKismetSystemLibrary::LineTraceMultiByProfile	Traces a line from Start to End against the world using a named Collision Profile and returns all overlapping hits plus the first blocking hit.
public	function	UKismetSystemLibrary::LineTraceMultiForObjects	Traces a line from Start to End and returns every hit against components whose collision responds to one of the given Object Types.
public	function	UKismetSystemLibrary::LineTraceSingleByProfile	Traces a line from Start to End against the world using a named Collision Profile and returns the first blocking hit.
public	function	UKismetSystemLibrary::LineTraceSingleForObjects	Traces a line from Start to End and returns the first hit against any component whose collision is set to respond to one of the given Object Types.
public	function	UKismetSystemLibrary::SphereOverlapActors	Finds every actor whose collision overlaps the given world-space sphere.
public	function	UKismetSystemLibrary::SphereOverlapComponents	Finds every primitive component whose collision overlaps the given world-space sphere.
public	function	UKismetSystemLibrary::SphereTraceMultiByProfile	Sweeps a sphere from Start to End against the world using a named Collision Profile and returns all overlapping hits plus the first blocking hit.
public	function	UKismetSystemLibrary::SphereTraceMultiForObjects	Sweeps a sphere from Start to End and returns every hit against components whose collision responds to one of the given Object Types.
public	function	UKismetSystemLibrary::SphereTraceSingleByProfile	Sweeps a sphere from Start to End against the world using a named Collision Profile and returns the first blocking hit.
public	function	UKismetSystemLibrary::SphereTraceSingleForObjects	Sweeps a sphere from Start to End and returns the first hit against a component whose collision responds to one of the given Object Types.

Networking

3 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::IsDedicatedServer	Returns whether the current world is running as a dedicated server, meaning there is no local player and no rendering.
public	function	UKismetSystemLibrary::IsServer	Returns whether the world this object belongs to is running as the host — true on a listen server, dedicated server, or standalone game.
public	function	UKismetSystemLibrary::IsStandalone	Returns whether this game instance has no networking at all (single-player, no client/server split).

Rendering

8 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::AddFloatHistorySample	Appends a new value to an FDebugFloatHistory sample buffer and returns the updated copy, feeding the debug float-history draw calls.
public	function	UKismetSystemLibrary::DrawDebugFloatHistoryLocation	Draws a 2D histogram of a float value's history at a fixed world location, always billboarded to face the first player's camera.
public	function	UKismetSystemLibrary::GetConvenientWindowedResolutions	Queries the device for a list of windowed resolutions that fit comfortably within the current primary display.
public	function	UKismetSystemLibrary::GetMinYResolutionFor3DView	Returns the smallest vertical (Y) resolution, in pixels, that the project wants to support for the 3D viewport.
public	function	UKismetSystemLibrary::GetMinYResolutionForUI	Returns the smallest vertical (Y) resolution, in pixels, that the project wants to support for UI rendering.
public	function	UKismetSystemLibrary::GetRenderingDetailMode	Returns the clamped state of the r.
public	function	UKismetSystemLibrary::GetRenderingMaterialQualityLevel	Returns the clamped state of the r.
public	function	UKismetSystemLibrary::GetSupportedFullscreenResolutions	Queries the device for the list of resolutions it supports in fullscreen mode.

Utility

69 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::IsValid	Returns true if the object is usable: non-null and not pending kill / garbage.
public	function	UKismetSystemLibrary::CanLaunchURL	Returns whether the current platform is able to launch the given URL in a browser.
public	function	UKismetSystemLibrary::ConvertToAbsolutePath	Converts the passed-in filename to a fully qualified absolute path on the local file system.
public	function	UKismetSystemLibrary::ConvertToRelativePath	Converts the passed-in filename to use a path relative to the current process's base directory.
public	function	UKismetSystemLibrary::GetCommandLine	Returns the full command line the process was launched with.
public	function	UKismetSystemLibrary::GetDisplayName	Returns a human-readable name for the object, for use as a debugging aid — the actor's editor label for Actors, a readable name for components, or the object name otherwise.
public	function	UKismetSystemLibrary::GetGameName	Returns the name of the current game/project.
public	function	UKismetSystemLibrary::GetObjectName	Returns the actual internal object name (e.
public	function	UKismetSystemLibrary::GetOuterObject	Returns the outer object of an object — the UObject it is nested inside in UE's object hierarchy (e.
public	function	UKismetSystemLibrary::GetPathName	Returns the full path to the specified object as a string, e.
public	function	UKismetSystemLibrary::GetProjectContentDirectory	Returns the Content directory of the current project on disk (i.
public	function	UKismetSystemLibrary::GetProjectDirectory	Returns the root directory of the current project on disk.
public	function	UKismetSystemLibrary::GetProjectSavedDirectory	Returns the Saved directory of the current project on disk — the writable location used for logs, save games, config overrides, and crash dumps.
public	function	UKismetSystemLibrary::GetSoftClassPath	Returns the full path to the specified class as an FSoftClassPath, suitable for storing as a soft reference to load later.
public	function	UKismetSystemLibrary::GetSoftObjectPath	Returns the full path to the specified object as an FSoftObjectPath, suitable for storing and later resolving asynchronously via the asset system.
public	function	UKismetSystemLibrary::IsValidClass	Returns true if the class is usable: non-null and not pending kill / garbage.
public	function	UKismetSystemLibrary::LaunchExternalUrl	Opens an external URL in the platform's default web browser, but only if its domain matches one of the provided allowlist strings.
public	function	UKismetSystemLibrary::LaunchURL	Opens the specified URL in the platform's default web browser.
public	function	UKismetSystemLibrary::NormalizeFilename	Converts all forward and backward slashes in a path to a single consistent forward-slash form, useful before comparing or hashing paths.
public	function	UKismetSystemLibrary::ParseCommandLine	Parses a command line string into loose tokens, boolean switches (arguments beginning with - or /), and key=value parameters.
public	function	UKismetSystemLibrary::ParseParam	Returns true if InString contains the given -param switch.
public	function	UKismetSystemLibrary::ParseParamValue	Returns true and fills OutValue if '-option=value' is present in InString for the given InParam.
public	function	UKismetSystemLibrary::BreakARFilter	Splits an FARFilter struct into its individual component fields, the Blueprint inverse of MakeARFilter.
public	function	UKismetSystemLibrary::CollectGarbage	Requests that the engine delete all unreferenced UObjects, queuing garbage collection to run at the end of the frame.
public	function	UKismetSystemLibrary::CreateCopyForUndoBuffer	Marks an object as modified for the editor's undo/redo transaction buffer before construction-script or utility-widget code changes it.
public	function	UKismetSystemLibrary::DuplicateObject	Duplicates an object to a new instance, copying its property values into a fresh UObject with the given outer and name.
public	function	UKismetSystemLibrary::ForceCloseAdBanner	Forces any currently displayed ad closed immediately.
public	function	UKismetSystemLibrary::GetAdIDCount	Returns the total number of ad unit IDs configured for the project that can be selected via AdIdIndex.
public	function	UKismetSystemLibrary::GetClassDisplayName	Returns the display name of a class, for use as a debugging aid when logging or printing which class an object belongs to.
public	function	UKismetSystemLibrary::GetClassTopLevelAssetPath	Returns the full path to the specified class as an FTopLevelAssetPath, the lightweight identifier used by the asset registry and asset utilities.
public	function	UKismetSystemLibrary::GetEditorProperty	Retrieves the value of a named property from the given object by name, for use in editor utility scripts and Blutilities.
public	function	UKismetSystemLibrary::GetEnumTopLevelAssetPath	Returns the full path to the specified enum as an FTopLevelAssetPath, used by asset utilities and reflection systems that need a stable identifier for a UENUM.
public	function	UKismetSystemLibrary::GetFrameCount	Returns the value of GFrameCounter, a running count of engine frames since process start.
public	function	UKismetSystemLibrary::GetGameBundleId	Retrieves the game's platform-specific bundle identifier or package name (e.
public	function	UKismetSystemLibrary::GetPlatformUserName	Gets the current user name from the operating system.
public	function	UKismetSystemLibrary::GetStructTopLevelAssetPath	Returns the full path to the specified struct as an FTopLevelAssetPath, used by asset utilities and struct-serialization systems that need a stable identifier.
public	function	UKismetSystemLibrary::GetSystemPath	Returns the full file system path to the .
public	function	UKismetSystemLibrary::HideAdBanner	Hides the currently displayed mobile ad banner, forcibly closing it if it's open.
public	function	UKismetSystemLibrary::IsEditorPropertyOverridden	Queries whether a named property's value on the given object overrides the value inherited from its archetype (i.
public	function	UKismetSystemLibrary::IsObjectCooked	Returns true if the object's outermost package has been cooked.
public	function	UKismetSystemLibrary::IsUnattended	Returns true if the engine is running unattended, i.
public	function	UKismetSystemLibrary::LoadInterstitialAd	Requests that a fullscreen interstitial AdMob ad be loaded in the background so it's ready to display later.
public	function	UKismetSystemLibrary::MakeARFilter	Builds an FARFilter struct from individual filter criteria, for use with the Asset Registry search functions.
public	function	UKismetSystemLibrary::ObjectHasEditorOnlyData	Returns true if the object still has its editor-only data, as opposed to having had it stripped for a cooked/packaged build.
public	function	UKismetSystemLibrary::ResetEditorProperty	Resets the value of a named property on the given object so it matches the value from its archetype, undoing any per-instance override.
public	function	UKismetSystemLibrary::SetBoolPropertyByName	Sets a named bool property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetBytePropertyByName	Sets a named uint8 property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetClassPropertyByName	Sets a named TSubclassOf<UObject> property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetCollisionProfileNameProperty	Sets a named FCollisionProfileName property on Object to Value.
public	function	UKismetSystemLibrary::SetColorPropertyByName	Sets a named FColor property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetDoublePropertyByName	Sets a named double property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetEditorProperty	Sets the value of a named property on the given object by name, for use in editor utility scripts and Blutilities.
public	function	UKismetSystemLibrary::SetFieldPathPropertyByName	Sets a named TFieldPath property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetInt64PropertyByName	Sets a named int64 property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetInterfacePropertyByName	Sets a named const FScriptInterface& property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetIntPropertyByName	Sets a named int32 property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetLinearColorPropertyByName	Sets a named const FLinearColor& property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetNamePropertyByName	Sets a named const FName& property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetObjectPropertyByName	Sets a named UObject* property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetRotatorPropertyByName	Sets a named const FRotator& property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetSoftClassPropertyByName	Sets a named const TSoftClassPtr<UObject>& property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetSoftObjectPropertyByName	Sets a named const TSoftObjectPtr<UObject>& property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetStringPropertyByName	Sets a named const FString& property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetStructurePropertyByName	Sets an arbitrary named struct property on Object to Value.
public	function	UKismetSystemLibrary::SetTextPropertyByName	Sets a named const FText& property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetTransformPropertyByName	Sets a named FTransform property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetVector3fPropertyByName	Sets a named const FVector3f& property on Object to Value via reflection.
public	function	UKismetSystemLibrary::SetVectorPropertyByName	Sets a named const FVector& property on Object to Value via reflection.
public	function	UKismetSystemLibrary::ShowAdBanner	Shows a mobile ad banner (iAd on iOS, AdMob on Android) overlaid on top of the game view without resizing it.

Actor

1 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::GetActorListFromComponentList	Collects the unique owning actors of a list of primitive components, commonly used to turn overlap/hit component results into an actor list.

AssetManager

21 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::GetClassFromPrimaryAssetId	Returns the Blueprint class associated with a Primary Asset Id.
public	function	UKismetSystemLibrary::GetObjectFromPrimaryAssetId	Returns the object associated with a Primary Asset Id, but only if it is already loaded in memory — this does not load the asset.
public	function	UKismetSystemLibrary::GetPrimaryAssetIdFromClass	Returns the Primary Asset Id registered for a class, such as a Blueprint class marked as a Primary Asset.
public	function	UKismetSystemLibrary::GetPrimaryAssetIdFromObject	Returns the Primary Asset Id registered for an object.
public	function	UKismetSystemLibrary::GetPrimaryAssetIdFromSoftClassReference	Returns the Primary Asset Id for a soft class reference.
public	function	UKismetSystemLibrary::GetPrimaryAssetIdFromSoftObjectReference	Returns the Primary Asset Id for a soft object reference.
public	function	UKismetSystemLibrary::GetPrimaryAssetIdList	Returns every registered Primary Asset Id belonging to a given Primary Asset Type.
public	function	UKismetSystemLibrary::GetSoftClassReferenceFromPrimaryAssetId	Returns the soft class reference (path) associated with a Primary Asset Id.
public	function	UKismetSystemLibrary::GetSoftObjectReferenceFromPrimaryAssetId	Returns the soft object reference (path) associated with a Primary Asset Id.
public	function	UKismetSystemLibrary::IsValidPrimaryAssetId	Returns true if the Primary Asset Id is valid, meaning it has both a non-empty type and name.
public	function	UKismetSystemLibrary::IsValidPrimaryAssetType	Returns true if the Primary Asset Type is valid, meaning it has a non-empty name.
public	function	UKismetSystemLibrary::Conv_PrimaryAssetIdToString	Converts a Primary Asset Id to its string form, e.
public	function	UKismetSystemLibrary::Conv_PrimaryAssetTypeToString	Converts a Primary Asset Type to its string form.
public	function	UKismetSystemLibrary::EqualEqual_PrimaryAssetId	Returns true if two Primary Asset Ids are equal, comparing both the type and name.
public	function	UKismetSystemLibrary::EqualEqual_PrimaryAssetType	Returns true if two Primary Asset Types are equal.
public	function	UKismetSystemLibrary::GetCurrentBundleState	Returns the list of loaded bundles for a given Primary Asset.
public	function	UKismetSystemLibrary::GetPrimaryAssetsWithBundleState	Returns every Primary Asset currently loaded with a matching set of bundles.
public	function	UKismetSystemLibrary::NotEqual_PrimaryAssetId	Returns true if two Primary Asset Ids are not equal.
public	function	UKismetSystemLibrary::NotEqual_PrimaryAssetType	Returns true if two Primary Asset Types are not equal.
public	function	UKismetSystemLibrary::UnloadPrimaryAsset	Unloads a Primary Asset, allowing it to be garbage collected once nothing else references it.
public	function	UKismetSystemLibrary::UnloadPrimaryAssetList	Unloads a batch of Primary Assets at once, allowing each to be garbage collected once nothing else references it.

Boolean

1 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::MakeLiteralBool	Returns the bool passed in unchanged.

Byte

1 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::MakeLiteralByte	Returns the byte passed in unchanged.

Casting

1 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::Conv_ObjectToClass	Casts an object reference to a UClass, but only succeeds if the object being cast is itself a class (i.

Debug

18 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::DrawDebugArrow	Draws a directional arrow from LineStart to LineEnd, useful for visualizing forward vectors, velocities, or traces.
public	function	UKismetSystemLibrary::DrawDebugBox	Draws a wireframe box for debugging, matching the way box collision or trace shapes are described by center, extent, and rotation.
public	function	UKismetSystemLibrary::DrawDebugLine	Draws a straight debug line between two world-space points for a set duration.
public	function	UKismetSystemLibrary::DrawDebugPoint	Draws a single debug point at a world-space location, useful for marking individual sample positions such as trace hits or spline points.
public	function	UKismetSystemLibrary::DrawDebugSphere	Draws a wireframe debug sphere built from three orthogonal circles, commonly used to visualize a radius such as a sphere trace or overlap check.
public	function	UKismetSystemLibrary::DrawDebugString	Draws floating debug text at a world-space location, optionally attached to and moving with an actor.
public	function	UKismetSystemLibrary::DrawDebugCamera	Draws a wireframe representation of an ACameraActor's frustum, derived automatically from its field of view and aspect ratio.
public	function	UKismetSystemLibrary::DrawDebugCapsule	Draws a wireframe capsule, matching the shape and parameters (center, half-height, radius, rotation) used by capsule collision components and capsule traces.
public	function	UKismetSystemLibrary::DrawDebugCircle	Draws a debug circle built from straight line segments, oriented by the YAxis/ZAxis plane vectors rather than a rotator.
public	function	UKismetSystemLibrary::DrawDebugConeInDegrees	Draws a wireframe cone with angles specified in degrees, commonly used to visualize a field-of-view or perception cone.
public	function	UKismetSystemLibrary::DrawDebugCoordinateSystem	Draws red/green/blue lines representing the local X/Y/Z axes at a location and rotation, useful for visualizing an actor or component's orientation.
public	function	UKismetSystemLibrary::DrawDebugCylinder	Draws a wireframe cylinder between two points, useful for visualizing capsule collision without the hemisphere caps or a custom volume shape.
public	function	UKismetSystemLibrary::FlushDebugStrings	Removes all debug strings previously drawn with DrawDebugString in the given world, including ones still within their Duration.
public	function	UKismetSystemLibrary::FlushPersistentDebugLines	Clears every persistent debug line and shape (lines, boxes, spheres, capsules, etc.
public	function	UKismetSystemLibrary::DrawDebugCone deprecated	Draws a wireframe cone using angles in radians.
public	function	UKismetSystemLibrary::DrawDebugFloatHistoryTransform	Draws a 2D histogram graph of an FDebugFloatHistory sample buffer in the 3D world, positioned and oriented by a full transform rather than just a location.
public	function	UKismetSystemLibrary::DrawDebugFrustum	Draws a wireframe view frustum from a transform, useful for visualizing a camera's or light's projection volume.
public	function	UKismetSystemLibrary::DrawDebugPlane	Draws a finite quad patch representing an infinite mathematical plane, centered at Location and oriented by PlaneCoordinates.

Debugging

3 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::PrintWarning	Prints a warning string to both the log and the screen.
public	function	UKismetSystemLibrary::RaiseScriptError	Raises a Blueprint exception with the given message, logged to the Output and Message Log with information about where it was raised.
public	function	UKismetSystemLibrary::StackTrace	Prints a stack trace of the current Blueprint call chain to the log, showing how execution reached this node.

Development

13 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::PrintString	Prints a debug string to the screen and/or the Output Log.
public	function	UKismetSystemLibrary::PrintText	Prints a debug FText to the screen and/or the Output Log.
public	function	UKismetSystemLibrary::ExecuteConsoleCommand	Runs an arbitrary console command as if it had been typed into the in-game console.
public	function	UKismetSystemLibrary::GetBuildConfiguration	Returns the current build configuration (e.
public	function	UKismetSystemLibrary::GetBuildVersion	Returns the build version string, intended for displaying to end users in diagnostics screens or bug reports.
public	function	UKismetSystemLibrary::GetConsoleVariableBoolValue	Evaluates whether the named integer console variable currently holds a non-zero value.
public	function	UKismetSystemLibrary::GetConsoleVariableFloatValue	Retrieves the current value of a float console variable by name.
public	function	UKismetSystemLibrary::GetConsoleVariableIntValue	Retrieves the current value of an integer console variable by name.
public	function	UKismetSystemLibrary::GetConsoleVariableStringValue	Retrieves the current value of a string console variable by name.
public	function	UKismetSystemLibrary::GetEngineVersion	Returns the engine build number as a string, intended for displaying to end users (e.
public	function	UKismetSystemLibrary::IsPackagedForDistribution	Returns whether this is a build packaged for distribution (i.
public	function	UKismetSystemLibrary::QuitEditor	Closes the Unreal Editor application.
public	function	UKismetSystemLibrary::SetUserActivity	Tells the engine what the user is currently doing, for debug reporting and analytics purposes.

Float

1 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::MakeLiteralDouble	Returns the double-precision float passed in unchanged.

Flow Control

4 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::Delay	Pauses execution of the calling Blueprint graph for Duration seconds before continuing.
public	function	UKismetSystemLibrary::DelayUntilNextFrame	Pauses execution until the next engine frame, guaranteeing at least one full frame boundary is crossed before continuing.
public	function	UKismetSystemLibrary::DelayUntilNextTick	Pauses execution until the calling object's next tick.
public	function	UKismetSystemLibrary::RetriggerableDelay	Pauses execution for Duration seconds like Delay, but calling it again while already counting down resets the countdown back to Duration instead of being ignored.

Game

1 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::QuitGame	Exits the running game, either terminating the process or backgrounding the application depending on QuitPreference.

Integer

2 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::MakeLiteralInt	Returns the integer passed in unchanged.
public	function	UKismetSystemLibrary::MakeLiteralInt64	Returns the 64-bit integer passed in unchanged.

Interfaces

4 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::Conv_InterfaceToObject	Converts an interface reference back into the underlying UObject that implements it.
public	function	UKismetSystemLibrary::DoesClassImplementInterface	Checks whether a class (rather than an object instance) implements a given interface, whether native or Blueprint-defined.
public	function	UKismetSystemLibrary::DoesImplementInterface	Checks whether an object implements a given interface, whether it's a native C++ interface or a Blueprint interface.
public	function	UKismetSystemLibrary::IsValidInterface	Checks whether an interface reference has a valid underlying object, for use with Blueprint interface function calls.

Internationalization

5 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::GetDefaultLanguage	Returns the platform's default language for localization, as an IETF language tag such as "zh-Hans-CN".
public	function	UKismetSystemLibrary::GetDefaultLocale	Returns the platform's default locale for internationalization (number/date formatting, currency, etc.
public	function	UKismetSystemLibrary::GetPreferredLanguages	Returns the user's preferred languages as configured at the OS level, ordered from most to least preferred.
public	function	UKismetSystemLibrary::GetLocalCurrencyCode	Returns the ISO currency code (e.
public	function	UKismetSystemLibrary::GetLocalCurrencySymbol	Returns the currency symbol (e.

Name

1 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::MakeLiteralName	Returns the FName passed in unchanged.

Online

1 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::IsLoggedIn	Returns whether the player is logged in to the platform's active online subsystem (Steam, PSN, Xbox Live, etc.

Platform

21 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::GetDeviceId	Returns the platform-specific unique device id, replacing the deprecated GetUniqueDeviceId.
public	function	UKismetSystemLibrary::GetPlatformUserDir	Returns the current OS user's home/profile directory, as reported by the platform layer.
public	function	UKismetSystemLibrary::SetWindowTitle	Sets the title bar text of the game's application window.
public	function	UKismetSystemLibrary::ControlScreensaver	Allows or inhibits the OS screensaver, useful for keeping the screen active during idle gameplay or cutscenes.
public	function	UKismetSystemLibrary::GetGamepadButtonGlyph	Returns the platform-provided icon texture for a given gamepad button, for use in on-screen button prompts.
public	function	UKismetSystemLibrary::GetGamepadControllerName	Returns the name of the gamepad currently assigned to the given player controller ID, or "None" if no gamepad is assigned.
public	function	UKismetSystemLibrary::GetUniqueDeviceId deprecated	Returns the platform-specific unique device id.
public	function	UKismetSystemLibrary::GetVolumeButtonsHandledBySystem	Returns true if the OS is currently handling volume up/down button presses by default.
public	function	UKismetSystemLibrary::IsControllerAssignedToGamepad	Returns true if a physical gamepad is currently assigned to the given player controller ID.
public	function	UKismetSystemLibrary::IsInterstitialAdAvailable	Returns true if the interstitial ad requested via LoadInterstitialAd has finished loading and is ready to show.
public	function	UKismetSystemLibrary::IsInterstitialAdRequested	Returns true if an interstitial ad has been successfully requested from the ad network.
public	function	UKismetSystemLibrary::IsScreensaverEnabled	Returns true if the OS screensaver is currently enabled on the device.
public	function	UKismetSystemLibrary::RegisterForRemoteNotifications	Requests permission to send remote (push) notifications to the user's device.
public	function	UKismetSystemLibrary::ResetGamepadAssignments	Clears all gamepad-to-player-controller-ID assignments, so the next connected gamepad is assigned fresh.
public	function	UKismetSystemLibrary::ResetGamepadAssignmentToController	Clears the gamepad assigned to a specific player controller ID, without affecting other controllers' assignments.
public	function	UKismetSystemLibrary::SetGamepadsBlockDeviceFeedback	Sets whether attached gamepads block haptic feedback from the mobile device itself while connected.
public	function	UKismetSystemLibrary::SetVolumeButtonsHandledBySystem	Allows or inhibits the OS's default handling of the volume up/down hardware buttons.
public	function	UKismetSystemLibrary::ShowInterstitialAd	Displays the interstitial ad that was previously loaded with LoadInterstitialAd.
public	function	UKismetSystemLibrary::ShowPlatformSpecificAchievementsScreen	Opens the platform's built-in achievements UI for the given player.
public	function	UKismetSystemLibrary::ShowPlatformSpecificLeaderboardScreen	Opens the platform's built-in leaderboard UI for the given category.
public	function	UKismetSystemLibrary::UnregisterForRemoteNotifications	Requests unregistering from receiving remote (push) notifications on the user's device.

Soft References

30 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::BreakSoftClassPath	Extracts the path string out of an FSoftClassPath.
public	function	UKismetSystemLibrary::BreakSoftObjectPath	Extracts the raw path string out of a Soft Object Path struct.
public	function	UKismetSystemLibrary::BreakTopLevelAssetPath	Extracts the path string out of an FTopLevelAssetPath.
public	function	UKismetSystemLibrary::Conv_ClassToSoftClassReference	Wraps a hard class reference in a soft class reference.
public	function	UKismetSystemLibrary::Conv_ComponentReferenceToSoftComponentReference	Converts a hard FComponentReference into an FSoftComponentReference, for storage or serialization contexts that prefer a soft reference to the owning actor.
public	function	UKismetSystemLibrary::Conv_ObjectToSoftObjectReference	Wraps a hard object reference in a soft object reference.
public	function	UKismetSystemLibrary::Conv_SoftClassPathToSoftClassRef	Converts an FSoftClassPath into a base TSoftClassPtr<UObject> soft class reference.
public	function	UKismetSystemLibrary::Conv_SoftClassReferenceToClass	Resolves a soft class reference to its already-loaded class, or null if the class hasn't been loaded yet.
public	function	UKismetSystemLibrary::Conv_SoftClassReferenceToString	Converts a soft class reference directly to its path string.
public	function	UKismetSystemLibrary::Conv_SoftObjectReferenceToObject	Returns the already-loaded object a soft reference points to, or nullptr if it isn't currently loaded.
public	function	UKismetSystemLibrary::Conv_SoftObjectReferenceToString	Converts a soft object reference directly to its path string, without an intermediate FSoftObjectPath step.
public	function	UKismetSystemLibrary::Conv_SoftObjPathToSoftObjRef	Converts a Soft Object Path into a base TSoftObjectPtr<UObject> soft reference.
public	function	UKismetSystemLibrary::Conv_SoftObjRefToSoftClassPath	Converts a TSoftClassPtr<UObject> soft class reference into its underlying FSoftClassPath, which can then be used anywhere a Soft Object Path is expected.
public	function	UKismetSystemLibrary::Conv_SoftObjRefToSoftObjPath	Converts a TSoftObjectPtr<UObject> soft reference into its underlying FSoftObjectPath.
public	function	UKismetSystemLibrary::EqualEqual_SoftClassReference	Returns true if two soft class references point to the same class path (A == B).
public	function	UKismetSystemLibrary::EqualEqual_SoftObjectReference	Returns true if two soft object references point to the same asset path (A == B).
public	function	UKismetSystemLibrary::GetSoftClassTopLevelAssetPath	Converts a soft class reference to an FTopLevelAssetPath, the lightweight identifier used by asset registry and class-lookup APIs that don't need the full soft-path machinery.
public	function	UKismetSystemLibrary::IsObjectOfSoftClass	Returns true if Object is an instance of SoftClass — either the exact class, a child class, or an implemented interface.
public	function	UKismetSystemLibrary::IsValidSoftClassReference	Returns true if the soft class reference is not null, i.
public	function	UKismetSystemLibrary::IsValidSoftObjectReference	Returns true if the soft object reference is not null, i.
public	function	UKismetSystemLibrary::LoadAsset	Asynchronously loads a soft object reference without blocking the game thread, then fires OnLoaded once it completes.
public	function	UKismetSystemLibrary::LoadAsset_Blocking	Resolves a soft object reference immediately, loading the asset synchronously if it isn't already loaded.
public	function	UKismetSystemLibrary::LoadAssetClass	Asynchronously loads a soft class reference without blocking the game thread, then fires OnLoaded with the resolved class.
public	function	UKismetSystemLibrary::LoadAssets	Asynchronously loads a batch of soft object references and fires OnLoaded only once every asset in the array has finished loading.
public	function	UKismetSystemLibrary::LoadClassAsset_Blocking	Resolves a soft class reference immediately, loading the class synchronously if it isn't already loaded.
public	function	UKismetSystemLibrary::MakeSoftClassPath	Builds an FSoftClassPath from a string containing a full /folder/packagename.
public	function	UKismetSystemLibrary::MakeSoftObjectPath	Builds an FSoftObjectPath struct from a string containing a full /folder/packagename.
public	function	UKismetSystemLibrary::MakeTopLevelAssetPath	Builds an FTopLevelAssetPath from either a single full path string or a separate package name and asset name.
public	function	UKismetSystemLibrary::NotEqual_SoftClassReference	Returns true if two soft class references point to different class paths (A != B).
public	function	UKismetSystemLibrary::NotEqual_SoftObjectReference	Returns true if two soft object references point to different asset paths (A != B).

String

2 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::MakeLiteralString	Returns the FString passed in unchanged.
public	function	UKismetSystemLibrary::LogString	Writes a string to the log without printing anything to screen.

Text

1 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::MakeLiteralText	Returns the FText passed in unchanged.

Time

33 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::GetGameTimeInSeconds	Returns the current game time in seconds.
public	function	UKismetSystemLibrary::K2_ClearTimer	Stops a timer previously set with Set Timer by Function Name, identified by the same object and function name pair rather than a handle.
public	function	UKismetSystemLibrary::K2_GetTimerElapsedTime	Returns how much time has elapsed in the current iteration of the timer bound to the given object/function pair.
public	function	UKismetSystemLibrary::K2_GetTimerRemainingTime	Returns how much time is left in the current iteration of the timer bound to the given object/function pair.
public	function	UKismetSystemLibrary::K2_IsTimerActive	Returns true if a timer set with Set Timer by Function Name exists for the given object and function and is not currently paused.
public	function	UKismetSystemLibrary::K2_IsTimerPaused	Returns true if a timer set with Set Timer by Function Name exists for the given object and function and is currently paused via Pause Timer by Function Name.
public	function	UKismetSystemLibrary::K2_PauseTimer	Pauses a timer previously set with Set Timer by Function Name at its current elapsed time, identified by object and function name rather than a handle.
public	function	UKismetSystemLibrary::K2_SetTimer	This is the Blueprint 'Set Timer by Function Name' node — the standard way to schedule a delayed or repeating call to a named function on an object.
public	function	UKismetSystemLibrary::K2_TimerExists	Checks whether a timer is currently set for the given object and function pair, whether it is running or paused.
public	function	UKismetSystemLibrary::K2_UnPauseTimer	Resumes a timer previously paused with Pause Timer by Function Name, continuing from its current elapsed time rather than restarting.
public	function	UKismetSystemLibrary::K2_ClearAndInvalidateTimerHandle	Stops a set timer identified by its handle and resets the handle variable to invalid in one step.
public	function	UKismetSystemLibrary::K2_GetTimerElapsedTimeHandle	Returns how much time has elapsed in the current iteration of the timer referenced by the given handle.
public	function	UKismetSystemLibrary::K2_GetTimerRemainingTimeHandle	Returns how much time remains before the timer referenced by the given handle next fires.
public	function	UKismetSystemLibrary::K2_InvalidateTimerHandle	Resets a timer handle variable to its invalid default state and returns it for convenience.
public	function	UKismetSystemLibrary::K2_IsTimerActiveHandle	Returns true only if a timer exists for the given handle and is not currently paused.
public	function	UKismetSystemLibrary::K2_IsTimerPausedHandle	Returns true only if a timer exists for the given handle and is currently paused via Pause Timer by Handle.
public	function	UKismetSystemLibrary::K2_IsValidTimerHandle	Checks whether an FTimerHandle has ever been assigned by a Set Timer node, as opposed to being a freshly declared, never-used variable.
public	function	UKismetSystemLibrary::K2_PauseTimerHandle	Pauses a running timer at its current elapsed time without clearing it, so it can later be resumed from where it left off.
public	function	UKismetSystemLibrary::K2_SetTimerDelegate	Sets a timer that fires a bound event (a Custom Event or K2 function) after a delay.
public	function	UKismetSystemLibrary::K2_SetTimerForNextTick	Schedules a named function to run once on the very next tick, deferring execution by a single frame rather than a fixed time delay.
public	function	UKismetSystemLibrary::K2_SetTimerForNextTickDelegate	Sets a timer that fires a bound event on the very next tick, effectively a delegate-based one-frame defer.
public	function	UKismetSystemLibrary::K2_TimerExistsHandle	Returns true if the timer manager still has an entry for the given handle, whether the timer is currently active or paused.
public	function	UKismetSystemLibrary::K2_UnPauseTimerHandle	Resumes a previously paused timer from its current elapsed time, continuing toward its original fire time instead of restarting.
public	function	UKismetSystemLibrary::GetPlatformTime_Seconds	Returns the current platform time in seconds, independent of gameplay time, pausing, or slomo.
public	function	UKismetSystemLibrary::K2_ClearTimerDelegate deprecated	Clears a timer previously set for the given delegate, stopping it from firing again.
public	function	UKismetSystemLibrary::K2_ClearTimerHandle deprecated	Stops a set timer identified by its handle.
public	function	UKismetSystemLibrary::K2_GetTimerElapsedTimeDelegate deprecated	Returns how much time has elapsed in the current iteration of a timer set against a bound event delegate.
public	function	UKismetSystemLibrary::K2_GetTimerRemainingTimeDelegate deprecated	Returns how much time remains before a timer set against a bound event delegate next fires.
public	function	UKismetSystemLibrary::K2_IsTimerActiveDelegate deprecated	Returns true if a timer exists and is currently running (not paused) for the given delegate.
public	function	UKismetSystemLibrary::K2_IsTimerPausedDelegate deprecated	Returns true if a timer exists and is currently paused for the given delegate.
public	function	UKismetSystemLibrary::K2_PauseTimerDelegate deprecated	Pauses a running timer for the given delegate at its current elapsed time, leaving it resumable later.
public	function	UKismetSystemLibrary::K2_TimerExistsDelegate deprecated	Returns true if any timer, active or paused, currently exists for the given delegate.
public	function	UKismetSystemLibrary::K2_UnPauseTimerDelegate deprecated	Resumes a previously paused timer for the given delegate from its current elapsed time.

Transactions

5 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::BeginTransaction	Begins a new undo transaction, defined as all actions that take place when the user selects 'Undo' once.
public	function	UKismetSystemLibrary::CancelTransaction	Cancels the current transaction and stops capturing actions into the undo buffer.
public	function	UKismetSystemLibrary::EndTransaction	Attempts to end the current undo transaction.
public	function	UKismetSystemLibrary::SnapshotObject	Notifies the current transaction (if any) that this object should be snapshot for an intermediate update, without closing out the full undo record.
public	function	UKismetSystemLibrary::TransactObject	Notifies the current transaction (if any) that this object is about to be modified and should be recorded in the undo buffer.

Viewport

3 ▼

Access	Type	Name	Description
public	function	UKismetSystemLibrary::HasMultipleLocalPlayers	Returns whether there are currently multiple local players in the given world.
public	function	UKismetSystemLibrary::SetSuppressViewportTransitionMessage	Sets whether the viewport's blue transition text (shown when the game is paused or loading) is suppressed.
public	function	UKismetSystemLibrary::IsSplitScreen deprecated	Returns whether there are currently multiple local players.

Version History

Introduced in: 4.0

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?