1. Epic GamesDeveloper
  3. UCheatManager

UCheatManager

Cheat Manager is a central blueprint to implement test and debug code and actions that are not to ship with the game.

Unreal Engine C++ API Reference > Runtime > Engine > GameFramework

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/GameFramework/CheatManager.h
Include #include "GameFramework/CheatManager.h"

Syntax

UCLASS (Blueprintable, Within=PlayerController, MinimalAPI)  
class UCheatManager : public UObject

Remarks

Cheat Manager is a central blueprint to implement test and debug code and actions that are not to ship with the game. As the Cheat Manager is not instanced in shipping builds, it is for debugging purposes only

Variables

  Type Name Description
Public variable uint32: 1 bDebugCapsuleSweep Trace/Sweep debug start.
Public variable uint32: 1 bDebugCapsuleTraceComplex If we should trace complex collision in debug capsule sweeps.
Public variable uint32: 1 bToggleAILogging Holds information if we used ToggleAILogging cheat to activate AI logging
Protected variable UProperty Transient TArray< TObjectPtr< UCheatManagerExtension > > CheatManagerExtensions List of registered cheat manager extensions
Public variable int32 CurrentTraceIndex Index of the array for current trace to overwrite.
Public variable int32 CurrentTracePawnIndex Index of the array for current trace to overwrite.
Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly TSubclassOf< class ADebugCameraController > DebugCameraControllerClass Debug camera - used to have independent camera without stopping gameplay
Public variable UProperty TObjectPtr< class ADebugCameraController > DebugCameraControllerRef Debug camera - used to have independent camera without stopping gameplay
Public variable float DebugCapsuleHalfHeight Half distance between debug capsule sphere ends.
Public variable float DebugCapsuleRadius Radius of debug capsule
Public variable TEnumAsByte< enum ECollisionChannel > DebugTraceChannel What channel are we tracing
Public variable float DebugTraceDistance How far debug trace should go out from player viewpoint
Public variable float DebugTraceDrawNormalLength How long to draw the normal result
Public variable TArray< struct FDebugTraceInfo > DebugTraceInfoList Array of information for capturing
Public variable TArray< struct FDebugTraceInfo > DebugTracePawnInfoList Array of information for capturing

Constructors

  Type Name Description
Public function  

UCheatManager ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AddCapsuleSweepDebugInfo ( const FVector& LineTraceStart,
const FVector& LineTraceEnd,
const FVector& HitImpactLocation,
const FVector& HitNormal,
const FVector& HitImpactNormal,
const FVector& HitLocation,
float CapsuleHalfheight,
float CapsuleRadius,
bool bTracePawn,
bool bInsideOfObject
)

 Add Debug Trace info into current index - used when DebugCapsuleSweepPawn is on
Public function void Registers a cheat manager extension with this cheat manager
Public function Virtual UFunction exec void

BugIt ( const FString& ScreenShotDescription
)

 This function is used to print out the BugIt location.
Public function Virtual UFunction exec void

BugItGo ( float X,
float Y,
float Z,
float Pitch,
float Yaw,
float Roll
)

 This will move the player and set their rotation to the passed in values.
Public function Virtual void

BugItGoString ( const FString& TheLocation,
const FString& TheRotation
)

 This will move the player and set their rotation to the passed in values.
Public function Virtual UFunction exec void

BugItStringCreator ( FVector ViewLocation,
FRotator ViewRotation,
FString& GoString,
FString& LocString
)

 This will create a BugItGo string for us.
Public function Virtual void

BugItWorker ( FVector TheLocation,
FRotator TheRotation
)

 This will move the player and set their rotation to the passed in values.
Public function Virtual UFunction BlueprintCallable, Category exec void

ChangeSize ( float F
)

 Scale the player's size to be F * default size.
Public function UFunction exec void

CheatScript ( FString ScriptName
)

 Executes commands listed in CheatScript.ScriptName ini section of DefaultGame.ini
Public function Virtual UFunction BlueprintCallable, Category exec void

DamageTarget ( float DamageAmount
)

 Damage the actor you're looking at (sourced from the player).
Public function Virtual UFunction exec void Toggle capsule trace debugging.
Public function Virtual UFunction exec void Capture current trace and add to persistent list
Public function Virtual UFunction exec void Change Trace Channel
Public function Virtual UFunction exec void Clear persistent list for trace capture
Public function Virtual UFunction exec void

DebugCapsuleSweepComplex ( bool bTraceComplex
)

 Change Trace Complex setting
Public function Virtual UFunction exec void Capture current local PC's pawn's location and add to persistent list
Public function Virtual UFunction exec void

DebugCapsuleSweepSize ( float HalfHeight,
float Radius
)

 Change Trace capsule size
Public function Virtual UFunction exec void

DestroyAll ( TSubclassOf< class AActor > aClass
)

 Destroy all actors of class aClass
Public function Virtual UFunction exec void Destroy all pawns except for the (pawn) target.
Public function Virtual UFunction exec void

DestroyPawns ( TSubclassOf< class APawn > aClass
)

 Destroys (by calling destroy directly) all non-player pawns of class aClass in the level
Public function UFunction exec void  
Public function Virtual UFunction BlueprintCallable, Category exec void Destroy the actor you're looking at.
Protected function Virtual UFunction BlueprintCallable, Category void Switch controller from debug camera back to normal controller
Protected function Virtual bool Do game specific bugIt
Public function Virtual UFunction exec void Dump known chat information
Public function Virtual UFunction exec void Dump online session information
Public function Virtual UFunction exec void Dump known party information
Public function Virtual UFunction exec void Dump current state of voice chat
Protected function Virtual UFunction BlueprintCallable, Category void Switch controller to debug camera without locking gameplay and with locking local player controller input
Public function Const UCheatManagerExtension *

FindCheatManagerExtension ( const UClass* InClass
)

 Finds a previously registered cheat manager extension of the specified class
Public function Const T * Finds a previously registered cheat manager extension of the specified class
Public function Const T * Finds a previously registered cheat manager extension that implements the specified interface
Public function Const UCheatManagerExtension * Finds a previously registered cheat manager extension that implements the specified interface
Public function Virtual UFunction exec void This will force a flush of the output log to file
Public function Virtual UFunction BlueprintCallable, Category exec void

Fly ()

 Pawn can fly.
Public function Virtual UFunction BlueprintCallable, Category exec void

FreezeFrame ( float Delay
)

 Pause the game for Delay seconds.
Public function Const UFunction BlueprintPure, Category APlayerController *  
Protected function Virtual AActor *

GetTarget ( APlayerController* PlayerController,
FHitResult& OutHit
)

 Retrieve the given PlayerContoller's current "target" AActor.
Public function Virtual Const UWorld * Use the Outer Player Controller to get a World.
Public function Virtual UFunction BlueprintCallable, Category exec void

Ghost ()

 Pawn no longer collides with the world, and can fly
Public function Virtual UFunction BlueprintCallable, Category exec void

God ()

 Invulnerability cheat.
Public function Virtual void Called when CheatManager is created to allow any needed initialization.
Public function Virtual UFunction exec void Backwards compatibility exec function for people used to it instead of using InvertAxisKey
Public function Virtual Const bool Returns true if the player currently has a debug camera
Public function Static bool Return true if debug sweeps are enabled for pawns.
Public function Virtual UFunction exec void

LogLoc ()

 Logs the current location in bugit format without taking screenshot and further routing.
Public function Virtual void

LogOutBugItGoToLogFile ( const FString& InScreenShotDesc,
const FString& InScreenShotPath,
const FString& InGoString,
const FString& InLocString
)

 Bug it log to file
Public function Virtual UFunction exec void

OnlyLoadLevel ( FName PackageName
)

 Load the given level.
Public function UFunction void

OnPlayerEndPlayed ( AActor* Player,
EEndPlayReason::Type EndPlayReason
)

  
Public function Virtual UFunction BlueprintCallable, Category exec void Freeze everything in the level except for players.
Public function UFunction Meta, BlueprintImplementableEvent void This is the End Play event for the CheatManager
Public function UFunction Meta, BlueprintImplementableEvent void BP implementable event for when CheatManager is created to allow any needed initialization.
Public function Static FDelegateHandle

RegisterForOnCheatManagerCreated ( FOnCheatManagerCreated::FDelegate&& Delegate
)

 Register a delegate to call whenever a cheat manager is spawned; it will also be called immediately for cheat managers that already exist at this point
Public function void Removes a cheat manager extension from this cheat manager
Public function Virtual UFunction Server, Reliable withvalidation void  
Public function Virtual void

SetLevelStreamingStatus ( FName PackageName,
bool bShouldBeLoaded,
bool bShouldBeVisible
)

 Streaming level debugging
Public function Virtual UFunction exec void Exec function to return the mouse sensitivity to its default value
Public function UFunction exec void Translate world origin to this player position
Public function Virtual UFunction BlueprintCallable, Category exec void

Slomo ( float NewTimeDilation
)

 Modify time dilation to change apparent speed of passage of time.
Public function UFunction exec void  
Public function Virtual UFunction exec void

StreamLevelIn ( FName PackageName
)

 Stream in the given level.
Public function Virtual UFunction exec void

StreamLevelOut ( FName PackageName
)

 Stream out the given level.
Public function Virtual UFunction exec void

Summon ( const FString& ClassName
)

 Load Classname and spawn an actor of that class
Public function Virtual UFunction BlueprintCallable, Category exec void Teleport to surface player is looking at.
Public function Virtual UFunction exec void Test all volumes in the world to the player controller's view location
Public function void Do any trace debugging that is currently enabled
Public function Virtual UFunction exec void Toggles AI logging
Public function Virtual UFunction exec void Toggle between debug camera/player camera without locking gameplay and with locking local player controller input.
Public function UFunction exec void  
Public function UFunction exec void  
Public function Static void Unregister a delegate previously registered with CallOrRegister_OnCheatManagerCreated
Public function UFunction exec void  
Public function Virtual UFunction exec void

ViewActor ( FName ActorName
)

 View from the point of view of AActor with Name ActorName.
Public function Virtual UFunction exec void

ViewClass ( TSubclassOf< class AActor > DesiredClass
)

 View from the point of view of an AActor of class DesiredClass.
Public function Virtual UFunction exec void

ViewPlayer ( const FString& S
)

 View from the point of view of player with PlayerName S.
Public function Virtual UFunction exec void Make controlled pawn the viewtarget again.
Public function Virtual UFunction BlueprintCallable, Category exec void

Walk ()

 Return to walking movement mode from Fly or Ghost cheat.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual bool

ProcessConsoleExec ( const TCHAR* Cmd,
FOutputDevice& Ar,
UObject* Executor
)

 This function handles a console exec sent to the object; it is virtual so 'nexus' objects like a player controller can reroute the command to several different objects.

Constants

Name Description
bDebugCapsuleSweepPawn If we should should perform a debug capsule trace for pawns and draw results.
OnCheatManagerCreatedDelegate Delegate called when the asset manager singleton is created

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page
Back to top
Games
Marketplaces
Tools
Online Services
Resources
Company

© 2004-2025, Epic Games, Inc. All rights reserved. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.