UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FFeedbackContextAnsi Class Reference

#include <FeedbackContextAnsi.h>

+ Inheritance diagram for FFeedbackContextAnsi:

Public Member Functions

CORE_API void Serialize (const TCHAR *V, ELogVerbosity::Type Verbosity, const FName &Category) override
 
CORE_API void Serialize (const TCHAR *V, ELogVerbosity::Type Verbosity, const FName &Category, double Time) override
 
CORE_API void SerializeRecord (const UE::FLogRecord &Record) override
 
CORE_API bool YesNof (const FText &Question) override
 
FContextSupplierGetContext () const override
 
void SetContext (FContextSupplier *InContext) override
 
- Public Member Functions inherited from FFeedbackContext
virtual bool ReceivedUserCancel ()
 
UE_FORCEINLINE_HINT const FSlowTaskStackGetScopeStack () const
 
 DECLARE_EVENT_OneParam (FFeedbackContext, FOnStartSlowTask, const FText &TaskName)
 
FOnStartSlowTaskOnStartSlowTask ()
 
 DECLARE_EVENT_TwoParams (FFeedbackContext, FOnFinalizeSlowTask, const FText &TaskName, double DurationInSeconds)
 
FOnFinalizeSlowTaskOnFinalizeSlowTask ()
 
 DECLARE_EVENT_TwoParams (FFeedbackContext, FOnStartSlowTaskWithGuid, FGuid Guid, const FText &TaskName)
 
FOnStartSlowTaskWithGuidOnStartSlowTaskWithGuid ()
 
 DECLARE_EVENT_TwoParams (FFeedbackContext, FOnFinalizeSlowTaskWithGuid, FGuid Guid, const FText &TaskName)
 
FOnFinalizeSlowTaskWithGuidOnFinalizeSlowTaskWithGuid ()
 
CORE_API void BeginSlowTask (const FText &Task, bool ShowProgressDialog, bool bShowCancelButton=false)
 
CORE_API void UpdateProgress (int32 Numerator, int32 Denominator)
 
CORE_API void StatusUpdate (int32 Numerator, int32 Denominator, const FText &StatusText)
 
CORE_API void StatusForceUpdate (int32 Numerator, int32 Denominator, const FText &StatusText)
 
CORE_API void EndSlowTask ()
 
virtual TWeakPtr< class SBuildProgressWidgetShowBuildProgressWindow ()
 
virtual void CloseBuildProgressWindow ()
 
CORE_API FFeedbackContext ()
 
virtual CORE_API ~FFeedbackContext ()
 
void GetWarnings (TArray< FString > &OutWarnings) const
 
int32 GetNumWarnings () const
 
void GetErrors (TArray< FString > &OutErrors) const
 
int32 GetNumErrors () const
 
void GetErrorsAndWarningsAndEmpty (TArray< FString > &OutWarningsAndErrors)
 
void ClearWarningsAndErrors ()
 
- Public Member Functions inherited from FOutputDevice
CORE_API FOutputDevice ()
 
CORE_API FOutputDevice (FOutputDevice &&)
 
CORE_API FOutputDevice (const FOutputDevice &)
 
CORE_API FOutputDeviceoperator= (FOutputDevice &&)
 
CORE_API FOutputDeviceoperator= (const FOutputDevice &)
 
virtual CORE_API ~FOutputDevice ()
 
virtual void Flush ()
 
virtual void TearDown ()
 
void SetSuppressEventTag (bool bInSuppressEventTag)
 
UE_FORCEINLINE_HINT bool GetSuppressEventTag () const
 
void SetAutoEmitLineTerminator (bool bInAutoEmitLineTerminator)
 
UE_FORCEINLINE_HINT bool GetAutoEmitLineTerminator () const
 
virtual void Dump (class FArchive &Ar)
 
virtual bool IsMemoryOnly () const
 
virtual bool CanBeUsedOnAnyThread () const
 
virtual bool CanBeUsedOnMultipleThreads () const
 
virtual bool CanBeUsedOnPanicThread () const
 
CORE_API void Log (const TCHAR *S)
 
CORE_API void Log (ELogVerbosity::Type Verbosity, const TCHAR *S)
 
CORE_API void Log (const FName &Category, ELogVerbosity::Type Verbosity, const TCHAR *Str)
 
CORE_API void Log (const FString &S)
 
CORE_API void Log (const FText &S)
 
CORE_API void Log (ELogVerbosity::Type Verbosity, const FString &S)
 
CORE_API void Log (const FName &Category, ELogVerbosity::Type Verbosity, const FString &S)
 
template<typename FmtType >
void Logf (const FmtType &Fmt)
 
template<typename FmtType , typename... Types>
void Logf (const FmtType &Fmt, Types... Args)
 
template<typename FmtType , typename... Types>
void Logf (ELogVerbosity::Type Verbosity, const FmtType &Fmt, Types... Args)
 
template<typename FmtType , typename... Types>
void CategorizedLogf (const FName &Category, ELogVerbosity::Type Verbosity, const FmtType &Fmt, Types... Args)
 

Static Public Member Functions

static CORE_API void LocalPrint (const TCHAR *Str)
 

Public Attributes

FContextSupplierContext = nullptr
 
FOutputDeviceAuxOut = nullptr
 
- Public Attributes inherited from FFeedbackContext
bool TreatWarningsAsErrors = false
 
bool TreatErrorsAsWarnings = false
 

Additional Inherited Members

- Protected Member Functions inherited from FFeedbackContext
virtual void StartSlowTask (const FText &Task, bool bShowCancelButton=false)
 
virtual void FinalizeSlowTask ()
 
virtual void ProgressReported (const float TotalProgressInterp, FText DisplayMessage)
 
virtual CORE_API bool IsPlayingInEditor () const
 
CORE_API ELogVerbosity::Type ResolveVerbosity (ELogVerbosity::Type Verbosity) const
 
CORE_API void FormatLine (FStringBuilderBase &Out, const TCHAR *V, ELogVerbosity::Type Verbosity, const FName &Category, double Time, ELogVerbosity::Type *OutVerbosity=nullptr) const
 
CORE_API void FormatRecordLine (FStringBuilderBase &Out, const UE::FLogRecord &Record, ELogVerbosity::Type *OutVerbosity=nullptr) const
 
const TSharedPtr< FSlowTaskStack > & GetScopeStackSharedPtr () const
 
CORE_API void RequestUpdateUI (bool bForceUpdate=false)
 
CORE_API void UpdateUI ()
 
void AddWarning (const FString &InWarning)
 
void AddWarning (FString &&InWarning)
 
void AddError (const FString &InError)
 
void AddError (FString &&InError)
 
- Protected Attributes inherited from FFeedbackContext
friend FSlowTask
 
FSlowTaskStack ScopeStack
 
TSharedPtr< FSlowTaskStackScopeStackSharedPtr
 
TArray< TUniquePtr< FSlowTask > > LegacyAPIScopes
 
- Protected Attributes inherited from FOutputDevice
bool bSuppressEventTag
 
bool bAutoEmitLineTerminator
 

Member Function Documentation

◆ GetContext()

FContextSupplier * FFeedbackContextAnsi::GetContext ( ) const
inlineoverridevirtual

Reimplemented from FFeedbackContext.

◆ LocalPrint()

void FFeedbackContextAnsi::LocalPrint ( const TCHAR Str)
static

◆ Serialize() [1/2]

void FFeedbackContextAnsi::Serialize ( const TCHAR V,
ELogVerbosity::Type  Verbosity,
const FName Category 
)
overridevirtual

Reimplemented from FFeedbackContext.

◆ Serialize() [2/2]

void FFeedbackContextAnsi::Serialize ( const TCHAR V,
ELogVerbosity::Type  Verbosity,
const FName Category,
double  Time 
)
overridevirtual

Reimplemented from FFeedbackContext.

◆ SerializeRecord()

void FFeedbackContextAnsi::SerializeRecord ( const UE::FLogRecord Record)
overridevirtual

Reimplemented from FFeedbackContext.

◆ SetContext()

void FFeedbackContextAnsi::SetContext ( FContextSupplier InContext)
inlineoverridevirtual

Reimplemented from FFeedbackContext.

◆ YesNof()

bool FFeedbackContextAnsi::YesNof ( const FText Question)
overridevirtual

Ask the user a binary question, returning their answer

Reimplemented from FFeedbackContext.

Member Data Documentation

◆ AuxOut

FOutputDevice* FFeedbackContextAnsi::AuxOut = nullptr

◆ Context

FContextSupplier* FFeedbackContextAnsi::Context = nullptr

The documentation for this class was generated from the following files: