1. Epic GamesDeveloper
  3. NetcodeUnitTest

NetcodeUnitTest

Unreal Engine C++ API Reference > Plugins

Filters

Classes

  Type Name Description
Public struct AccessPrivate This template, is used to link an arbitrary class member, to the GetPrivate function.  
Public class UClass ANUTActor    
Public class FAssertHookDevice Output device for replacing GError, and catching specific asserts so they don't crash the game.  
Public struct FContextPointer There is a problem with the parser API, where the Context you pass into the Evaluate function is marked: const ContextType* Context  
Public class FDynamicOutputDevice Output device for allowing quick/dynamic creation of a customized output device, using lambda's passed to delegates  
Public struct FErrorLog Struct used for storing and classifying each log error line  
Public class FExecuteOnServer Delegate for executing a unit test function on the server  
Public class FFuncReflection FFuncReflection - helper for quickly/concisely setting function parameters through reflection  
Public class FHookOutputDevice Output device for hijacking/hooking an existing output device (e.g. to hijack GError, to block specific asserts) Inherit this class, to implement desired hook behaviour in subclass  
Public class FLogCommandManager Log hook which executes console commands upon detecting certain log entries.  
Public class FLogHookManager Generic log hook, for calling a hook function upon detecting a specific log entry  
Public class FLogTraceManager A log hook, which watches the log for specified log entries, and ties them into the stack trace manager  
Public struct FMinClientHooks Delegate hooks for the minimal client - also directly inherited by UMinimalClient  
Public struct FMinClientParms Parameters for configuring the minimal client - also directly inherited by UMinimalClient  
Public class FNUTModuleInterface Includes.  
Public class FNUTStackTrace A class for dumping a stack trace, upon encountering a specific piece of code  
Public struct FProtMinClientHooks    
Public struct FProtMinClientParms Sidestep header parser enforcement of 'public' on inheritance below.  
Public struct FReflEvaluationContext FVMReflectionParser - A string interface for FVMReflection, which performs reflection on the UE virtual machine.  
Public class FScopedIncrementTraceIgnoreDepth Used for adjusting the depth of ignore stack trace lines in FStackTraceManager  
Public class FScopedLog Use this following code snippet, to execute the above function.  
Public class FScopedLogNet Version of FScopedLog, for scoped logging of all netcode-related logs  
Public class FScopedLogSuppress Version of FScopedLog, for suppressing instead of enabling log entries  
Public class FStackTraceManager Manager for handling multiple debug stack traces on-the-fly, and allowing abstraction of stack traces, so you don't have to manually handle FNUTStackTrace objects (which can be complicated/bug-prone).  
Public struct FStackTrackerbIsEnabledAccessor Enable access to FStackTracker.bIsEnabled.  
Public struct FTestResultPointer    
Public class FUnitLogInterface Implements an interface for using the UNIT_LOG etc. macros above, within a class  
Public class FUnitLogRedirect Implements a UNIT_LOG interface, which redirects to another unit log interface (e.g. redirect MinimalClient UNIT_LOG's to a UnitTest)  
Public struct FUnitStatusLog Structs Used for storing unit-test-specific logs, which are displayed in the status window (upon completion of unit testing, a final summary is printed using this data, but in a more-ordered/easier-to-read fashion)  
Public class FUnitTestEnvironment Class for handling per-game implementation of unit test environmental defaults  
Public struct FUnitTestProcess Struct used for handling a launched UE client/server process  
Public class FVMReflection FVMReflection  
Public class FVMReflectionParser FVMReflectionParser  
Public class INetcodeUnitTest Public interface for the NetcodeUnitTest module  
Public struct NUTDebug A log hook, which watches the log for specified log entries, and ties them into the stack trace manager  
Public struct NUTUtil General utility functions  
Public struct NUTUtilRefl NUTUtilRefl - general reflection helper utility functions  
Public class UClass Abstract UClientUnitTest Base class for all unit tests depending upon a MinimalClient connecting to a server.  
Public class UClass UMinimalClient Base class for implementing a barebones/stripped-down game client, capable of connecting to a regular game server, but stripped/locked-down so that the absolute minimum of client/server netcode functionality is executed, for connecting the client.  
Public class UClass UNUTGlobals Stores globals/static-variables for NetcodeUnitTest - for compatibility with hot reload  
Public class UClass Abstract UProcessUnitTest Base class for all unit tests which launch child processes, whether they be UE child processes, or other arbitrary programs.  
Public class UClass Abstract UUnitTask UnitTask's are used to implement supporting code for UnitTest's, for handling complex behind-the-scenes setup prior to test execution (e.g. primarily for implementing game-specific server/client environment setup), which is shared between many unit tests, and which is better to abstract-away from visibility in unit tests themselves, for code clarity.  
Public class UClass Abstract Config UUnitTest Base class for all unit tests  
Public class UClass Abstract UUnitTestBase Includes.  
Public class UClass UUnitTestCommandlet Includes.  
Public class UClass Config UUnitTestManager Manages centralized execution and tracking of unit tests, as well as handling console commands, and some misc tasks like local log hooking  

Constants

Name Description
NMT_NUTControl Custom control channel message, used to communicate with the server NUTActor over the control channel.

Typedefs

Name Description
FLogHook Function to call as the log hook
FLogHookID Log hook ID, for removing later if desired
FOnHandleClientPlayer Delegate for hooking the HandlerClientPlayer event
FOnMinClientConnected Delegate for marking the minimal client as having connected fully
FOnMinClientNetActor Delegate for notifying AFTER an actor channel actor has been created
FOnMinClientNetworkFailure Delegate for passing back a network connection failure
FOnMinClientReceivedControlBunch Delegate for hooking the control channel's 'ReceivedBunch' call
FOnMinClientReceivedRawPacket Delegate for hooking the net connections 'ReceivedRawPacket'
FOnMinClientRepActorSpawn Delegate for notifying on (and optionally blocking) replicated actor creation
FOnRPCFailure Delegate for notifying of failure during call of SendRPCChecked
FOnSuspendStateChange Delegate notifying that a process suspend state has changed
FProcessLogWatch Delegate for implementing process log watches

Enums

  Type Name Description
Public enum EErrorLogStage Includes.  
Public enum ELogTraceFlags Flags specifying the type of log trace  
Public enum ELogType EnumsUsed to help identify what type of log is being processed  
Public enum UEnum EMinClientFlags Flags for configuring the minimal client, what parts of the netcode should be enabled etc.  
Public enum ENUTControlCommand Enum for defining custom NetcodeUnitTest control channel commands (sent through NMT_NUTControl)  
Public enum ESuspendState Enum for specifying the suspend state of a process (typically the server)  
Public enum EUnitTaskFlags Enums Flags for specifying the required conditions for executing a UnitTask, and what stages of the unit test to block until completion  
Public enum EUnitTestFlags Flags for configuring how individual unit tests make use of the base client unit test framework.  
Public enum UEnum EUnitTestResetStage The different stages that unit tests can be reset to - a global/non-locally-customizable list, for now NOTE: Stages MUST be sequential! (e.g. ResetConnection implies ResetExecute, FullReset implies both ResetConnection and ResetExecute) NOTE: Apart from checking for 'None', all comparisons should be either <= or >=, to support potential enum additions  
Public enum UEnum EUnitTestVerification Enums The verification status of the current unit test - normally its execution completes immediately after positive/negative verification  
Public enum EVMRefWarning Currently supported fields (field list taken from UEd class viewer) - Field  
Public enum UE::NUT::ELogHookType Specifies the type of log hook (e.g. type of string matching to use)  

Functions

  Type Name Description
Public function EMinClientFlags Converts any EUnitTestFlags values, to their EMinClientFlags equivalentEMinClientFlags
Public function int32 Returns the numeric priority for the specified UnitTask flagsEUnitTaskFlags
Public function FString Used to get name values for the above enumEUnitTestFlags
Public function FString EUnitTestResetStage
Public function bool

GGlobalExec ( UWorld* InWorld,
const TCHAR* Cmd,
FOutputDevice& Ar
)

 Provides a globally-accessible wrapper for the Exec function, which all modules can use (including those that don't inherit Engine), for executing console commands - useful for debugging e.g. pre-Engine netcode (such as the PacketHandler code).
Public function ****

if ( InvItemsArray!
)

  
Public function constexpr bool  
Public function constexpr bool  
Public function constexpr bool  
Public function constexpr bool  
Public function constexpr bool  
Public function constexpr EUnitTaskFlags  
Public function constexpr EMinClientFlags  
Public function constexpr EUnitTestFlags  
Public function constexpr ELogTraceFlags  
Public function constexpr ELogType

operator& ( ELogType Lhs,
ELogType Rhs
)

  
Public function ELogType &

operator&= ( ELogType& Lhs,
ELogType Rhs
)

  
Public function EUnitTaskFlags &  
Public function EMinClientFlags &  
Public function EUnitTestFlags &  
Public function ELogTraceFlags &  
Public function constexpr ELogTraceFlags  
Public function constexpr ELogType

operator^ ( ELogType Lhs,
ELogType Rhs
)

  
Public function constexpr EUnitTestFlags  
Public function constexpr EUnitTaskFlags  
Public function constexpr EMinClientFlags  
Public function EUnitTaskFlags &  
Public function EMinClientFlags &  
Public function EUnitTestFlags &  
Public function ELogTraceFlags &  
Public function ELogType &

operator^= ( ELogType& Lhs,
ELogType Rhs
)

  
Public function constexpr ELogTraceFlags  
Public function constexpr ELogType

operator| ( ELogType Lhs,
ELogType Rhs
)

  
Public function constexpr EUnitTestFlags  
Public function constexpr EUnitTaskFlags  
Public function constexpr EMinClientFlags  
Public function ELogTraceFlags &  
Public function EUnitTaskFlags &  
Public function EMinClientFlags & Required for bitwise operations with the above enum.
Public function EUnitTestFlags & Required for bitwise operations with the above enum.
Public function ELogType &

operator|= ( ELogType& Lhs,
ELogType Rhs
)

  
Public function constexpr EMinClientFlags  
Public function constexpr EUnitTestFlags  
Public function constexpr ELogTraceFlags  
Public function constexpr EUnitTaskFlags  
Public function constexpr ELogType  
Public function ELogType

OptionalFlags ( ELogType InFlags
)

 Macro defines Helper function, for macro defines - allows the 'UnitLogTypeFlags' macro parameters below, to be optional
Public function EMinClientFlags Validates, both at compile time (template param) or at runtime (function param), that the specified EMinClientFlags flags are valid.

Variables

  Type Name Description
Public variable *FStructProperty * EntryItemGuidProp  
Public variable *FGuid * EntryItemGuidRef  
Public variable FUnitLogInterface * GActiveLogEngineEvent  
Public variable FUnitLogInterface * GActiveLogInterface GlobalsUsed by to aid in hooking log messages triggered by unit tests

Globals |

Public variable ELogType GActiveLogTypeFlags The current ELogType flag modifiers, associated with a UNIT_LOG or UNIT_STATUS_LOG/STATUS_LOG call
Public variable UWorld * GActiveLogWorld  
Public variable UNetConnection * GActiveReceiveUnitConnection Keeps track of the UUnitTestNetConnection, currently processing received data (to aid with selective log hooking)
Public variable bool GIsInitializingActorChan Whether not an actor channel, is in the process of initializing the remote actor

Globals |

Public variable PRAGMA_DISABLE_DEPRECATION_WARNINGS FLogStackTraceManager * GLogTraceManager Log hook for managing tying of log entry detection to the trace manager
Public variable FStackTraceManager * GTraceManager Provides a globally accessible trace manager, for easy access to stack trace debugging

Globals |

Public variable UUnitTestManager * GUnitTestManager Globals/externsHolds a reference to the object in charge of managing unit tests
Public variable *FScriptArrayHelper * InvItemsArray  
Public variable *FStructProperty * InvItemsEntryProp  
Public variable **void * InvItemsEntryRef  
Public variable *FArrayProperty * InvItemsProp  
Public variable TMap< FString, FUnitTestEnvironment * > UnitTestEnvironments The list of registered unit test environments, mapped to game name (unit test modules should add to this, within StartupModule)
Public variable *FStructProperty * WIInventoryProp  
Public variable *void * WIInventoryRef  
Public variable *AActor * WorldInv  
Public variable *FObjectProperty * WorldInvProp FVMReflection - Reflection Helper
Public variable *UObject ** WorldInvRef  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page
Back to top
Games
Marketplaces
Tools
Online Services
Resources
Company

© 2004-2025, Epic Games, Inc. All rights reserved. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.