UGameplayStatics

class Engine Blueprint Since unknown

Inherits: UObject › UBlueprintFunctionLibrary

#include "Kismet/GameplayStatics.h"

Description

A Blueprint function library providing static utility functions for common gameplay operations: actor spawning, player access, damage, audio, level loading, and save games. All functions are accessible without a class instance.

Caveats & Gotchas

• Most functions require a WorldContextObject (typically pass 'this' from an Actor or Component). Passing an invalid context silently returns null or no-ops.
• These are Blueprint-friendly wrappers. C++ code often has more direct and performant alternatives (e.g. UWorld::SpawnActor instead of the deferred spawn path, GetWorld()->GetFirstPlayerController instead of GetPlayerController(this, 0)).
• Functions that return AActor* (GetActorOfClass, GetPlayerPawn, etc.) can return null — always validate with IsValid() before use.

Example

Common one-liners C++

// Get player controller (single-player)
APlayerController* PC = UGameplayStatics::GetPlayerController(this, 0);

// Play a sound at a location
UGameplayStatics::PlaySoundAtLocation(this, ExplosionSound, GetActorLocation());

// Load a level
UGameplayStatics::OpenLevel(this, FName("MainMenu"));

Functions (142)

Collision

4 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::BreakHitResult	Decomposes an FHitResult struct into its individual fields.
public	function	UGameplayStatics::GetSurfaceType	Extracts the EPhysicalSurface enum value from the physical material of a hit result.
public	function	UGameplayStatics::MakeHitResult	Constructs an FHitResult from individual fields.
public	function	UGameplayStatics::FindCollisionUV	Returns the UV texture coordinate at the impact point of a collision hit.

Damage

3 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::ApplyPointDamage	Deals point damage to a specific actor, including directional hit information.
public	function	UGameplayStatics::ApplyDamage	Applies point damage to an actor by calling its TakeDamage event.
public	function	UGameplayStatics::ApplyRadialDamageWithFalloff	Applies radial damage with a configurable falloff curve from a full-damage inner radius to a minimum-damage outer radius.

Input

2 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::GetViewportMouseCaptureMode	Returns the current mouse capture mode of the game viewport, indicating how the cursor is constrained during gameplay.
public	function	UGameplayStatics::SetViewportMouseCaptureMode	Sets how the game viewport captures the mouse cursor.

Networking

3 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::GetNumPlayerStates	Returns the number of entries in the game state's PlayerArray, which equals the number of connected players — local and remote — on both client and server.
public	function	UGameplayStatics::GetPlayerState	Returns the APlayerState at the given index in the game state's PlayerArray.
public	function	UGameplayStatics::GetPlayerStateFromUniqueNetId	Finds and returns the APlayerState whose unique online ID matches the given FUniqueNetIdRepl, or null if no match is found.

Rendering

6 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::PlayWorldCameraShake	Triggers a camera shake for all local players whose cameras are within OuterRadius of the Epicenter.
public	function	UGameplayStatics::SpawnDecalAtLocation	Spawns a decal projector at a fixed world position.
public	function	UGameplayStatics::SpawnDecalAttached	Spawns a decal projector that follows an attached component, such as a bone on a skeletal mesh.
public	function	UGameplayStatics::IsAnyLocalPlayerCameraWithinRange	Returns true if any local player's camera is within MaximumRange of the specified world location.
public	function	UGameplayStatics::GetEnableWorldRendering	Returns whether world rendering is currently enabled on the local viewport.
public	function	UGameplayStatics::SetEnableWorldRendering	Enables or disables rendering of the entire game world.

Audio

35 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::AreSubtitlesEnabled	Returns whether subtitle rendering is currently enabled globally.
public	function	UGameplayStatics::SpawnSound2D	Spawns an audio component that plays a non-spatialized (2D) sound with no attenuation.
public	function	UGameplayStatics::SpawnSoundAtLocation	Spawns a spatialized audio component at a fixed world location and begins playback immediately.
public	function	UGameplayStatics::SpawnSoundAttached	Spawns a spatialized UAudioComponent attached to a scene component so it follows it through the world.
public	function	UGameplayStatics::ActivateReverbEffect	Applies a Reverb Effect globally without requiring an Audio Volume in the level.
public	function	UGameplayStatics::AreAnyListenersWithinRange	Returns true if at least one audio listener (typically the player camera) is within MaximumRange of Location.
public	function	UGameplayStatics::ClearSoundMixClassOverride	Removes a per-class volume/pitch override that was previously applied to a Sound Mix via SetSoundMixClassOverride, fading back to the unoverridden values.
public	function	UGameplayStatics::ClearSoundMixModifiers	Immediately removes all active Sound Mix Modifiers from the audio system regardless of their push counts.
public	function	UGameplayStatics::CreateSound2D	Creates a non-spatialized, non-attenuated UAudioComponent without immediately starting playback, useful when you need to configure the component before playing.
public	function	UGameplayStatics::DeactivateReverbEffect	Removes a manually activated Reverb Effect identified by its tag, fading it out using the fade time set on the effect asset.
public	function	UGameplayStatics::GetClosestListenerLocation	Finds the closest audio listener within MaximumRange of Location and writes its position to ListenerPosition.
public	function	UGameplayStatics::GetCurrentReverbEffect	Returns the highest-priority reverb effect currently active, whether it came from an Audio Volume or was activated manually.
public	function	UGameplayStatics::PlayDialogue2D	Plays a UDialogueWave at 2D (non-spatialized) volume, suitable for UI or cinematic dialogue where positional audio is not needed.
public	function	UGameplayStatics::PlayDialogueAtLocation	Plays a UDialogueWave at a fixed world location with spatialization and attenuation.
public	function	UGameplayStatics::PlaySound2D	Plays a non-spatialized (2D) sound that is not affected by the listener's position or orientation.
public	function	UGameplayStatics::PlaySoundAtLocation	Plays a one-shot sound at a world position with 3D attenuation.
public	function	UGameplayStatics::PopSoundMixModifier	Decrements the active count of a Sound Mix Modifier and deactivates it when the count reaches zero.
public	function	UGameplayStatics::PushSoundMixModifier	Activates a Sound Mix Modifier on the audio system, applying its volume and pitch adjustments to the Sound Classes it targets.
public	function	UGameplayStatics::SetBaseSoundMix	Sets the active base sound mix for the audio engine, applying the EQ and volume/pitch adjustments defined in the mix asset globally.
public	function	UGameplayStatics::SetGlobalPitchModulation	Globally scales the pitch of all non-UI sounds, interpolating from the current value over TimeSec seconds.
public	function	UGameplayStatics::SetSoundMixClassOverride	Adds or replaces a sound class adjuster in an active sound mix at runtime, allowing volume and pitch of an entire sound class to be changed dynamically with a smooth fade.
public	function	UGameplayStatics::SetSubtitlesEnabled	Globally enables or disables subtitle rendering for all dialogue and sound waves that carry subtitle data.
public	function	UGameplayStatics::SpawnDialogue2D	Creates and plays a 2D (non-spatialized) UAudioComponent for a UDialogueWave, returning the component for runtime control such as stopping or fading.
public	function	UGameplayStatics::SpawnDialogueAtLocation	Spawns a spatialized UAudioComponent for a UDialogueWave at a fixed world position, begins playback, and returns the component for runtime control.
public	function	UGameplayStatics::SpawnDialogueAttached	Spawns a UAudioComponent for a UDialogueWave attached to a scene component so the dialogue source follows the component through the world.
public	function	UGameplayStatics::GetActiveSpatialPluginName	Returns the name of the currently active audio spatialization plugin for the world's audio device.
public	function	UGameplayStatics::GetAvailableSpatialPluginNames	Returns the names of all audio spatialization plugins that are loaded and available in the current session.
public	function	UGameplayStatics::GetMaxAudioChannelCount	Returns the effective maximum number of concurrent audio voices after applying any active scale set by SetMaxAudioChannelsScaled.
public	function	UGameplayStatics::PrimeAllSoundsInSoundClass	Iterates all streaming sound waves belonging to the given sound class and caches their first audio chunk to reduce first-play hitches.
public	function	UGameplayStatics::PrimeSound	Pre-caches the first compressed audio chunk of a streaming sound to eliminate the hitch that occurs the first time it plays.
public	function	UGameplayStatics::SetActiveSpatialPluginByName	Switches the active audio spatialization plugin at runtime to the one identified by name.
public	function	UGameplayStatics::SetGlobalListenerFocusParameters	Sets global listener focus parameters that scale how the audio system distinguishes sounds in front of the listener ('focused') from those outside the focus cone ('non-focused').
public	function	UGameplayStatics::SetMaxAudioChannelsScaled	Dynamically scales the maximum number of concurrent audio voices as a fraction of the engine's configured maximum.
public	function	UGameplayStatics::SetSoundClassDistanceScale	Scales the attenuation distance of all sounds belonging to a given SoundClass, optionally interpolating over time.
public	function	UGameplayStatics::UnRetainAllSoundsInSoundClass	Releases the retained streaming chunk handles for all sound waves in the given sound class, making those chunks eligible for eviction from the audio streaming cache.

Tags

2 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::GetAllActorsOfClassWithTag	Finds all actors of the specified class that also carry the given actor tag.
public	function	UGameplayStatics::GetAllActorsWithTag	Populates OutActors with every actor in the world that has the given tag in its Tags array.

Utility

26 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::FindNearestActor	Returns the actor from ActorsToCheck whose GetActorLocation() is closest to Origin, and outputs the distance to it.
public	function	UGameplayStatics::GetActorArrayAverageLocation	Returns the arithmetic mean (centroid) of the world locations of all actors in the array.
public	function	UGameplayStatics::GetActorArrayBounds	Computes the combined axis-aligned bounding box of an array of actors, returning the box centre and half-extents.
public	function	UGameplayStatics::GetObjectClass	Returns the UClass of the passed-in object.
public	function	UGameplayStatics::GetPlatformName	Returns the string name of the current platform (e.
public	function	UGameplayStatics::IsGamePaused	Returns whether the game is currently paused.
public	function	UGameplayStatics::ObjectIsA	Returns true if the given object is an instance of (or inherits from) the specified class.
public	function	UGameplayStatics::SetGamePaused	Pauses or unpauses the game.
public	function	UGameplayStatics::AnnounceAccessibleString	Sends a string to the platform's screen reader or accessibility announcement system when accessibility is enabled.
public	function	UGameplayStatics::ApplyRadialDamage	Applies radial damage to all actors within DamageRadius of Origin, optionally with distance falloff and line-of-sight checks.
public	function	UGameplayStatics::GetActorOfClass	Returns the first actor of the given class found in the world, or null if none exists.
public	function	UGameplayStatics::GetAllActorsOfClass	Fills OutActors with all actors of the given class currently in the world.
public	function	UGameplayStatics::GetIntOption	Looks up a key in a URL options string and returns its value parsed as a 32-bit integer.
public	function	UGameplayStatics::GetKeyValue	Splits a single key=value pair string into its key and value components.
public	function	UGameplayStatics::GetPlayerCharacter	Returns the ACharacter possessed by the given local player controller, or null if the controller has no pawn or the pawn is not an ACharacter.
public	function	UGameplayStatics::GetPlayerController	Returns the APlayerController for the given local player index, or null if no controller exists at that index.
public	function	UGameplayStatics::GetPlayerPawn	Returns the APawn possessed by the given local player controller.
public	function	UGameplayStatics::HasLaunchOption	Returns true if a specific option was passed on the process command line at launch (e.
public	function	UGameplayStatics::HasOption	Returns true if the specified key exists anywhere in a URL options string, regardless of its associated value.
public	function	UGameplayStatics::IsSplitscreenForceDisabled	Returns true if splitscreen has been forcibly disabled via SetForceDisableSplitscreen.
public	function	UGameplayStatics::OpenLevel	Travels to a new level by name, unloading the current world.
public	function	UGameplayStatics::ParseOption	Searches a URL-style options string for a key and returns its value as a string.
public	function	UGameplayStatics::SetForceDisableSplitscreen	Forces the viewport to suppress splitscreen layout regardless of the number of local players.
public	function	UGameplayStatics::SetGlobalTimeDilation	Sets the global time dilation, scaling how fast time advances for the entire game world.
public	function	UGameplayStatics::SpawnActor (Spawn Actor from Class)	There is no UGameplayStatics::SpawnActor function.
public	function	UGameplayStatics::EnableLiveStreaming	Toggles live DVR streaming on platforms that support it (primarily consoles).

Actor

1 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::GetAllActorsWithInterface	Finds every actor in the world that implements the specified UInterface.

Camera

6 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::DeprojectSceneCaptureComponentToWorld	Converts a UV coordinate in a USceneCaptureComponent2D render target into a world-space position and ray.
public	function	UGameplayStatics::DeprojectSceneCaptureToWorld	Converts a UV coordinate in a SceneCapture2D render target into a world-space position and ray direction.
public	function	UGameplayStatics::DeprojectScreenToWorld	Converts a 2D screen-space pixel coordinate into a world-space position and direction ray.
public	function	UGameplayStatics::ProjectWorldToScreen	Projects a 3D world-space position onto the player's screen, returning the 2D pixel coordinate.
public	function	UGameplayStatics::GetViewProjectionMatrix	Computes the View, Projection, and combined ViewProjection matrices for a given FMinimalViewInfo.
public	function	UGameplayStatics::TransformWorldToFirstPerson	Transforms a world-space position into first-person view space, replicating the GPU-side morphing applied to first-person primitives.

Effects

2 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::SpawnEmitterAtLocation	Spawns a Cascade (Legacy) particle system at a world location as a fire-and-forget effect.
public	function	UGameplayStatics::SpawnEmitterAttached	Spawns a Cascade particle system attached to a scene component or socket, so the effect follows the component's movement.

Foliage

1 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::GrassOverlappingSphereCount	Returns the number of procedural grass foliage instances of a given static mesh that overlap a sphere.

ForceFeedback

2 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::SpawnForceFeedbackAtLocation	Spawns a UForceFeedbackComponent at a world location and begins playback, routing vibration to controllers whose players are within the attenuation range.
public	function	UGameplayStatics::SpawnForceFeedbackAttached	Spawns a UForceFeedbackComponent attached to a scene component so vibration is routed based on the moving component's position relative to local players.

Game

8 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::GetGameInstance	Returns the UGameInstance for the current world.
public	function	UGameplayStatics::GetGameMode	Returns the current GameModeBase for the world, or null if unavailable.
public	function	UGameplayStatics::GetGameState	Returns the current GameStateBase for the world, or null if it cannot be retrieved.
public	function	UGameplayStatics::GetPlayerCameraManager	Returns the APlayerCameraManager for the player controller at the given index.
public	function	UGameplayStatics::GetNumLocalPlayerControllers	Returns the count of fully initialized local player controllers.
public	function	UGameplayStatics::GetNumPlayerControllers	Returns the total number of player controllers available in the world, including remote player controllers when called on a server.
public	function	UGameplayStatics::GetPlayerControllerFromID	Returns the local player controller associated with the given physical input controller ID.
public	function	UGameplayStatics::GetPlayerControllerFromPlatformUser	Returns the local player controller associated with the given FPlatformUserId.

Level Streaming

9 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::GetCurrentLevelName	Returns the name of the currently active (persistent) level.
public	function	UGameplayStatics::FlushLevelStreaming	Blocks the game thread until all pending level streaming operations (loads, unloads, visibility changes) are fully complete.
public	function	UGameplayStatics::GetStreamingLevel	Returns the ULevelStreaming object for a given level package name, allowing you to inspect or modify streaming state, visibility, and load status at runtime.
public	function	UGameplayStatics::LoadStreamLevel	Asynchronously streams a sub-level into the world by name.
public	function	UGameplayStatics::LoadStreamLevelBySoftObjectPtr	Streams a sub-level into the world using a soft object reference rather than a name string, making it refactor-safe and easier to use in data-driven systems.
public	function	UGameplayStatics::OpenLevelBySoftObjectPtr	Performs a full level travel to a world asset specified by a soft object pointer, offering type-safe level navigation compared to the name-based OpenLevel.
public	function	UGameplayStatics::UnloadStreamLevel	Removes a previously streamed-in sub-level from the world by name, freeing its memory and actors.
public	function	UGameplayStatics::UnloadStreamLevelBySoftObjectPtr	Unloads a previously streamed-in sub-level identified by a soft object pointer, providing a type-safe and refactor-friendly alternative to the name-based unload.
public	function	UGameplayStatics::CancelAsyncLoading	Cancels all currently queued asynchronous package loading requests.

Player

6 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::CreatePlayer	Creates a new local player and optionally spawns a PlayerController for it, used for local multiplayer (split-screen) scenarios.
public	function	UGameplayStatics::GetPlayerControllerID	Returns the physical controller ID assigned to a local PlayerController.
public	function	UGameplayStatics::RemovePlayer	Removes a local player from the game, cleaning up their PlayerController and optionally their pawn.
public	function	UGameplayStatics::SetPlayerControllerID	Assigns a physical controller device ID to a local PlayerController, used when remapping which gamepad drives which player in split-screen games.
public	function	UGameplayStatics::CreatePlayerFromPlatformUser	Creates a new local player identified by a platform user ID rather than a numeric controller index, enabling proper platform account association for console and PC online play.
public	function	UGameplayStatics::SetPlayerPlatformUserId	Associates a platform user account ID with a local PlayerController, used to link online identity (achievements, cloud saves) to a specific local player slot.

Projectile

6 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::Blueprint_PredictProjectilePath_ByObjectType	Simulates a projectile arc under gravity and returns the full path as an array of positions, optionally tracing against specified object types to detect collisions.
public	function	UGameplayStatics::Blueprint_PredictProjectilePath_ByTraceChannel	Simulates a projectile arc under gravity and returns the path positions, tracing against a single collision channel for blocking hits.
public	function	UGameplayStatics::BlueprintSuggestProjectileVelocity	Calculates a launch velocity for a projectile to travel from StartLocation to EndLocation at the given launch speed under gravity.
public	function	UGameplayStatics::SuggestProjectileVelocity_CustomArc	Calculates a launch velocity for a projectile at rest at StartPos to land at EndPos, using an artist-controlled arc parameter rather than a fixed launch speed.
public	function	UGameplayStatics::Blueprint_PredictProjectilePath_Advanced	Predicts a projectile arc using a params struct, providing the richest output of the three prediction variants — each path point includes velocity and time in addition to position.
public	function	UGameplayStatics::SuggestProjectileVelocity_MovingTarget	Calculates a launch velocity to intercept a moving actor in exactly TimeToTarget seconds, assuming the target moves at constant velocity and the projectile is affected only by gravity.

SaveGame

5 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::DeleteGameInSlot	Deletes the save game file associated with a given slot name.
public	function	UGameplayStatics::CreateSaveGameObject	Creates a new instance of a USaveGame subclass with default values.
public	function	UGameplayStatics::DoesSaveGameExist	Returns true if a save file exists for the given slot name and user index.
public	function	UGameplayStatics::LoadGameFromSlot	Deserialises a save file from disk and returns a USaveGame object, or null if the slot doesn't exist or loading fails.
public	function	UGameplayStatics::SaveGameToSlot	Serialises a USaveGame object to disk using the platform's save system.

Spawning

4 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::BeginDeferredActorSpawnFromClass	Begins a two-phase actor spawn, returning an uninitialized actor so you can set properties before the construction script runs.
public	function	UGameplayStatics::BeginSpawningActorFromBlueprint deprecated	Deprecated.
public	function	UGameplayStatics::FinishSpawningActor	Completes a deferred actor spawn started by BeginDeferredActorSpawnFromClass, running the construction script and calling BeginPlay.
public	function	UGameplayStatics::SpawnObject	Creates a new UObject instance of the given class with the specified outer.

Time

3 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::GetAudioTimeSeconds	Returns time in seconds since the world was brought up for play, stopped when the game is paused, and not dilated or clamped by time dilation.
public	function	UGameplayStatics::GetAccurateRealTime	Returns the time in seconds since the application was started, sampled at the exact moment this function is called rather than once per frame.
public	function	UGameplayStatics::GetGlobalTimeDilation	Returns the current global time dilation factor for the world.

Utilities

4 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::GetTimeSeconds	Returns elapsed time in seconds since the world started, adjusted by time dilation.
public	function	UGameplayStatics::GetWorldDeltaSeconds	Returns the elapsed time in seconds since the last frame, scaled by time dilation.
public	function	UGameplayStatics::GetRealTimeSeconds	Returns elapsed time in seconds since the world started, unaffected by time dilation and not stopped when the game is paused.
public	function	UGameplayStatics::GetUnpausedTimeSeconds	Returns elapsed time in seconds since the world started, adjusted by time dilation but continuing to advance while the game is paused.

World Origin

4 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::GetWorldOriginLocation	Returns the current world origin location as an integer vector in world space.
public	function	UGameplayStatics::RebaseLocalOriginOntoZero	Converts a local world-space position (relative to the current shifted origin) into an absolute origin-based position suitable for storage or network transmission.
public	function	UGameplayStatics::RebaseZeroOriginOntoLocal	Converts an absolute origin-based position (e.
public	function	UGameplayStatics::SetWorldOriginLocation	Requests a shift of the world origin to the given integer location.

Version History

Introduced in: unknown

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?