Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > GameFramework > UCheatManager

Light Theme

Dark Theme

UCheatManager

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UCheatManager

References

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

Syntax

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

	Name	Description
uint32: 1	bDebugCapsuleSweep	Trace/Sweep debug start.
uint32: 1	bDebugCapsuleTraceComplex	If we should trace complex collision in debug capsule sweeps.
uint32: 1	bToggleAILogging	Holds information if we used ToggleAILogging cheat to activate AI logging
int32	CurrentTraceIndex	Index of the array for current trace to overwrite.
int32	CurrentTracePawnIndex	Index of the array for current trace to overwrite.
TSubclassOf< cl...	DebugCameraControllerClass	Debug camera - used to have independent camera without stopping gameplay
ADebugCameraCon...	DebugCameraControllerRef	Debug camera - used to have independent camera without stopping gameplay
float	DebugCapsuleHalfHeight	Half distance between debug capsule sphere ends.
float	DebugCapsuleRadius	Radius of debug capsule
TEnumAsByte< en...	DebugTraceChannel	What channel are we tracing
float	DebugTraceDistance	How far debug trace should go out from player viewpoint
float	DebugTraceDrawNormalLength	How long to draw the normal result
TArray< struct ...	DebugTraceInfoList	Array of information for capturing
TArray< struct ...	DebugTracePawnInfoList	Array of information for capturing

Constructors

	Name	Description
	UCheatManager ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
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
void	BugIt ( const FString& ScreenShotDescripti... )	This function is used to print out the BugIt location.
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.
void	BugItGoString ( const FString& TheLocation, const FString& TheRotation )	This will move the player and set their rotation to the passed in values.
void	BugItStringCreator ( FVector ViewLocation, FRotator ViewRotation, FString& GoString, FString& LocString )	This will create a BugItGo string for us.
void	BugItWorker ( FVector TheLocation, FRotator TheRotation )	This will move the player and set their rotation to the passed in values.
void	ChangeSize ( float F )	Scale the player's size to be F * default size.
void	CheatScript ( FString ScriptName )	Executes commands listed in CheatScript.ScriptName ini section of DefaultGame.ini
void	DamageTarget ( float DamageAmount )	Damage the actor you're looking at (sourced from the player).
void	DebugCapsuleSweep()	Toggle capsule trace debugging.
void	DebugCapsuleSweepCapture()	Capture current trace and add to persistent list
void	DebugCapsuleSweepChannel ( enum ECollisionChannel Channel )	Change Trace Channel
void	DebugCapsuleSweepClear()	Clear persistent list for trace capture
void	DebugCapsuleSweepComplex ( bool bTraceComplex )	Change Trace Complex setting
void	DebugCapsuleSweepPawn()	Capture current local PC's pawn's location and add to persistent list
void	DebugCapsuleSweepSize ( float HalfHeight, float Radius )	Change Trace capsule size
void	DestroyAll ( TSubclassOf< class AActor > aClass )	Destroy all actors of class aClass
void	DestroyAllPawnsExceptTarget()	Destroy all pawns except for the (pawn) target.
void	DestroyPawns ( TSubclassOf< class APawn > aClass )	Destroys (by calling destroy directly) all non-player pawns of class aClass in the level
void	DestroyServerStatReplicator()
void	DestroyTarget()	Destroy the actor you're looking at.
void	DisableDebugCamera()	Switch controller from debug camera back to normal controller
bool	DoGameSpecificBugItLog ( FOutputDevice& OutputFile )	Do game specific bugIt
void	DumpChatState()	Dump known chat information
void	DumpOnlineSessionState()	Dump online session information
void	DumpPartyState()	Dump known party information
void	DumpVoiceMutingState()	Dump current state of voice chat
void	EnableDebugCamera()	Switch controller to debug camera without locking gameplay and with locking local player controller input
void	FlushLog()	This will force a flush of the output log to file
void	Fly()	Pawn can fly.
void	FreezeFrame ( float Delay )	Pause the game for Delay seconds.
AActor *	GetTarget ( APlayerController* PlayerContr..., FHitResult& OutHit )	Retrieve the given PlayerContoller's current "target" AActor.
UWorld *	GetWorld()	Use the Outer Player Controller to get a World.
void	Ghost()	Pawn no longer collides with the world, and can fly
void	God()	Invulnerability cheat.
void	InitCheatManager()	Called when CheatManager is created to allow any needed initialization.
void	InvertMouse()	Backwards compatibility exec function for people used to it instead of using InvertAxisKey
bool	IsDebugCapsuleSweepPawnEnabled()	Return true if debug sweeps are enabled for pawns.
void	LogLoc()	Logs the current location in bugit format without taking screenshot and further routing.
void	LogOutBugItGoToLogFile ( const FString& InScreenShotDesc, const FString& InScreenShotPath, const FString& InGoString, const FString& InLocString )	Bug it log to file
void	OnlyLoadLevel ( FName PackageName )	Load the given level.
void	PlayersOnly()	Freeze everything in the level except for players.
void	ReceiveEndPlay()	This is the End Play event for the CheatManager
void	ReceiveInitCheatManager()	BP implementable event for when CheatManager is created to allow any needed initialization.
void	ServerToggleAILogging()
void	SetLevelStreamingStatus ( FName PackageName, bool bShouldBeLoaded, bool bShouldBeVisible )	Streaming level debugging
void	SetMouseSensitivityToDefault()	Exec function to return the mouse sensitivity to its default value
void	SetWorldOrigin()	Translate world origin to this player position
void	Slomo ( float NewTimeDilation )	Modify time dilation to change apparent speed of passage of time.
void	SpawnServerStatReplicator()
void	StreamLevelIn ( FName PackageName )	Stream in the given level.
void	StreamLevelOut ( FName PackageName )	Stream out the given level.
void	Summon ( const FString& ClassName )	Load Classname and spawn an actor of that class
void	Teleport()	Teleport to surface player is looking at.
void	TestCollisionDistance()	Test all volumes in the world to the player controller's view location
void	TickCollisionDebug()	Do any trace debugging that is currently enabled
void	ToggleAILogging()	Toggles AI logging
void	ToggleDebugCamera()	Toggle between debug camera/player camera without locking gameplay and with locking local player controller input.
void	ToggleServerStatReplicatorClientOverwrite()
void	ToggleServerStatReplicatorUpdateStatNet()
void	UpdateSafeArea()
void	ViewActor ( FName ActorName )	View from the point of view of AActor with Name ActorName.
void	ViewClass ( TSubclassOf< class AActor > Desired... )	View from the point of view of an AActor of class DesiredClass.
void	ViewPlayer ( const FString& S )	View from the point of view of player with PlayerName S.
void	ViewSelf()	Make controlled pawn the viewtarget again.
void	Walk()	Return to walking movement mode from Fly or Ghost cheat.

Overridden from UObject

		Name	Description
	void	BeginDestroy()	Called before destroying the object.

Constants

Name	Description
bDebugCapsuleSweepPawn	If we should should perform a debug capsule trace for pawns and draw results.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss