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 (15)

Damage 1 Audio 2 Utility 8 SaveGame 4

Damage

1 ▼

Access	Type	Name	Description
public	function	UGameplayStatics::ApplyDamage	Applies point damage to an actor by calling its TakeDamage event.

Audio

2 ▼

Access	Type	Name	Description
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.

Utility

8 ▼

Access	Type	Name	Description
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::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::OpenLevel	Travels to a new level by name, unloading the current world.
public	function	UGameplayStatics::SpawnActor (Spawn Actor from Class)	There is no UGameplayStatics::SpawnActor function.

SaveGame

4 ▼

Access	Type	Name	Description
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.

Version History

Introduced in: unknown

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?