1. Epic GamesDeveloper
  3. Logging

Logging

API > API/Runtime > API/Runtime/Core

Classes

  Type Name Description
Public struct CSerializableForLog Describes a type that can be serialized for use in a log message.  
Public class FActionToken Message token that performs an action when activated.  
Public class FActorToken Basic message token that defaults its activated method to select an actor in the opened level  
Public class FAssetNameToken Basic message token that defaults its activated method to find a file Intended to hook into things like the content browser.  
Public class FDocumentationToken Basic message token that defaults is activated method to access UDN documentation.  
Public class FDynamicTextToken Message token with a localized attribute text payload  
Public struct FFixResult    
Public class FFixToken A fix action token. These are displayed in a separate list below the log message.  
Public class FImageToken Basic message token with an icon/image payload  
Public struct FLogCategory Template for log categories that transfers the compile-time constant default and compile time verbosity to the FLogCategoryBase constructor.  
Public struct FLogCategoryBase Base class for all log categories.  
Public struct FLogField    
Public struct FLogFieldCreator Create log fields from values optionally preceded by names.  
Public class FLogRecord Record of a log event.  
Public class FLogScopedCategoryAndVerbosityOverride Helper class that uses thread local storage to set up the default category and verbosity for the low level logging functions.  
Public class FLogScopedVerbosityOverride Helper class that allows setting scoped verbosity for log category.  
Public class FLogSuppressionInterface Interface to the log suppression system  
Public class FLogTime Time that a log event occurred.  
Public class FMessageLog    
Public class FMessageLogScopedOverride Scoped override for FMessageLog behavior.  
Public struct FMsg Define NO_LOGGING to strip out all writing to log files, OutputDebugString(), etc.  
Public class FSeverityToken Basic message token with a severity payload  
Public struct FStaticBasicLogDynamicData Data about a static basic log that is created on-demand.  
Public struct FStaticBasicLogRecord Data about a static basic log that is constant for every occurrence.  
Public struct FStaticLocalizedLogRecord Data about a static localized log that is constant for every occurrence.  
Public struct FStaticLogDynamicData Data about a static log that is created on-demand.  
Public struct FStaticLogRecord Data about a static log that is constant for every occurrence.  
Public class FTextToken Basic message token with a localized text payload  
Public class FTokenizedMessage This class represents a rich tokenized message, such as would be used for compiler output with 'hyperlinks' to source file locations  
Public class FTutorialToken    
Public class FURLToken Basic message token that defaults is activated method to traverse a URL  
Public class IMessageLog A message log.  
Public class IMessageToken A single message token for a FTokenizedMessage instance  
Public struct TFieldArgType    
Public struct TLogFieldName Wrapper to identify field names interleaved with field values.  

Typedefs

Name Description
FCanExecuteActionToken  
FLogCategoryName  
FOnActionTokenExecuted  
FOnMessageTokenActivated Delgate used when clocking a message token
FScopedCategoryAndVerbosityOverride  

Enums

  Type Name Description
Public enum EFixApplicability    
Public enum ELogVerbosity::Type Enum that defines the verbosity levels of the logging system.  
Public enum EMessageSeverity::Type Ordered according to their severity  
Public enum EMessageToken::Type    

Functions

  Type Name Description
Public function ELogVerbosity::Type

ParseLogVerbosityFromString ( const FString& VerbosityString
)

 Converts a string to verbosity
Public function void

SerializeForLog ( FCbWriter& Writer,
const TOptional< ValueType >& Optional
)

  
Public function const TCHAR * Converts verbosity to a string
Public function void

UE::CallSerializeForLog ( FCbWriter& Writer,
ValueType&& Value
)

 Wrapper to support calling SerializeForLog with ADL from within an overload of SerializeForLog.
Public function TLogFieldName< NameType > Verify that the name is likely a string literal and forward it on.
Public function void

UE::Logging::Private::FatalLogWithFields ( const FLogCategoryBase& Category,
const LogType& Log,
typename TFieldArgType< FieldArgTypes >::Type... FieldArgs
)

 Fatal log with fields created from the arguments, which may be values or pairs of name/value.
Public function void

UE::Logging::Private::LogIfActive ( const LogCategoryType& Category,
const LogRecordType& Log,
FieldArgTypes&&... FieldArgs
)

 Log if the category is active at this level of verbosity.
Public function void

UE::Logging::Private::LogWithFields ( const FLogCategoryBase& Category,
const LogType& Log,
typename TFieldArgType< FieldArgTypes >::Type... FieldArgs
)

 Log with fields created from the arguments, which may be values or pairs of name/value.
Public function void

UE::SerializeForLog ( FCbWriter& Writer,
ValueType&& Value
)

 Serializes the value to be used in a log message.
Public function bool

UEAsserts_Private::IsLogActive ( const CategoryType& Category
)

  

Variables

  Type Name Description
Public variable int32 GEnsureOnNANDiagnostic  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page