| FOutputDevice
|
Module |
|
Header |
/Engine/Source/Runtime/Engine/Public/VisualLogger/VisualLogger.h |
Include |
#include "VisualLogger/VisualLogger.h" |
class FVisualLogger : public FOutputDevice
Name | Description | ||
---|---|---|---|
|
AllExtensions |
Visual Logger extensions map. |
|
|
int32: 1 |
bBlockedAllCategories |
If set all categories are blocked from logging |
|
int32: 1 |
bIsRecordingOnServer |
Variable set (from cheat manager) when logging is active on server |
|
int32: 1 |
bIsRecordingToFile |
If set we are recording to file |
|
CategoriesWhitelist |
White list of categories to bypass blocking |
|
|
ChildToOwnerMap |
For any object that has requested redirection this map holds where we should redirect the trafic to |
|
|
ClassWhitelist |
White-listed classes - only instances of these classes will be logged. |
|
|
CurrentEntryPerObject |
Current entry with all data. |
|
|
LastUniqueIds |
Last generated unique id for given times tamp |
|
|
LogFileNameGetter |
Delegate to set project specific file name for vlogs |
|
|
ObjectToClassNameMap |
Map to contain class names for Objects (they can be destroyed after while) |
|
|
ObjectToNameMap |
Map to contain names for Objects (they can be destroyed after while) |
|
|
ObjectToPointerMap |
Map to contain information about pointers in game. |
|
|
ObjectToWorldMap |
Cached map to world information because it's just raw pointer and not real object. |
|
|
ObjectWhitelist |
White-listed objects - takes priority over class whitelist and should be used to create exceptions in it if ObjectWhitelist is empty (default) everything will log do NOT read from those pointers, they can be invalid! |
|
|
OutputDevices |
Array of output devices to redirect to |
|
|
float |
StartRecordingToFileTime |
Start recording time |
|
UseBinaryFileDevice |
Specifies if the Binary Device is being used |
|
|
VisualLoggerCleanupTimerHandle |
Handle for timer used to serialize all waiting logs |
No constructors are accessible with public or protected access.
Name | Description | |
---|---|---|
|
~FVisualLogger() |
Name | Description | ||
---|---|---|---|
|
AddCategoryToWhitelist ( |
||
|
AddDevice ( |
Add visual logger output device |
|
|
AddWhitelistedClass ( |
||
|
AddWhitelistedObject ( |
||
|
ArrowLogf |
||
|
ArrowLogf ( |
Arrow. |
|
|
BlockAllCategories ( |
Blocks all categories from logging. It can be bypassed with white list for categories |
|
|
CategorizedLogf ( |
Regular text log. |
|
|
CategorizedLogf ( |
||
|
CheckVisualLogInputInternal ( |
Internal check for each usage of visual logger |
|
|
Cleanup |
Removes all logged data. |
|
|
ClearObjectWhitelist() |
||
|
ClearWhiteList() |
||
|
DiscardRecordingToFile() |
Disables recording to file and discards all data without saving it to file |
|
|
EventLog ( |
Log events |
|
|
EventLog ( |
Log events |
|
|
EventLog ( |
Log events |
|
|
EventLog |
||
|
EventLog ( |
Log events |
|
|
EventLog |
Log events |
|
|
EventLog ( |
Log events |
|
|
UObject *... |
FindRedirection ( |
Find and return redirection object for given object |
|
GeometryBoxLogf |
||
|
GeometryBoxLogf ( |
Box log. |
|
|
GeometryConvexLogf ( |
2d Convex shape |
|
|
GeometryConvexLogf |
||
|
GeometryShapeLogf ( |
Cone log. |
|
|
GeometryShapeLogf |
||
|
GeometryShapeLogf ( |
Location/Sphere log. |
|
|
GeometryShapeLogf ( |
||
|
GeometryShapeLogf ( |
3d Mesh log |
|
|
GeometryShapeLogf |
||
|
GeometryShapeLogf ( |
Segment log. |
|
|
GeometryShapeLogf |
||
|
GeometryShapeLogf ( |
Capsule log. |
|
|
GeometryShapeLogf ( |
Cylinder log. |
|
|
GeometryShapeLogf |
||
|
GeometryShapeLogf |
||
|
FVisualLogge... |
Get() |
Static getter |
|
const TMap< ... |
GetAllExtensions() |
Returns reference to map with all registered extension |
|
FChildToOwne... |
GetChildToOwnerRedirectionMap() |
|
|
const TArray... |
GetDevices() |
Remove visual logger output device |
|
FVisualLogEn... |
GetEntryToWrite ( |
Returns current entry for given TimeStap or creates another one but first it serialize previous entry as completed to vislog devices. |
|
FVisualLogEx... |
GetExtensionForTag ( |
Returns extension identified by given tag |
|
FVisualLogEn... |
GetLastEntryForObject ( |
Retrieves last used entry for given UObject |
|
FObjectToWor... |
GetObjectToWorldMap() |
|
|
FOwnerToChil... |
GetRedirectionMap ( |
|
|
GetUniqueId ( |
Generates and returns Id unique for given timestamp - used to connect different logs between (ex. text log with geometry shape) |
|
|
const TArray... |
GetWhiteList() |
Returns white list for modifications |
|
HistogramDataLogf ( |
Histogram data. |
|
|
HistogramDataLogf |
||
|
IsBlockedForAllCategories() |
Checks if all categories are blocked |
|
|
IsCategoryLogged ( |
Check if log category can be recorded, verify before using GetEntryToWrite! |
|
|
IsClassWhitelisted ( |
||
|
IsObjectWhitelisted ( |
||
|
IsRecording() |
Return information is vlog recording is enabled or not |
|
|
IsRecordingOnServer() |
||
|
IsRecordingToFile() |
Return information is vlog recording is enabled or not |
|
|
IsWhiteListed ( |
||
|
NavAreaShapeLogf |
||
|
NavAreaShapeLogf ( |
NavArea/Extruded convex log. |
|
|
NavigationDataDump ( |
Navigation data debug snapshot. |
|
|
NavigationDataDump ( |
Navigation data debug snapshot. |
|
|
Redirect |
Set log owner redirection from one object to another, to combine logs |
|
|
RegisterExtension ( |
Register extension to use by LogVisualizer |
|
|
RemoveDevice ( |
Remove visual logger output device |
|
|
SetIsRecording ( |
Starts visual log collecting and recording |
|
|
SetIsRecordingOnServer ( |
||
|
SetIsRecordingToFile ( |
Starts visual log collecting and recording |
|
|
SetLogFileNameGetter ( |
FileName getter to set project specific file name for vlogs - highly encouradged to use FVisualLogFilenameGetterDelegate::CreateUObject with this |
|
|
Shutdown() |
Called on engine shutdown to flush all, etc. |
|
|
UnregisterExtension ( |
Removes previously registered extension |
Name |
Description |
---|---|
bIsRecording |
If set we are recording and collecting all vlog data |
NavigationDataDumpDelegate |
|
WorldToRedirectionMap |
Map for inter-objects redirections. |
Name | Description | ||
---|---|---|---|
|
AddCategortyToWhiteList ( |
Please use the AddCategoryToWhitelist instead |