p.Chaos.DebugDraw.ShowPIEServer

p.Chaos.DebugDraw.ShowPIEServer

#Overview

name: p.Chaos.DebugDraw.ShowPIEServer

This variable is created as a Console Variable (cvar).

• type: Var
• help: When running in PIE mode, show the server debug draw

It is referenced in 3 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of p.Chaos.DebugDraw.ShowPIEServer is to control the visibility of server debug draw information when running in Play-In-Editor (PIE) mode for the Chaos physics system in Unreal Engine 5.

This setting variable is primarily used by the Chaos physics system, which is part of the experimental ChaosSolverEngine module in Unreal Engine 5. It specifically affects the debug drawing functionality for the Chaos physics simulation on the server side.

The value of this variable is set through the FAutoConsoleVariableRef system, which allows it to be modified at runtime via console commands. It is initialized to false by default.

The associated variable ChaosDebugDraw_ShowPIEServer directly interacts with p.Chaos.DebugDraw.ShowPIEServer. They share the same value and are used interchangeably in the code.

Developers must be aware that this variable only affects the server-side debug drawing in PIE mode. It works in conjunction with ChaosDebugDraw_ShowPIEClient, which controls client-side debug drawing. The actual debug drawing is only performed if the game is running on a dedicated server and this variable is set to true.

Best practices when using this variable include:

1. Use it in conjunction with ChaosDebugDraw_ShowPIEClient for a complete picture of the physics simulation.
2. Be mindful of performance implications when enabling debug drawing, especially in complex scenes.
3. Use it primarily for debugging and development purposes, not in production builds.

Regarding the associated variable ChaosDebugDraw_ShowPIEServer:

• Its purpose is the same as p.Chaos.DebugDraw.ShowPIEServer, controlling server-side debug drawing for Chaos physics in PIE mode.
• It is used directly in the DebugDrawChaos function to determine whether to proceed with debug drawing on the server.
• Its value is set through the same FAutoConsoleVariableRef mechanism as p.Chaos.DebugDraw.ShowPIEServer.
• Developers should treat it as interchangeable with p.Chaos.DebugDraw.ShowPIEServer, as they share the same value and purpose.
• Best practices for using this variable are the same as those for p.Chaos.DebugDraw.ShowPIEServer.

#References in C++ code

#Callsites

This variable is referenced in the following C++ source code:

#Loc: <Workspace>/Engine/Source/Runtime/Experimental/ChaosSolverEngine/Private/Chaos/ChaosDebugDrawComponent.cpp:46

Scope: file

Source code excerpt:

float ChaosDebugDraw_ShowPIEServer = false;
FAutoConsoleVariableRef CVarChaos_DebugDraw_ShowPIEServer(TEXT("p.Chaos.DebugDraw.ShowPIEServer"), ChaosDebugDraw_ShowPIEServer, TEXT("When running in PIE mode, show the server debug draw"));

float ChaosDebugDraw_ShowPIEClient = true;
FAutoConsoleVariableRef CVarChaos_DebugDraw_ShowPIEClient(TEXT("p.Chaos.DebugDraw.ShowPIEClient"), ChaosDebugDraw_ShowPIEClient, TEXT("When running in PIE mode, show the client debug draw"));

int bChaosDebugDraw_DrawMode = 0;
FAutoConsoleVariableRef CVarArrowSize(TEXT("p.Chaos.DebugDraw.Mode"), bChaosDebugDraw_DrawMode, TEXT("Where to send debug draw commands. 0 = UE Debug Draw; 1 = VisLog; 2 = Both"));

#Associated Variable and Callsites

This variable is associated with another variable named ChaosDebugDraw_ShowPIEServer. They share the same value. See the following C++ source code.

#Loc: <Workspace>/Engine/Source/Runtime/Experimental/ChaosSolverEngine/Private/Chaos/ChaosDebugDrawComponent.cpp:45

Scope: file

Source code excerpt:

FAutoConsoleVariableRef CVarChaosDebugDraw_SingleActorMaxRadius(TEXT("p.Chaos.DebugDraw.SingleActorMaxRadius"), ChaosDebugDraw_SingleActorMaxRadius, TEXT("Set the max radius to draw around the single actor."));

float ChaosDebugDraw_ShowPIEServer = false;
FAutoConsoleVariableRef CVarChaos_DebugDraw_ShowPIEServer(TEXT("p.Chaos.DebugDraw.ShowPIEServer"), ChaosDebugDraw_ShowPIEServer, TEXT("When running in PIE mode, show the server debug draw"));

float ChaosDebugDraw_ShowPIEClient = true;
FAutoConsoleVariableRef CVarChaos_DebugDraw_ShowPIEClient(TEXT("p.Chaos.DebugDraw.ShowPIEClient"), ChaosDebugDraw_ShowPIEClient, TEXT("When running in PIE mode, show the client debug draw"));

int bChaosDebugDraw_DrawMode = 0;
FAutoConsoleVariableRef CVarArrowSize(TEXT("p.Chaos.DebugDraw.Mode"), bChaosDebugDraw_DrawMode, TEXT("Where to send debug draw commands. 0 = UE Debug Draw; 1 = VisLog; 2 = Both"));

#Loc: <Workspace>/Engine/Source/Runtime/Experimental/ChaosSolverEngine/Private/Chaos/ChaosDebugDrawComponent.cpp:94

Scope (from outer to inner):

file
function     void DebugDrawChaos

Source code excerpt:

	}

	if ((World->GetNetMode() == NM_DedicatedServer) && !ChaosDebugDraw_ShowPIEServer)
	{
		return;
	}

	if ((World->GetNetMode() != NM_DedicatedServer) && !ChaosDebugDraw_ShowPIEClient)
	{