UChaosVDGeneralSettings

General settings that controls how CVD behaves

API > API/Plugins > API/Plugins/ChaosVD

General settings that controls how CVD behaves

   
Name UChaosVDGeneralSettings
Type class
Header File /Engine/Plugins/ChaosVD/Source/ChaosVD/Public/Settings/ChaosVDGeneralSettings.h
Include Path #include "Settings/ChaosVDGeneralSettings.h"

Syntax

UCLASS (Config=ChaosVD, PerObjectConfig)  
class UChaosVDGeneralSettings : public UChaosVDSettingsObjectBase

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAutoStartLiveSessionsPlayback bool If True, playback will start automatically after a recording started, and we successfully connect to it Settings/ChaosVDGeneralSettings.h
  • Config
  • EditAnywhere
  • Category=Connection
bProcessPendingOperationsQueueInWorkerThread bool If set to true CVD will process any updates to the streaming accel structure in worker threads, in between streaming updates Settings/ChaosVDGeneralSettings.h
  • Config
  • EditAnywhere
  • Category="Performance | Streaming"
bSafeLoadingMode bool If true, CVD will skip data whose binary format is not guaranteed to be backwards compatible (e.g. raw-serialized structs such as generic particle extra data). Settings/ChaosVDGeneralSettings.h
  • Config
  • EditAnywhere
  • Category="Backwards Compatibility"
bSaveRecordingsToDisk bool If True, any traces done to memory will also be saved to disk at the same time in the user's document folder (or a user specified folder). Settings/ChaosVDGeneralSettings.h
  • EditAnywhere
  • Category=Connection
bShowNativeSerializationWarning bool If true, shows a warning dialog after loading when native-serialized extra data is present and ParticleExtraDataLoadingMode is LoadAll. Settings/ChaosVDGeneralSettings.h
  • Config
  • EditAnywhere
  • Category="Backwards Compatibility"
bShowSafeModeSkippedWarning bool If true, an informational dialog is shown after loading when data types were skipped because Safe Loading Mode is enabled. Settings/ChaosVDGeneralSettings.h
  • Config
  • EditAnywhere
  • Category="Backwards Compatibility"
bShowUnsafeDataWarning bool If true, a warning dialog is shown after loading when non-backwards-compatible data was processed with Safe Loading Mode disabled. Settings/ChaosVDGeneralSettings.h
  • Config
  • EditAnywhere
  • Category="Backwards Compatibility"
bStreamingSystemEnabled bool If true, CVD will only load collision geometry that is visible Settings/ChaosVDGeneralSettings.h
  • Config
  • EditAnywhere
  • Category="Performance | Streaming"
bTrimEmptyFrames bool If true, CVD will only load frames that have solver data in them - Only takes effect before loading a file Settings/ChaosVDGeneralSettings.h
  • Config
  • EditAnywhere
  • Category="Session Data Loading"
bUpdateSceneOutlinerDuringPlayback bool If set to true CVD will keep the scene outliner up to date as the recording is played. Settings/ChaosVDGeneralSettings.h
  • Config
  • EditAnywhere
  • Category="Performance | Scene Outliner"
DefaultSavePathOverride FFilePath Custom path where recordings will be saved from. Settings/ChaosVDGeneralSettings.h
  • Config
  • EditAnywhere
  • Category=Connection
MaxConnectionRetries int32 How many times CVD will attempt to connect to a live trace or load from file session if the first attempt failed Settings/ChaosVDGeneralSettings.h
  • Config
  • EditAnywhere
  • Category=Connection
MaxGameThreadFramesToQueueNum int32 How many Game thread frames CVD should queue internally before making them available in the visualization and timeline controls - Only takes effect before loading a file Settings/ChaosVDGeneralSettings.h
  • Config
  • EditAnywhere
  • Category="Session Data Loading"
ParticleExtraDataLoadingMode EChaosVDParticleExtraDataLoadingMode Controls how particle extra data is loaded. Settings/ChaosVDGeneralSettings.h
  • Config
  • EditAnywhere
  • Category="Backwards Compatibility"
StreamingBoxExtentSize float Extent size of the box used for calculate what should be streamed in Settings/ChaosVDGeneralSettings.h
  • Config
  • EditAnywhere
  • Category="Performance | Streaming"

Protected

Name Type Remarks Include Path Unreal Specifiers
GameClientDataTransportMode UE::TraceBasedDebuggers::ETraceTransportMode [DEBUG Setting] Default Data Transport for Game Clients - Used to change the transport mode for the trace data. Settings/ChaosVDGeneralSettings.h
  • EditAnywhere
  • Category=Connection
GameServerDataTransportMode UE::TraceBasedDebuggers::ETraceTransportMode [DEBUG Setting] Default Data Transport for Game Servers - Used to change the transport mode for the trace data. Settings/ChaosVDGeneralSettings.h
  • EditAnywhere
  • Category=Connection

Functions

Public

Name Remarks Include Path Unreal Specifiers

EChaosVDTransportMode GetTransportModeForTarget ( EBuildTargetType TargetType
) const

   Settings/ChaosVDGeneralSettings.h  

UE::TraceBasedDebuggers::ETraceTransportMode GetTransportModeForTargetType ( EBuildTargetType TargetType
) const

 Returns the configured transport mode for the provided target type Settings/ChaosVDGeneralSettings.h  

void SetTransportModeForTarget ( EBuildTargetType TargetType,
EChaosVDTransportMode NewTransportMode
)

   Settings/ChaosVDGeneralSettings.h  

void SetTransportModeForTargetType ( EBuildTargetType TargetType,
UE::TraceBasedDebuggers::ETraceTransportMode NewTransportMode
)

 Sets a specific transport mode for the provided target type Settings/ChaosVDGeneralSettings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page