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 > Plugins > NetcodeUnitTest > FScopedLog

Light Theme

Dark Theme

FScopedLog

Use this following code snippet, to execute the above function.

Windows

MacOS

Linux

Inheritance Hierarchy

FScopedLog

	FScopedLogNet
	FScopedLogSuppress

References

Module	NetcodeUnitTest
Header	/Engine/Plugins/NetcodeUnitTest/NetcodeUnitTest/Source/NetcodeUnitTest/Public/NUTUtilDebug.h
Include	#include "NUTUtilDebug.h"

Syntax

class FScopedLog

Remarks

A class for enabling verbose log message categories, within a particular code scope (disabled when going out of scope). NOTE: If you are logging any kind of net-related log messages, specify a unit test (even if you aren't doing remote logging)

Also supports remote (server) logging, for net functions executed within the current code scope (causes net packets to be flushed both upon entering the current scope, and when exiting it - required for correct log timing).

NOTE: If you are trying to catch remote log messages deep within the internal game netcode, then this class may not be appropriate, as remote logging passes through the netcode (YMMV)

Variables

	Name	Description
bool	bRemoteLogging	Whether or not this is also controlling remote logging as well
bool	bSuppressLogging	Whether or not to suppress instead of enable logging
TArray< FString...	LogCategories	The list of unsuppressed log messages
UClientUnitTest...	UnitTest	Stores a reference to the unit test doing the logging, if specified

Constructors

	Name	Description
	FScopedLog()
	FScopedLog ( const TArray< FString >& InLogCate..., UClientUnitTest* InUnitTest, bool bInRemoteLogging )	Constructor used for setting up the type of logging that is done.
	FScopedLog ( const FString InLogCategory, UClientUnitTest* InUnitTest, bool bInRemoteLogging )	As above, but for a single log category.

Destructors

	Name	Description
	~FScopedLog()

Functions

		Name	Description
	void	InternalConstruct ( const TArray< FString >& InLogCate..., UClientUnitTest* InUnitTest, bool bInRemoteLogging )	FScopedLog

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

Take our survey

Dismiss