Navigation
Unreal Engine C++ API Reference > Plugins
Filters
Classes
Type | Name | Description | |
---|---|---|---|
![]() |
AccessPrivate | This template, is used to link an arbitrary class member, to the GetPrivate function. | |
![]() ![]() |
ANUTActor | ||
![]() |
FAssertHookDevice | Output device for replacing GError, and catching specific asserts so they don't crash the game. | |
![]() |
FContextPointer | There is a problem with the parser API, where the Context you pass into the Evaluate function is marked: const ContextType* Context | |
![]() |
FDynamicOutputDevice | Output device for allowing quick/dynamic creation of a customized output device, using lambda's passed to delegates | |
![]() |
FErrorLog | Struct used for storing and classifying each log error line | |
![]() |
FExecuteOnServer | Delegate for executing a unit test function on the server | |
![]() |
FFuncReflection | FFuncReflection - helper for quickly/concisely setting function parameters through reflection | |
![]() |
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 | |
![]() |
FLogCommandManager | Log hook which executes console commands upon detecting certain log entries. | |
![]() |
FLogHookManager | Generic log hook, for calling a hook function upon detecting a specific log entry | |
![]() |
FLogTraceManager | A log hook, which watches the log for specified log entries, and ties them into the stack trace manager | |
![]() |
FMinClientHooks | Delegate hooks for the minimal client - also directly inherited by UMinimalClient | |
![]() |
FMinClientParms | Parameters for configuring the minimal client - also directly inherited by UMinimalClient | |
![]() |
FNUTModuleInterface | Includes. | |
![]() |
FNUTStackTrace | A class for dumping a stack trace, upon encountering a specific piece of code | |
![]() |
FProtMinClientHooks | ||
![]() |
FProtMinClientParms | Sidestep header parser enforcement of 'public' on inheritance below. | |
![]() |
FReflEvaluationContext | FVMReflectionParser - A string interface for FVMReflection, which performs reflection on the UE virtual machine. | |
![]() |
FScopedIncrementTraceIgnoreDepth | Used for adjusting the depth of ignore stack trace lines in FStackTraceManager | |
![]() |
FScopedLog | Use this following code snippet, to execute the above function. | |
![]() |
FScopedLogNet | Version of FScopedLog, for scoped logging of all netcode-related logs | |
![]() |
FScopedLogSuppress | Version of FScopedLog, for suppressing instead of enabling log entries | |
![]() |
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). | |
![]() |
FStackTrackerbIsEnabledAccessor | Enable access to FStackTracker.bIsEnabled. | |
![]() |
FTestResultPointer | ||
![]() |
FUnitLogInterface | Implements an interface for using the UNIT_LOG etc. macros above, within a class | |
![]() |
FUnitLogRedirect | Implements a UNIT_LOG interface, which redirects to another unit log interface (e.g. redirect MinimalClient UNIT_LOG's to a UnitTest) | |
![]() |
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) | |
![]() |
FUnitTestEnvironment | Class for handling per-game implementation of unit test environmental defaults | |
![]() |
FUnitTestProcess | Struct used for handling a launched UE client/server process | |
![]() |
FVMReflection | FVMReflection | |
![]() |
FVMReflectionParser | FVMReflectionParser | |
![]() |
INetcodeUnitTest | Public interface for the NetcodeUnitTest module | |
![]() |
NUTDebug | A log hook, which watches the log for specified log entries, and ties them into the stack trace manager | |
![]() |
NUTUtil | General utility functions | |
![]() |
NUTUtilRefl | NUTUtilRefl - general reflection helper utility functions | |
![]() ![]() ![]() |
UClientUnitTest | Base class for all unit tests depending upon a MinimalClient connecting to a server. | |
![]() ![]() |
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. | |
![]() ![]() |
UNUTGlobals | Stores globals/static-variables for NetcodeUnitTest - for compatibility with hot reload | |
![]() ![]() ![]() |
UProcessUnitTest | Base class for all unit tests which launch child processes, whether they be UE child processes, or other arbitrary programs. | |
![]() ![]() ![]() |
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. | |
![]() ![]() ![]() ![]() |
UUnitTest | Base class for all unit tests | |
![]() ![]() ![]() |
UUnitTestBase | Includes. | |
![]() ![]() |
UUnitTestCommandlet | Includes. | |
![]() ![]() ![]() |
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 | |
---|---|---|---|
![]() |
EErrorLogStage | Includes. | |
![]() |
ELogTraceFlags | Flags specifying the type of log trace | |
![]() |
ELogType | EnumsUsed to help identify what type of log is being processed | |
![]() ![]() |
EMinClientFlags | Flags for configuring the minimal client, what parts of the netcode should be enabled etc. | |
![]() |
ENUTControlCommand | Enum for defining custom NetcodeUnitTest control channel commands (sent through NMT_NUTControl) | |
![]() |
ESuspendState | Enum for specifying the suspend state of a process (typically the server) | |
![]() |
EUnitTaskFlags | Enums Flags for specifying the required conditions for executing a UnitTask, and what stages of the unit test to block until completion | |
![]() |
EUnitTestFlags | Flags for configuring how individual unit tests make use of the base client unit test framework. | |
![]() ![]() |
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 | |
![]() ![]() |
EUnitTestVerification | Enums The verification status of the current unit test - normally its execution completes immediately after positive/negative verification | |
![]() |
EVMRefWarning | Currently supported fields (field list taken from UEd class viewer) - Field | |
![]() |
UE::NUT::ELogHookType | Specifies the type of log hook (e.g. type of string matching to use) |
Functions
Variables
Type | Name | Description | |
---|---|---|---|
![]() |
*FStructProperty * | EntryItemGuidProp | |
![]() |
*FGuid * | EntryItemGuidRef | |
![]() |
FUnitLogInterface * | GActiveLogEngineEvent | |
![]() |
FUnitLogInterface * | GActiveLogInterface | GlobalsUsed by to aid in hooking log messages triggered by unit tests |
Globals |
![]() |
ELogType | GActiveLogTypeFlags | The current ELogType flag modifiers, associated with a UNIT_LOG or UNIT_STATUS_LOG/STATUS_LOG call |
![]() |
UWorld * | GActiveLogWorld | |
![]() |
UNetConnection * | GActiveReceiveUnitConnection | Keeps track of the UUnitTestNetConnection, currently processing received data (to aid with selective log hooking) |
![]() |
bool | GIsInitializingActorChan | Whether not an actor channel, is in the process of initializing the remote actor |
Globals |
![]() |
PRAGMA_DISABLE_DEPRECATION_WARNINGS FLogStackTraceManager * | GLogTraceManager | Log hook for managing tying of log entry detection to the trace manager |
![]() |
FStackTraceManager * | GTraceManager | Provides a globally accessible trace manager, for easy access to stack trace debugging |
Globals |
![]() |
UUnitTestManager * | GUnitTestManager | Globals/externsHolds a reference to the object in charge of managing unit tests |
![]() |
*FScriptArrayHelper * | InvItemsArray | |
![]() |
*FStructProperty * | InvItemsEntryProp | |
![]() |
**void * | InvItemsEntryRef | |
![]() |
*FArrayProperty * | InvItemsProp | |
![]() |
TMap< FString, FUnitTestEnvironment * > | UnitTestEnvironments | The list of registered unit test environments, mapped to game name (unit test modules should add to this, within StartupModule) |
![]() |
*FStructProperty * | WIInventoryProp | |
![]() |
*void * | WIInventoryRef | |
![]() |
*AActor * | WorldInv | |
![]() |
*FObjectProperty * | WorldInvProp | FVMReflection - Reflection Helper |
![]() |
*UObject ** | WorldInvRef |