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.

API > API/Runtime > API/Runtime/Engine

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

   
Name UCheatManager
Type class
Header File /Engine/Source/Runtime/Engine/Classes/GameFramework/CheatManager.h
Include Path #include "GameFramework/CheatManager.h"

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCheatManager ( const FObjectInitializer& ObjectInitializer
)

   GameFramework/CheatManager.h  

Constants

Name Type Remarks Include Path
bDebugCapsuleSweepPawn bool If we should should perform a debug capsule trace for pawns and draw results. GameFramework/CheatManager.h
OnCheatManagerCreatedDelegate FOnCheatManagerCreated Delegate called when the asset manager singleton is created GameFramework/CheatManager.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bDebugCapsuleSweep uint32 Trace/Sweep debug start. GameFramework/CheatManager.h  
bDebugCapsuleTraceComplex uint32 If we should trace complex collision in debug capsule sweeps. Set with DebugCapsuleSweepComplex() GameFramework/CheatManager.h  
bToggleAILogging uint32 Holds information if we used ToggleAILogging cheat to activate AI logging GameFramework/CheatManager.h  
CurrentTraceIndex int32 Index of the array for current trace to overwrite. GameFramework/CheatManager.h  
CurrentTracePawnIndex int32 Index of the array for current trace to overwrite. GameFramework/CheatManager.h  
DebugCameraControllerClass TSubclassOf< class ADebugCameraController > Debug camera - used to have independent camera without stopping gameplay GameFramework/CheatManager.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Debug Camera"
DebugCameraControllerRef TObjectPtr< class ADebugCameraController > Debug camera - used to have independent camera without stopping gameplay GameFramework/CheatManager.h  
DebugCapsuleHalfHeight float Half distance between debug capsule sphere ends. GameFramework/CheatManager.h  
DebugCapsuleRadius float Radius of debug capsule GameFramework/CheatManager.h  
DebugTraceChannel TEnumAsByte< enum ECollisionChannel > What channel are we tracing GameFramework/CheatManager.h  
DebugTraceDistance float How far debug trace should go out from player viewpoint GameFramework/CheatManager.h  
DebugTraceDrawNormalLength float How long to draw the normal result GameFramework/CheatManager.h  
DebugTraceInfoList TArray< struct FDebugTraceInfo > Array of information for capturing GameFramework/CheatManager.h  
DebugTracePawnInfoList TArray< struct FDebugTraceInfo > Array of information for capturing GameFramework/CheatManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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 GameFramework/CheatManager.h  

void AddCheatManagerExtension ( UCheatManagerExtension* CheatObject
)

 Registers a cheat manager extension with this cheat manager GameFramework/CheatManager.h  

virtual void BugIt ( const FString& ScreenShotDescription
)

 This function is used to print out the BugIt location. GameFramework/CheatManager.h
  • Exec

virtual 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. GameFramework/CheatManager.h
  • Exec

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

 This will move the player and set their rotation to the passed in values. GameFramework/CheatManager.h  

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

 This will create a BugItGo string for us. GameFramework/CheatManager.h
  • Exec

virtual void BugItWorker ( FVector TheLocation,
FRotator TheRotation
)

 This will move the player and set their rotation to the passed in values. GameFramework/CheatManager.h  

virtual void ChangeSize ( float F
)

 Scale the player's size to be F * default size. GameFramework/CheatManager.h
  • Exec
  • BlueprintCallable
  • Category="Cheat Manager"

void CheatScript ( FString ScriptName
)

 Executes commands listed in CheatScript.ScriptName ini section of DefaultGame.ini GameFramework/CheatManager.h
  • Exec

virtual void DamageTarget ( float DamageAmount
)

 Damage the actor you're looking at (sourced from the player). GameFramework/CheatManager.h
  • Exec
  • BlueprintCallable
  • Category="Cheat Manager"

virtual void DebugCapsuleSweep ()

 Toggle capsule trace debugging. GameFramework/CheatManager.h
  • Exec

virtual void DebugCapsuleSweepCapture()

 Capture current trace and add to persistent list GameFramework/CheatManager.h
  • Exec

virtual void DebugCapsuleSweepChannel ( enum ECollisionChannel Channel
)

 Change Trace Channel GameFramework/CheatManager.h
  • Exec

virtual void DebugCapsuleSweepClear()

 Clear persistent list for trace capture GameFramework/CheatManager.h
  • Exec

virtual void DebugCapsuleSweepComplex ( bool bTraceComplex
)

 Change Trace Complex setting GameFramework/CheatManager.h
  • Exec

virtual void DebugCapsuleSweepPawn()

 Capture current local PC's pawn's location and add to persistent list GameFramework/CheatManager.h
  • Exec

virtual void DebugCapsuleSweepSize ( float HalfHeight,
float Radius
)

 Change Trace capsule size GameFramework/CheatManager.h
  • Exec

virtual void DestroyAll ( TSubclassOf< class AActor > aClass
)

 Destroy all actors of class aClass GameFramework/CheatManager.h
  • Exec

virtual void DestroyAllPawnsExceptTarget ()

 Destroy all pawns except for the (pawn) target. GameFramework/CheatManager.h
  • Exec

virtual void DestroyPawns ( TSubclassOf< class APawn > aClass
)

 Destroys (by calling destroy directly) all non-player pawns of class aClass in the level GameFramework/CheatManager.h
  • Exec

void DestroyServerStatReplicator()

   GameFramework/CheatManager.h
  • Exec

virtual void DestroyTarget()

 Destroy the actor you're looking at. GameFramework/CheatManager.h
  • Exec
  • BlueprintCallable
  • Category="Cheat Manager"

virtual bool DoGameSpecificBugItLog ( FOutputDevice& OutputFile
)

 Do game specific bugIt GameFramework/CheatManager.h  

virtual void DumpChatState()

 Dump known chat information GameFramework/CheatManager.h
  • Exec

virtual void DumpOnlineSessionState()

 Dump online session information GameFramework/CheatManager.h
  • Exec

virtual void DumpPartyState()

 Dump known party information GameFramework/CheatManager.h
  • Exec

virtual void DumpVoiceMutingState()

 Dump current state of voice chat GameFramework/CheatManager.h
  • Exec
Finds a previously registered cheat manager extension of the specified class GameFramework/CheatManager.h  
Finds a previously registered cheat manager extension of the specified class GameFramework/CheatManager.h  
Finds a previously registered cheat manager extension that implements the specified interface GameFramework/CheatManager.h  
Finds a previously registered cheat manager extension that implements the specified interface GameFramework/CheatManager.h  

virtual void FlushLog()

 This will force a flush of the output log to file GameFramework/CheatManager.h
  • Exec

virtual void Fly()

 Pawn can fly. GameFramework/CheatManager.h
  • Exec
  • BlueprintCallable
  • Category="Cheat Manager"

virtual void FreezeFrame ( float Delay
)

 Pause the game for Delay seconds. GameFramework/CheatManager.h
  • Exec
  • BlueprintCallable
  • Category="Cheat Manager"

APlayerController * GetPlayerController()

   GameFramework/CheatManager.h
  • BlueprintPure
  • Category="Cheat Manager"

virtual UWorld * GetWorld()

 Use the Outer Player Controller to get a World. GameFramework/CheatManager.h  

virtual void Ghost()

 Pawn no longer collides with the world, and can fly GameFramework/CheatManager.h
  • Exec
  • BlueprintCallable
  • Category="Cheat Manager"

virtual void God()

 Invulnerability cheat. GameFramework/CheatManager.h
  • Exec
  • BlueprintCallable
  • Category="Cheat Manager"

virtual void InitCheatManager()

 Called when CheatManager is created to allow any needed initialization. GameFramework/CheatManager.h  

virtual void InvertMouse()

 Backwards compatibility exec function for people used to it instead of using InvertAxisKey GameFramework/CheatManager.h
  • Exec

virtual bool IsDebugCameraActive()

 Returns true if the player currently has a debug camera GameFramework/CheatManager.h  

virtual void LogLoc()

 Logs the current location in bugit format without taking screenshot and further routing. GameFramework/CheatManager.h
  • Exec

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

 Bug it log to file GameFramework/CheatManager.h  

virtual void OnlyLoadLevel ( FName PackageName
)

 Load the given level. GameFramework/CheatManager.h
  • Exec

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

   GameFramework/CheatManager.h  

virtual void PlayersOnly()

 Freeze everything in the level except for players. GameFramework/CheatManager.h
  • Exec
  • BlueprintCallable
  • Category="Cheat Manager"

void ReceiveEndPlay()

 This is the End Play event for the CheatManager GameFramework/CheatManager.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="Shutdown", keywords="endplay")

void ReceiveInitCheatManager()

 BP implementable event for when CheatManager is created to allow any needed initialization. GameFramework/CheatManager.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="Init Cheat Manager", Keywords="Begin Play")

void RemoveCheatManagerExtension ( UCheatManagerExtension* CheatObject
)

 Removes a cheat manager extension from this cheat manager GameFramework/CheatManager.h  

virtual void ServerToggleAILogging()

   GameFramework/CheatManager.h
  • Reliable
  • Server
  • WithValidation

virtual void SetLevelStreamingStatus ( FName PackageName,
bool bShouldBeLoaded,
bool bShouldBeVisible
)

 Streaming level debugging GameFramework/CheatManager.h  

virtual void SetMouseSensitivityToDefault()

 Exec function to return the mouse sensitivity to its default value GameFramework/CheatManager.h
  • Exec

void SetWorldOrigin()

 Translate world origin to this player position GameFramework/CheatManager.h
  • Exec

virtual void Slomo ( float NewTimeDilation
)

 Modify time dilation to change apparent speed of passage of time. GameFramework/CheatManager.h
  • Exec
  • BlueprintCallable
  • Category="Cheat Manager"

void SpawnServerStatReplicator()

   GameFramework/CheatManager.h
  • Exec

virtual void StreamLevelIn ( FName PackageName
)

 Stream in the given level. GameFramework/CheatManager.h
  • Exec

virtual void StreamLevelOut ( FName PackageName
)

 Stream out the given level. GameFramework/CheatManager.h
  • Exec

virtual void Summon ( const FString& ClassName
)

 Load Classname and spawn an actor of that class GameFramework/CheatManager.h
  • Exec

virtual void Teleport()

 Teleport to surface player is looking at. GameFramework/CheatManager.h
  • Exec
  • BlueprintCallable
  • Category="Cheat Manager"

virtual void TestCollisionDistance()

 Test all volumes in the world to the player controller's view location GameFramework/CheatManager.h
  • Exec

void TickCollisionDebug()

 Do any trace debugging that is currently enabled GameFramework/CheatManager.h  

virtual void ToggleAILogging()

 Toggles AI logging GameFramework/CheatManager.h
  • Exec

virtual void ToggleDebugCamera()

 Toggle between debug camera/player camera without locking gameplay and with locking local player controller input. GameFramework/CheatManager.h
  • Exec

void ToggleServerStatReplicatorClientOverwrite()

   GameFramework/CheatManager.h
  • Exec

void ToggleServerStatReplicatorUpdateStatNet()

   GameFramework/CheatManager.h
  • Exec

void UpdateSafeArea()

   GameFramework/CheatManager.h
  • Exec

virtual void ViewActor ( FName ActorName
)

 View from the point of view of AActor with Name ActorName. GameFramework/CheatManager.h
  • Exec

virtual void ViewClass ( TSubclassOf< class AActor > DesiredClass
)

 View from the point of view of an AActor of class DesiredClass. GameFramework/CheatManager.h
  • Exec

virtual void ViewPlayer ( const FString& S
)

 View from the point of view of player with PlayerName S. GameFramework/CheatManager.h
  • Exec

virtual void ViewSelf()

 Make controlled pawn the viewtarget again. GameFramework/CheatManager.h
  • Exec

virtual void Walk()

 Return to walking movement mode from Fly or Ghost cheat. GameFramework/CheatManager.h
  • Exec
  • BlueprintCallable
  • Category="Cheat Manager"

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy ()

 Called before destroying the object. GameFramework/CheatManager.h  

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

   GameFramework/CheatManager.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void DisableDebugCamera()

 Switch controller from debug camera back to normal controller GameFramework/CheatManager.h
  • BlueprintCallable
  • Category="Cheat Manager"

virtual void EnableDebugCamera()

 Switch controller to debug camera without locking gameplay and with locking local player controller input GameFramework/CheatManager.h
  • BlueprintCallable
  • Category="Cheat Manager"

virtual AActor * GetTarget ( APlayerController* PlayerController,
FHitResult& OutHit
)

 Retrieve the given PlayerContoller's current "target" AActor. GameFramework/CheatManager.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool IsDebugCapsuleSweepPawnEnabled()

 Return true if debug sweeps are enabled for pawns. GameFramework/CheatManager.h  

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 GameFramework/CheatManager.h  

static void UnregisterFromOnCheatManagerCreated ( FDelegateHandle DelegateHandle
)

 Unregister a delegate previously registered with CallOrRegister_OnCheatManagerCreated GameFramework/CheatManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page