Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Static Public Member Functions | Static Public Attributes | Static Private Attributes | List of all members
FApp Class Reference

#include <App.h>

+ Collaboration diagram for FApp:

Static Public Member Functions

static FString GetBranchName ()
 
static EBuildConfiguration GetBuildConfiguration ()
 
static EBuildTargetType GetBuildTargetType ()
 
static const TCHAR * GetBuildVersion ()
 
static FString GetBuildDate ()
 
static FString GetGraphicsRHI ()
 
static void SetGraphicsRHI (FString RHIString)
 
static int32 GetEngineIsPromotedBuild ()
 
static FString GetEpicProductIdentifier ()
 
static FORCEINLINE const TCHAR * GetProjectName ()
 
static FString GetName ()
 
static FORCEINLINE bool HasProjectName ()
 
static FORCEINLINE bool IsGame ()
 
static FORCEINLINE bool IsProjectNameEmpty ()
 
static FORCEINLINE void SetProjectName (const TCHAR *InProjectName)
 
static FORCEINLINE void AuthorizeUser (const FString &UserName)
 
static FORCEINLINE void DenyAllUsers ()
 
static FORCEINLINE void DenyUser (const FString &UserName)
 
static FString GetZenStoreProjectId ()
 
static FORCEINLINE FGuid GetInstanceId ()
 
static FString GetInstanceName ()
 
static FORCEINLINE FGuid GetSessionId ()
 
static FORCEINLINE FString GetSessionName ()
 
static FORCEINLINE FString GetSessionOwner ()
 
static void InitializeSession ()
 
static FORCEINLINE bool IsAuthorizedUser (const FString &UserName)
 
static FORCEINLINE bool IsStandalone ()
 
static FORCEINLINE bool IsThisInstance (const FGuid &InInstanceId)
 
static FORCEINLINE void SetSessionName (const FString &NewName)
 
static FORCEINLINE void SetSessionOwner (const FString &NewOwner)
 
static INLINE_CANEVERRENDER bool CanEverRender ()
 
static INLINE_CANEVERRENDER bool CanEverRenderAudio ()
 
static bool IsInstalled ()
 
static bool IsEngineInstalled ()
 
static bool IsUnattended ()
 
static bool ShouldUseThreadingForPerformance ()
 
static FORCEINLINE bool IsBenchmarking ()
 
static void SetBenchmarking (bool bVal)
 
static FORCEINLINE double GetFixedDeltaTime ()
 
static void SetFixedDeltaTime (double Seconds)
 
static bool UseFixedTimeStep ()
 
static void SetUseFixedTimeStep (bool bVal)
 
static FORCEINLINE double GetCurrentTime ()
 
static void SetCurrentTime (double Seconds)
 
static FORCEINLINE double GetLastTime ()
 
static void UpdateLastTime ()
 
static FORCEINLINE double GetDeltaTime ()
 
static void SetDeltaTime (double Seconds)
 
static FORCEINLINE double GetIdleTime ()
 
static void SetIdleTime (double Seconds)
 
static FORCEINLINE double GetGameTime ()
 
static void SetGameTime (double Seconds)
 
static FORCEINLINE double GetIdleTimeOvershoot ()
 
static void SetIdleTimeOvershoot (double Seconds)
 
static FTimecode GetTimecode ()
 
static FFrameRate GetTimecodeFrameRate ()
 
static FORCEINLINE TOptional< FQualifiedFrameTime > GetCurrentFrameTime ()
 
static void SetTimecodeAndFrameRate (FTimecode InTimecode, FFrameRate InTimecodeFrameRate)
 
static void SetCurrentFrameTime (FQualifiedFrameTime InFrameTime)
 
static void InvalidateCurrentFrameTime ()
 
static FORCEINLINE float GetVolumeMultiplier ()
 
static FORCEINLINE void SetVolumeMultiplier (float InVolumeMultiplier)
 
static float GetUnfocusedVolumeMultiplier ()
 
static void SetUnfocusedVolumeMultiplier (float InVolumeMultiplier)
 
static void SetUseVRFocus (bool bInUseVRFocus)
 
static FORCEINLINE bool UseVRFocus ()
 
static void SetHasVRFocus (bool bInHasVRFocus)
 
static FORCEINLINE bool HasVRFocus ()
 
static void SetHasFocusFunction (bool(*InHasFocusFunction)())
 
static bool HasFocus ()
 
static void PrintStartupLogMessages ()
 

Static Public Attributes

static bool bUseFixedSeed
 

Static Private Attributes

static FGuid SessionId
 
static FString SessionName
 
static FString SessionOwner
 
static FString GraphicsRHI
 
static TArray< FString > SessionUsers
 
static bool Standalone
 
static bool bIsBenchmarking
 
static bool bUseFixedTimeStep
 
static double FixedDeltaTime
 
static double CurrentTime
 
static double LastTime
 
static double DeltaTime
 
static double IdleTime
 
static double IdleTimeOvershoot
 
static double GameTime
 
static TOptional< FQualifiedFrameTime > CurrentFrameTime
 
static bool bUseDropFrameFormatWhenSupported
 
static float VolumeMultiplier
 
static float UnfocusedVolumeMultiplier
 
static bool bUseVRFocus
 
static bool bHasVRFocus
 
static bool(* HasFocusFunction )()
 

Detailed Description

Provides information about the application.

Definition at line 29 of file App.h.

Member Function Documentation

◆ AuthorizeUser()

static FORCEINLINE void FApp::AuthorizeUser ( const FString & UserName)
inlinestatic

Add the specified user to the list of authorized session users.

Parameters
UserNameThe name of the user to add.
See also
DenyUser, DenyAllUsers, IsAuthorizedUser

Definition at line 194 of file App.h.

◆ CanEverRender()

static INLINE_CANEVERRENDER bool FApp::CanEverRender ( )
inlinestatic

Checks whether this application can render anything. Certain application types never render, while for others this behavior may be controlled by switching to NullRHI. This can be used for decisions like omitting code paths that make no sense on servers or games running in headless mode (e.g. automated tests).

Returns
true if the application can render, false otherwise.

Definition at line 375 of file App.h.

+ Here is the call graph for this function:

◆ CanEverRenderAudio()

static INLINE_CANEVERRENDER bool FApp::CanEverRenderAudio ( )
inlinestatic

Checks whether this application can render audio. Certain application types produce sound, while for others this can be controlled via the -nosound cmdline. This can be used for decisions like omitting code paths that make no sense on servers or games running in headless mode (e.g. automated tests).

Returns
true if the application can render audio, false otherwise.

Definition at line 392 of file App.h.

+ Here is the call graph for this function:

◆ DenyAllUsers()

static FORCEINLINE void FApp::DenyAllUsers ( )
inlinestatic

Removes all authorized users.

See also
AuthorizeUser, DenyUser, IsAuthorizedUser

Definition at line 204 of file App.h.

◆ DenyUser()

static FORCEINLINE void FApp::DenyUser ( const FString & UserName)
inlinestatic

Remove the specified user from the list of authorized session users.

Parameters
UserNameThe name of the user to remove.
See also
AuthorizeUser, DenyAllUsers, IsAuthorizedUser

Definition at line 215 of file App.h.

◆ GetBranchName()

static FString FApp::GetBranchName ( )
static

Gets the name of the version control branch that this application was built from.

Returns
The branch name.

◆ GetBuildConfiguration()

static EBuildConfiguration FApp::GetBuildConfiguration ( )
static

Gets the application's build configuration, i.e. Debug or Shipping.

Returns
The build configuration.

◆ GetBuildDate()

static FString FApp::GetBuildDate ( )
static

Gets the date at which this application was built.

Returns
Build date string.

◆ GetBuildTargetType()

static EBuildTargetType FApp::GetBuildTargetType ( )
static

Gets the target type of the current application (eg. client, server, etc...)

Returns
The build target type

◆ GetBuildVersion()

static const TCHAR * FApp::GetBuildVersion ( )
static

◆ GetCurrentFrameTime()

static FORCEINLINE TOptional< FQualifiedFrameTime > FApp::GetCurrentFrameTime ( )
inlinestatic

Gets a frame number generated by the engine's timecode provider. The current frame time is used to generate a timecode value. The optional will be false if no timecode provider was set or is not in a synchronized state.

Returns
the current frame time.

Definition at line 654 of file App.h.

◆ GetCurrentTime()

static FORCEINLINE double FApp::GetCurrentTime ( )
inlinestatic

Gets current time in seconds.

Returns
Current time in seconds.

Definition at line 520 of file App.h.

◆ GetDeltaTime()

static FORCEINLINE double FApp::GetDeltaTime ( )
inlinestatic

Gets time delta in seconds.

Returns
Time delta in seconds.

Definition at line 556 of file App.h.

◆ GetEngineIsPromotedBuild()

static int32 FApp::GetEngineIsPromotedBuild ( )
static

Gets the value of ENGINE_IS_PROMOTED_BUILD.

◆ GetEpicProductIdentifier()

static FString FApp::GetEpicProductIdentifier ( )
static

Gets the identifier for the unreal engine

◆ GetFixedDeltaTime()

static FORCEINLINE double FApp::GetFixedDeltaTime ( )
inlinestatic

Gets time step in seconds if a fixed delta time is wanted.

Returns
Time step in seconds for fixed delta time.

Definition at line 476 of file App.h.

◆ GetGameTime()

static FORCEINLINE double FApp::GetGameTime ( )
inlinestatic

Gets overall game time in seconds.

Returns
Overall game time in seconds.

Definition at line 596 of file App.h.

◆ GetGraphicsRHI()

static FString FApp::GetGraphicsRHI ( )
static

Gets the name of the graphics RHI currently in use.

Returns
name of Graphics RHI

◆ GetIdleTime()

static FORCEINLINE double FApp::GetIdleTime ( )
inlinestatic

Gets idle time in seconds.

Returns
Idle time in seconds.

Definition at line 576 of file App.h.

◆ GetIdleTimeOvershoot()

static FORCEINLINE double FApp::GetIdleTimeOvershoot ( )
inlinestatic

Gets idle time overshoot in seconds (the time beyond the wait time we requested for the frame). Only valid when IdleTime is > 0.

Returns
Idle time in seconds.

Definition at line 616 of file App.h.

◆ GetInstanceId()

static FORCEINLINE FGuid FApp::GetInstanceId ( )
inlinestatic

Gets the globally unique identifier of this application instance.

Every running instance of the engine has a globally unique instance identifier that can be used to identify it from anywhere on the network.

Returns
Instance identifier, or an invalid GUID if there is no local instance.
See also
GetSessionId

Definition at line 236 of file App.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetInstanceName()

static FString FApp::GetInstanceName ( )
inlinestatic

Gets the name of this application instance.

By default, the instance name is a combination of the computer name and process ID.

Returns
Instance name string.

Definition at line 249 of file App.h.

+ Here is the call graph for this function:

◆ GetLastTime()

static FORCEINLINE double FApp::GetLastTime ( )
inlinestatic

Gets previous value of CurrentTime.

Returns
Previous value of CurrentTime.

Definition at line 540 of file App.h.

◆ GetName()

static FString FApp::GetName ( )
inlinestatic

Gets the name of the application, i.e. "UE" or "Rocket".

Todo
need better application name discovery. this is quite horrible and may not work on future platforms.
Returns
Application name string.

Definition at line 116 of file App.h.

+ Here is the call graph for this function:

◆ GetProjectName()

static FORCEINLINE const TCHAR * FApp::GetProjectName ( )
inlinestatic

Gets the name of the current project.

Returns
The project name.

Definition at line 105 of file App.h.

◆ GetSessionId()

static FORCEINLINE FGuid FApp::GetSessionId ( )
inlinestatic

Gets the identifier of the session that this application is part of.

A session is group of applications that were launched and logically belong together. For example, when starting a new session in UFE that launches a game on multiple devices, all engine instances running on those devices will have the same session identifier. Conversely, sessions that were launched separately will have different session identifiers.

Returns
Session identifier, or an invalid GUID if there is no local instance.
See also
GetInstanceId

Definition at line 265 of file App.h.

◆ GetSessionName()

static FORCEINLINE FString FApp::GetSessionName ( )
inlinestatic

Gets the name of the session that this application is part of, if any.

Returns
Session name string.

Definition at line 275 of file App.h.

◆ GetSessionOwner()

static FORCEINLINE FString FApp::GetSessionOwner ( )
inlinestatic

Gets the name of the user who owns the session that this application is part of, if any.

If this application is part of a session that was launched from UFE, this function will return the name of the user that launched the session. If this application is not part of a session, this function will return the name of the local user account under which the application is running.

Returns
Name of session owner.

Definition at line 290 of file App.h.

◆ GetTimecode()

static FTimecode FApp::GetTimecode ( )
static

Convert the current frame time into a readable timecode. If the current frame time is not set, the timecode value will be defaulted.

Returns
the current timecode.

◆ GetTimecodeFrameRate()

static FFrameRate FApp::GetTimecodeFrameRate ( )
static

Get the frame rate of the current frame time. If the current frame time is not set, the frame rate value will be defaulted.

Returns
the current timecode frame rate.

◆ GetUnfocusedVolumeMultiplier()

static float FApp::GetUnfocusedVolumeMultiplier ( )
static

Helper function to get UnfocusedVolumeMultiplier from config and store so it's not retrieved every frame

Returns
Volume multiplier to use when app loses focus

◆ GetVolumeMultiplier()

static FORCEINLINE float FApp::GetVolumeMultiplier ( )
inlinestatic

Get Volume Multiplier

Returns
Current volume multiplier

Definition at line 692 of file App.h.

◆ GetZenStoreProjectId()

static FString FApp::GetZenStoreProjectId ( )
static

Gets the Zen store project id for the current application instance.

Returns
Zen store project id.

◆ HasFocus()

static bool FApp::HasFocus ( )
static

Gets Focus, Indicates that the application should continue to render Audio and Video as if it had window focus, even though it may not.

◆ HasProjectName()

static FORCEINLINE bool FApp::HasProjectName ( )
inlinestatic

Reports if the project name has been set

Returns
true if the project name has been set

Definition at line 140 of file App.h.

◆ HasVRFocus()

static FORCEINLINE bool FApp::HasVRFocus ( )
inlinestatic

Gets VRFocus, which indicates that the application should continue to render Audio and Video as if it had window focus, even though it may not.

Definition at line 745 of file App.h.

◆ InitializeSession()

static void FApp::InitializeSession ( )
static

Initializes the application session.

◆ InvalidateCurrentFrameTime()

static void FApp::InvalidateCurrentFrameTime ( )
inlinestatic

Invalidate the current frame time. It will reset the TOptional.

Definition at line 682 of file App.h.

◆ IsAuthorizedUser()

static FORCEINLINE bool FApp::IsAuthorizedUser ( const FString & UserName)
inlinestatic

Check whether the specified user is authorized to interact with this session.

Parameters
UserNameThe name of the user to check.
Returns
true if the user is authorized, false otherwise.
See also
AuthorizeUser, DenyUser, DenyAllUsers

Definition at line 307 of file App.h.

◆ IsBenchmarking()

static FORCEINLINE bool FApp::IsBenchmarking ( )
inlinestatic

Checks whether application is in benchmark mode.

Returns
true if application is in benchmark mode, false otherwise.

Definition at line 456 of file App.h.

+ Here is the caller graph for this function:

◆ IsEngineInstalled()

static bool FApp::IsEngineInstalled ( )
static

Checks whether the engine components of this application have been installed.

In binary Unreal Engine releases, the engine can be installed while the game is not. The game IsInstalled() setting will take precedence over this flag.

To override, pass -engineinstalled or -enginenotinstalled on the command line.

Returns
true if the engine is installed, false otherwise.

◆ IsGame()

static FORCEINLINE bool FApp::IsGame ( )
inlinestatic

Checks whether this application is a game.

Returns true if a normal or PIE game is active (basically !GIsEdit or || GIsPlayInEditorWorld) This must NOT be accessed on threads other than the game thread! Use View->Family->EnginShowFlags.Game on the rendering thread.

Returns
true if the application is a game, false otherwise.

Definition at line 154 of file App.h.

◆ IsInstalled()

static bool FApp::IsInstalled ( )
static

Checks whether this application has been installed.

Non-server desktop shipping builds are assumed to be installed.

Installed applications may not write to the folder in which they exist since they are likely in a system folder (like "Program Files" in windows). Instead, they should write to the OS-specific user folder FPlatformProcess::UserDir() or application data folder FPlatformProcess::ApplicationSettingsDir() User Access Control info for windows Vista and newer: http://en.wikipedia.org/wiki/User_Account_Control

To run an "installed" build without installing, use the -Installed command line parameter. To run a "non-installed" desktop shipping build, use the -NotInstalled command line parameter.

Returns
true if the application is installed, false otherwise.

◆ IsProjectNameEmpty()

static FORCEINLINE bool FApp::IsProjectNameEmpty ( )
inlinestatic

Reports if the project name is empty

Returns
true if the project name is empty

Definition at line 168 of file App.h.

◆ IsStandalone()

static FORCEINLINE bool FApp::IsStandalone ( )
inlinestatic

Checks whether this is a standalone application.

An application is standalone if it has not been launched as part of a session from UFE. If an application was launched from UFE, it is part of a session and not considered standalone.

Returns
true if this application is standalone, false otherwise.

Definition at line 320 of file App.h.

◆ IsThisInstance()

static FORCEINLINE bool FApp::IsThisInstance ( const FGuid & InInstanceId)
inlinestatic

Check whether the given instance ID identifies this instance.

Parameters
InInstanceIdThe instance ID to check.
Returns
true if the ID identifies this instance, false otherwise.

Definition at line 331 of file App.h.

+ Here is the call graph for this function:

◆ IsUnattended()

static bool FApp::IsUnattended ( )
static

Checks whether this application runs unattended.

Unattended applications are not monitored by anyone or are unable to receive user input. This method can be used to determine whether UI pop-ups or other dialogs should be shown.

Returns
true if the application runs unattended, false otherwise.

◆ PrintStartupLogMessages()

static void FApp::PrintStartupLogMessages ( )
static

◆ SetBenchmarking()

static void FApp::SetBenchmarking ( bool bVal)
inlinestatic

Sets application benchmarking mode.

Parameters
bValTrue sets application in benchmark mode, false sets to non-benchmark mode.

Definition at line 466 of file App.h.

◆ SetCurrentFrameTime()

static void FApp::SetCurrentFrameTime ( FQualifiedFrameTime InFrameTime)
inlinestatic

Sets the current frame time.

Parameters
InFrameTime- current frame time and frame rate.

Definition at line 676 of file App.h.

◆ SetCurrentTime()

static void FApp::SetCurrentTime ( double Seconds)
inlinestatic

Sets current time in seconds.

Parameters
seconds- Time in seconds.

Definition at line 530 of file App.h.

◆ SetDeltaTime()

static void FApp::SetDeltaTime ( double Seconds)
inlinestatic

Sets time delta in seconds.

Parameters
secondsTime in seconds.

Definition at line 566 of file App.h.

◆ SetFixedDeltaTime()

static void FApp::SetFixedDeltaTime ( double Seconds)
inlinestatic

Sets time step in seconds if a fixed delta time is wanted.

Parameters
secondsTime step in seconds for fixed delta time.

Definition at line 486 of file App.h.

◆ SetGameTime()

static void FApp::SetGameTime ( double Seconds)
inlinestatic

Sets overall game time in seconds.

Parameters
seconds- Overall game time in seconds.

Definition at line 606 of file App.h.

◆ SetGraphicsRHI()

static void FApp::SetGraphicsRHI ( FString RHIString)
static

Sets the Graphics RHI currently in use

◆ SetHasFocusFunction()

static void FApp::SetHasFocusFunction ( bool(*)() InHasFocusFunction)
static

Sets HasFocus, which is a function that indicates that the application window has focus.

Parameters
InHasFocusFunctionaddress of a function that can query the focus state, typically &FPlatformApplicationMisc::IsThisApplicationForeground

◆ SetHasVRFocus()

static void FApp::SetHasVRFocus ( bool bInHasVRFocus)
static

Sets VRFocus, which indicates that the application should continue to render Audio and Video as if it had window focus, even though it may not.

Parameters
bInVRFocusnew VRFocus value

◆ SetIdleTime()

static void FApp::SetIdleTime ( double Seconds)
inlinestatic

Sets idle time in seconds.

Parameters
seconds- Idle time in seconds.

Definition at line 586 of file App.h.

◆ SetIdleTimeOvershoot()

static void FApp::SetIdleTimeOvershoot ( double Seconds)
inlinestatic

Sets idle time overshoot in seconds (the time beyond the wait time we requested for the frame). Only valid when IdleTime is > 0.

Parameters
seconds- Idle time in seconds.

Definition at line 626 of file App.h.

◆ SetProjectName()

static FORCEINLINE void FApp::SetProjectName ( const TCHAR * InProjectName)
inlinestatic

Sets the name of the current project.

Parameters
InProjectNameName of the current project.

Definition at line 178 of file App.h.

◆ SetSessionName()

static FORCEINLINE void FApp::SetSessionName ( const FString & NewName)
inlinestatic

Set a new session name.

Parameters
NewNameThe new session name.
See also
SetSessionOwner

Definition at line 342 of file App.h.

+ Here is the call graph for this function:

◆ SetSessionOwner()

static FORCEINLINE void FApp::SetSessionOwner ( const FString & NewOwner)
inlinestatic

Set a new session owner.

Parameters
NewOwnerThe name of the new owner.
See also
SetSessionName

Definition at line 353 of file App.h.

◆ SetTimecodeAndFrameRate()

static void FApp::SetTimecodeAndFrameRate ( FTimecode InTimecode,
FFrameRate InTimecodeFrameRate )
inlinestatic

Sets the current timecode, and the frame rate to which it's relative.

Parameters
InTimecode- current timecode.
InTimecodeFrameRate- current timecode framerate.

Definition at line 666 of file App.h.

+ Here is the call graph for this function:

◆ SetUnfocusedVolumeMultiplier()

static void FApp::SetUnfocusedVolumeMultiplier ( float InVolumeMultiplier)
static

Sets the Unfocused Volume Multiplier

◆ SetUseFixedTimeStep()

static void FApp::SetUseFixedTimeStep ( bool bVal)
inlinestatic

Enables or disabled usage of fixed time step.

Parameters
whetherto use fixed time step or not

Definition at line 510 of file App.h.

◆ SetUseVRFocus()

static void FApp::SetUseVRFocus ( bool bInUseVRFocus)
static

Sets if VRFocus should be used.

Parameters
bInUseVRFocusnew bUseVRFocus value

◆ SetVolumeMultiplier()

static FORCEINLINE void FApp::SetVolumeMultiplier ( float InVolumeMultiplier)
inlinestatic

Set Volume Multiplier

Parameters
InVolumeMultipliernew volume multiplier

Definition at line 702 of file App.h.

◆ ShouldUseThreadingForPerformance()

static bool FApp::ShouldUseThreadingForPerformance ( )
static

Checks whether the application should run multi-threaded for performance critical features.

This method is used for performance based threads (like rendering, task graph). This will not disable async IO or similar threads needed to disable hitching

Returns
true if this isn't a server, has more than one core, does not have a -onethread command line options, etc.

◆ UpdateLastTime()

static void FApp::UpdateLastTime ( )
inlinestatic

Updates Last time to CurrentTime.

Definition at line 546 of file App.h.

◆ UseFixedTimeStep()

static bool FApp::UseFixedTimeStep ( )
inlinestatic

Gets whether we want to use a fixed time step or not.

Returns
True if using fixed time step, false otherwise.

Definition at line 496 of file App.h.

◆ UseVRFocus()

static FORCEINLINE bool FApp::UseVRFocus ( )
inlinestatic

Gets if VRFocus should be used

Definition at line 729 of file App.h.

Member Data Documentation

◆ bHasVRFocus

bool FApp::bHasVRFocus
staticprivate

Holds a flag indicating if app has focus in side the VR headset

Definition at line 837 of file App.h.

◆ bIsBenchmarking

bool FApp::bIsBenchmarking
staticprivate

Holds a flag Whether we are in benchmark mode or not.

Definition at line 795 of file App.h.

◆ bUseDropFrameFormatWhenSupported

bool FApp::bUseDropFrameFormatWhenSupported
staticprivate

Holds if we should generate a drop frame timecode when the frame rate does support it.

Definition at line 825 of file App.h.

◆ bUseFixedSeed

bool FApp::bUseFixedSeed
static

Definition at line 764 of file App.h.

◆ bUseFixedTimeStep

bool FApp::bUseFixedTimeStep
staticprivate

Holds a flag whether we want to use a fixed time step or not.

Definition at line 798 of file App.h.

◆ bUseVRFocus

bool FApp::bUseVRFocus
staticprivate

Holds a flag indicating if VRFocus should be used

Definition at line 834 of file App.h.

◆ CurrentFrameTime

TOptional<FQualifiedFrameTime> FApp::CurrentFrameTime
staticprivate

Holds the current frame time and framerate.

Definition at line 822 of file App.h.

◆ CurrentTime

double FApp::CurrentTime
staticprivate

Holds current time.

Definition at line 804 of file App.h.

◆ DeltaTime

double FApp::DeltaTime
staticprivate

Holds current delta time in seconds.

Definition at line 810 of file App.h.

◆ FixedDeltaTime

double FApp::FixedDeltaTime
staticprivate

Holds time step if a fixed delta time is wanted.

Definition at line 801 of file App.h.

◆ GameTime

double FApp::GameTime
staticprivate

Holds overall game time.

Definition at line 819 of file App.h.

◆ GraphicsRHI

FString FApp::GraphicsRHI
staticprivate

Holds the name the graphics RHI currently in use

Definition at line 786 of file App.h.

◆ HasFocusFunction

bool(* FApp::HasFocusFunction) ()
staticprivate

Holds a function address that can indicate if application has focus

Definition at line 840 of file App.h.

◆ IdleTime

double FApp::IdleTime
staticprivate

Holds time we spent sleeping in UpdateTimeAndHandleMaxTickRate() if our frame time was smaller than one allowed by target FPS.

Definition at line 813 of file App.h.

◆ IdleTimeOvershoot

double FApp::IdleTimeOvershoot
staticprivate

Holds the amount of IdleTime that was LONGER than we tried to sleep. The OS can't sleep the exact amount of time, so this measures that overshoot.

Definition at line 816 of file App.h.

◆ LastTime

double FApp::LastTime
staticprivate

Holds previous value of CurrentTime.

Definition at line 807 of file App.h.

◆ SessionId

FGuid FApp::SessionId
staticprivate

Holds the session identifier.

Definition at line 777 of file App.h.

◆ SessionName

FString FApp::SessionName
staticprivate

Holds the session name.

Definition at line 780 of file App.h.

◆ SessionOwner

FString FApp::SessionOwner
staticprivate

Holds the name of the user that launched session.

Definition at line 783 of file App.h.

◆ SessionUsers

TArray<FString> FApp::SessionUsers
staticprivate

List of authorized session users.

Definition at line 789 of file App.h.

◆ Standalone

bool FApp::Standalone
staticprivate

Holds a flag indicating whether this is a standalone session.

Definition at line 792 of file App.h.

◆ UnfocusedVolumeMultiplier

float FApp::UnfocusedVolumeMultiplier
staticprivate

Read from config to define the volume when app loses focus

Definition at line 831 of file App.h.

◆ VolumeMultiplier

float FApp::VolumeMultiplier
staticprivate

Use to affect the app volume when it loses focus

Definition at line 828 of file App.h.

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