FEditorAnalyticsSession

Windows
MacOS
Linux

References

Module

EditorAnalyticsSession

Header

/Engine/Source/Developer/EditorAnalyticsSession/Public/EditorAnalyticsSession.h

Include

#include "EditorAnalyticsSession.h"

Syntax

struct FEditorAnalyticsSession

Variables

Name Description

Public variable

FString

 

AppId

Public variable

FString

 

AppVersion

Public variable

float

 

AverageFPS

Public variable

bool : 1

 

bCrashed

Public variable

bool : 1

 

bGPUCrashed

Public variable

bool : 1

 

bIs64BitOS

Public variable

bool : 1

 

bIsDebugger

Public variable

bool : 1

 

bIsInEnterprise

Public variable

bool : 1

 

bIsInPIE

Public variable

bool : 1

 

bIsInVRMode

Public variable

bool : 1

 

bIsLowDriveSpace

Public variable

bool : 1

 

bIsTerminating

Public variable

bool : 1

 

bIsVanilla

Public variable

bool : 1

 

bWasEverDebugger

Public variable

bool : 1

 

bWasShutdown

Public variable

FString

 

CPUBrand

Public variable

int32

 

CPULogicalCores

Public variable

int32

 

CPUPhysicalCores

Public variable

FString

 

CPUVendor

Public variable

FString

 

CurrentUserActivity

Public variable

FString

 

DesktopGPUAdapter

Public variable

FString

 

EngineVersion

Public variable

TOptional < int3 ...

 

ExitCode

Public variable

uint32

 

GPUDeviceID

Public variable

uint32

 

GPUVendorID

Public variable

FString

 

GRHIAdapterInternalDriverVersion

Public variable

FString

 

GRHIAdapterUserDriverVersion

Public variable

uint32

 

GRHIDeviceRevision

Public variable

int32

 

Idle1Min

Public variable

int32

 

Idle30Min

Public variable

int32

 

Idle5Min

Public variable

int32

 

IdleSeconds

Public variable

TOptional < int3 ...

 

MonitorExceptCode

Public variable

uint32

 

MonitorProcessID

Public variable

FString

 

OSMajor

Public variable

FString

 

OSMinor

Public variable

FString

 

OSVersion

Public variable

uint32

 

PlatformProcessID

Public variable

TArray < FString ...

 

Plugins

Public variable

FString

 

ProjectDescription

Public variable

FString

 

ProjectID

Public variable

FString

 

ProjectName

Public variable

FString

 

ProjectVersion

Public variable

FString

 

RenderingGPUAdapter

Public variable

FString

 

SessionId

Public variable

FDateTime

 

StartupTimestamp

Public variable

FDateTime

 

Timestamp

Public variable

int32

 

TotalEditorInactivitySeconds

Public variable

uint64

 

TotalPhysicalRAM

Public variable

int32

 

TotalUserInactivitySeconds

Public variable

FString

 

UserId

Constructors

Name Description

Public function

FEditorAnalyticsSession()

Functions

Name Description

Public function Const

bool

 

Delete()

Delete the stored values of this session. Does not modify the actual session object.

Public function Static

bool

 

FindSession

(
    const uint32 InSessionProcessId,
    FEditorAnalyticsSession & OutSessio...
)

Find the sessions for which the PlatformProcessID matches the specified session process id.

Public function Static

bool

 

GetStoredSessionIDs

(
    TArray < FString >& OutSessions
)

Retrieve a list of session IDs that are currently stored locally.

Public function Static

bool

 

IsLocked()

Is the local storage already locked?

Public function

bool

 

Load

(
    const FString & InSessionID
)

Load a session with the given session ID from stored values.

Public function Static

bool

 

LoadAllStoredSessions

(
    TArray < FEditorAnalyticsSession >&...
)

Read all stored sessions into the given array.

Public function Static

bool

 

Lock

(
    FTimespan Timeout
)

Acquire a lock for local storage.

Public function

void

 

LogEvent

(
    EEventType EventTpe,
    const FDateTime & Timestamp
)

Append an event to the session log.

Public function

bool

 

Save()

Save this session to stored values.

Public function

void

 

SaveExitCode

(
    int32 ExitCode
)

Persist the Editor exit code corresponding of this session in the key-store value.

Public function

void

 

SaveMonitorExceptCode

(
    int32 ExceptCode
)

Set the exception code that caused the monitor application to crash.

Public function Static

bool

 

SaveStoredSessionIDs

(
    const TArray < FString >& InSession...
)

Save the given session IDs to storage.

Public function Static

bool

 

TryLock()

Try to acquire the local storage lock without blocking.

Public function Static

void

 

Unlock()

Unlock the local storage.

Enums

Name

Description

Public enum

EEventType

Constants

Name

Description

StoredValuesLock

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback