Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FDebug Struct Reference

#include <AssertionMacros.h>

Static Public Member Functions

static void VARARGS AssertFailed (const ANSICHAR *Expr, const ANSICHAR *File, int32 Line, const TCHAR *Format=TEXT(""),...)
 
static void AssertFailedV (const ANSICHAR *Expr, const ANSICHAR *File, int32 Line, const TCHAR *Format, va_list Args)
 
static void ProcessFatalError (void *ProgramCounter)
 
static bool HasAsserted ()
 
static bool IsEnsuring ()
 
static SIZE_T GetNumEnsureFailures ()
 
static void DumpStackTraceToLog (const ELogVerbosity::Type LogVerbosity)
 
static void DumpStackTraceToLog (const TCHAR *Heading, const ELogVerbosity::Type LogVerbosity)
 
static void LogFormattedMessageWithCallstack (const FName &LogName, const ANSICHAR *File, int32 Line, const TCHAR *Heading, const TCHAR *Message, ELogVerbosity::Type Verbosity)
 

Detailed Description

FDebug These functions offer debugging and diagnostic functionality and its presence depends on compiler switches.

Definition at line 62 of file AssertionMacros.h.

Member Function Documentation

◆ AssertFailed()

static void VARARGS FDebug::AssertFailed ( const ANSICHAR * Expr,
const ANSICHAR * File,
int32 Line,
const TCHAR * Format = TEXT(""),
... )
static

Logs final assert message and exits the program.

◆ AssertFailedV()

static void FDebug::AssertFailedV ( const ANSICHAR * Expr,
const ANSICHAR * File,
int32 Line,
const TCHAR * Format,
va_list Args )
static

◆ DumpStackTraceToLog() [1/2]

static void FDebug::DumpStackTraceToLog ( const ELogVerbosity::Type LogVerbosity)
static

Dumps the stack trace into the log, meant to be used for debugging purposes.

◆ DumpStackTraceToLog() [2/2]

static void FDebug::DumpStackTraceToLog ( const TCHAR * Heading,
const ELogVerbosity::Type LogVerbosity )
static

Dumps the stack trace into the log with a custom heading, meant to be used for debugging purposes.

◆ GetNumEnsureFailures()

static SIZE_T FDebug::GetNumEnsureFailures ( )
static

◆ HasAsserted()

static bool FDebug::HasAsserted ( )
static

◆ IsEnsuring()

static bool FDebug::IsEnsuring ( )
static

◆ LogFormattedMessageWithCallstack()

static void FDebug::LogFormattedMessageWithCallstack ( const FName & LogName,
const ANSICHAR * File,
int32 Line,
const TCHAR * Heading,
const TCHAR * Message,
ELogVerbosity::Type Verbosity )
static

Logs an a message to the provided log channel. If a callstack is included (detected by lines starting with 0x) if will be logged in the standard Unreal format of [Callstack] Address FunctionInfo [File]

Parameters
LogNameLog channel. If NAME_None then LowLevelOutputDebugStringf is used
FileFile name ANSI string (FILE)
LineLine number (LINE)
HeadingInformative heading displayed above the message callstack
MessageMulti-line message with a callstack

◆ ProcessFatalError()

static void FDebug::ProcessFatalError ( void * ProgramCounter)
static

Triggers a fatal error, using the error formatted to GErrorHist via a previous call to FMsg


The documentation for this struct was generated from the following file: