1. Epic GamesDeveloper
  3. FApp

FApp

Provides information about the application.

API > API/Runtime > API/Runtime/Core

Provides information about the application.

   
Name FApp
Type class
Header File /Engine/Source/Runtime/Core/Public/Misc/App.h
Include Path #include "Misc/App.h"

Syntax

class FApp

Constants

Name Type Remarks Include Path
bHasVRFocus bool Holds a flag indicating if app has focus in side the VR headset Misc/App.h
bIsBenchmarking bool Holds a flag Whether we are in benchmark mode or not. Misc/App.h
bUseFixedSeed bool If the random seed started with a constant or on time, can be affected by -FIXEDSEED or -BENCHMARK Misc/App.h
bUseFixedTimeStep bool Holds a flag whether we want to use a fixed time step or not. Misc/App.h
bUseVRFocus bool Holds a flag indicating if VRFocus should be used Misc/App.h
CurrentFrameTime TOptional< FQualifiedFrameTime > Holds the current frame time and framerate. Misc/App.h
CurrentTime std::atomic< double > Holds current time. Misc/App.h
DeltaTime std::atomic< double > Holds current delta time in seconds. Misc/App.h
FixedDeltaTime std::atomic< double > Holds time step if a fixed delta time is wanted. Misc/App.h
GameTime std::atomic< double > Holds overall game time. Misc/App.h
GraphicsRHI FString Holds the name the graphics RHI currently in use Misc/App.h
HasFocusFunction bool(* Holds a function address that can indicate if application has focus Misc/App.h
IdleTime std::atomic< double > Holds time we spent sleeping in UpdateTimeAndHandleMaxTickRate() if our frame time was smaller than one allowed by target FPS. Misc/App.h
IdleTimeOvershoot std::atomic< double > Holds the amount of IdleTime that was LONGER than we tried to sleep. Misc/App.h
LastTime std::atomic< double > Holds previous value of CurrentTime. Misc/App.h
SessionId FGuid Holds the session identifier. Misc/App.h
SessionName FString Holds the session name. Misc/App.h
SessionOwner FString Holds the name of the user that launched session. Misc/App.h
SessionUsers TArray< FString > List of authorized session users. Misc/App.h
Standalone bool Holds a flag indicating whether this is a standalone session. Misc/App.h
UnfocusedVolumeMultiplier float Read from config to define the volume when app loses focus Misc/App.h
VolumeMultiplier float Use to affect the app volume when it loses focus Misc/App.h

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool AllowUnattendedInput ()

 Checks whether this application allows unattended input. Misc/App.h  

static void AuthorizeUser ( const FString& UserName
)

 Add the specified user to the list of authorized session users. Misc/App.h  

static bool CanEverRender ()

 Checks whether this application can render anything. Misc/App.h  

static bool CanEverRenderAudio ()

 Checks whether this application can render audio. Misc/App.h  
Checks whether this application can render anything or produce a derived data needed for rednering. Misc/App.h  

static void DenyAllUsers ()

 Removes all authorized users. Misc/App.h  

static void DenyUser ( const FString& UserName
)

 Remove the specified user from the list of authorized session users. Misc/App.h  

static FString GetBranchName()

 Gets the name of the version control branch that this application was built from. Misc/App.h  

static EBuildConfiguration GetBuildConfiguration()

 Gets the application's build configuration, i.e. Debug or Shipping. Misc/App.h  

static FString GetBuildDate()

 Gets the date at which this application was built. Misc/App.h  

static EBuildTargetType GetBuildTargetType()

 Gets the target type of the current application (eg. client, server, etc...) Misc/App.h  

static const TCHAR * GetBuildURL ()

 Gets the URL for a job which created these binaries. Misc/App.h  

static const TCHAR * GetBuildVersion ()

 Gets the unique version string for this build. Misc/App.h  
Gets a frame number generated by the engine's timecode provider. Misc/App.h  

static double GetCurrentTime()

 Gets current time in seconds. Misc/App.h  

static double GetDeltaTime()

 Gets time delta in seconds. Misc/App.h  

static int32 GetEngineIsPromotedBuild()

 Gets the value of ENGINE_IS_PROMOTED_BUILD. Misc/App.h  

static FString GetEpicProductIdentifier()

 Gets the identifier for the unreal engine Misc/App.h  

static const TCHAR * GetExecutingJobURL ()

 Gets the URL for the currently running Horde job/step if any. Misc/App.h  

static double GetFixedDeltaTime()

 Gets time step in seconds if a fixed delta time is wanted. Misc/App.h  

static double GetGameTime()

 Gets overall game time in seconds. Misc/App.h  

static FString GetGraphicsRHI()

 Gets the name of the graphics RHI currently in use. Misc/App.h  

static double GetIdleTime()

 Gets idle time in seconds. Misc/App.h  

static double GetIdleTimeOvershoot ()

 Gets idle time overshoot in seconds (the time beyond the wait time we requested for the frame). Misc/App.h  

static FGuid GetInstanceId ()

 Gets the globally unique identifier of this application instance. Misc/App.h  
Gets the name of this application instance. Misc/App.h  

static bool GetIsWithDebugInfo()

 Returns whether the binaries were built with debug info Misc/App.h  

static double GetLastTime()

 Gets previous value of CurrentTime. Misc/App.h  

static FString GetName()

 Gets the name of the application, i.e. "UE" or "Rocket". Misc/App.h  

static const TCHAR * GetProjectName()

 Gets the name of the current project. Misc/App.h  

static FGuid GetSessionId ()

 Gets the identifier of the session that this application is part of. Misc/App.h  

static FString GetSessionName()

 Gets the name of the session that this application is part of, if any. Misc/App.h  

static const FCbObjectId & GetSessionObjectId ()

 Gets the identifier of the session that this application is part of as a FCbObject. Misc/App.h  
Gets the name of the user who owns the session that this application is part of, if any. Misc/App.h  
Convert the current frame time into a readable timecode. Misc/App.h  
Get the frame rate of the current frame time. Misc/App.h  

static float GetUnfocusedVolumeMultiplier()

 Helper function to get UnfocusedVolumeMultiplier from config and store so it's not retrieved every frame Misc/App.h  

static float GetVolumeMultiplier()

 Get Volume Multiplier Misc/App.h  

static FString GetZenStoreProjectId ( FStringView SubProject
)

 Gets the Zen store project id for the current project file path. Misc/App.h  

static bool HasFocus()

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

static bool HasProjectName()

 Reports if the project name has been set Misc/App.h  

static bool HasVRFocus()

 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. Misc/App.h  

static void InitializeSession()

 Initializes the application session. Misc/App.h  

static void InvalidateCurrentFrameTime()

 Invalidate the current frame time. It will reset the TOptional. Misc/App.h  

static bool IsAudioMuted ()

 Checks whether this application should mute the audio output (-muteaudio) This is a safer alternative to -nosound for users who want to mute the audio of the game but keep the game rendering sound. Misc/App.h  

static bool IsAuthorizedUser ( const FString& UserName
)

 Check whether the specified user is authorized to interact with this session. Misc/App.h  

static bool IsBenchmarking()

 Checks whether application is in benchmark mode. Misc/App.h  

static bool IsEngineInstalled ()

 Checks whether the engine components of this application have been installed. Misc/App.h  

static bool IsGame ()

 Checks whether this application is a game. Misc/App.h  

static bool IsInstalled ()

 Checks whether this application has been installed. Misc/App.h  

static bool IsMultithreadServer()

 Returns if the application is a dedicated server and wants to be multi-threaded. Misc/App.h  

static bool IsProjectNameEmpty()

 Reports if the project name is empty Misc/App.h  

static bool IsStandalone ()

 Checks whether this is a standalone application. Misc/App.h  

static bool IsThisInstance ( const FGuid& InInstanceId
)

 Check whether the given instance ID identifies this instance. Misc/App.h  

static bool IsUnattended ()

 Checks whether this application runs unattended. Misc/App.h  

static void PrintStartupLogMessages()

 Print all initial startup logging Misc/App.h  

static void SetBenchmarking ( bool bVal
)

 Sets application benchmarking mode. Misc/App.h  

static void SetCurrentFrameTime ( FQualifiedFrameTime InFrameTime
)

 Sets the current frame time. Misc/App.h  

static void SetCurrentTime ( double Seconds
)

 Sets current time in seconds. Misc/App.h  

static void SetDeltaTime ( double Seconds
)

 Sets time delta in seconds. Misc/App.h  

static void SetFixedDeltaTime ( double Seconds
)

 Sets time step in seconds if a fixed delta time is wanted. Misc/App.h  

static void SetGameTime ( double Seconds
)

 Sets overall game time in seconds. Misc/App.h  

static void SetGraphicsRHI ( FString RHIString
)

 Sets the Graphics RHI currently in use Misc/App.h  

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

 Sets HasFocus, which is a function that indicates that the application window has focus. Misc/App.h  

static void SetHasVRFocus ( bool bInHasVRFocus
)

 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. Misc/App.h  

static void SetIdleTime ( double Seconds
)

 Sets idle time in seconds. Misc/App.h  

static void SetIdleTimeOvershoot ( double Seconds
)

 Sets idle time overshoot in seconds (the time beyond the wait time we requested for the frame). Misc/App.h  

static void SetProjectName ( const TCHAR* InProjectName
)

 Sets the name of the current project. Misc/App.h  

static void SetSessionName ( const FString& NewName
)

 Set a new session name. Misc/App.h  

static void SetSessionOwner ( const FString& NewOwner
)

 Set a new session owner. Misc/App.h  

static void SetTimecodeAndFrameRate ( FTimecode InTimecode,
FFrameRate InTimecodeFrameRate
)

 Sets the current timecode, and the frame rate to which it's relative. Misc/App.h  

static void SetUnfocusedVolumeMultiplier ( float InVolumeMultiplier
)

 Sets the Unfocused Volume Multiplier Misc/App.h  

static void SetUseFixedTimeStep ( bool bVal
)

 Enables or disabled usage of fixed time step. Misc/App.h  

static void SetUseVRFocus ( bool bInUseVRFocus
)

 Sets if VRFocus should be used. Misc/App.h  

static void SetVolumeMultiplier ( float InVolumeMultiplier
)

 Set Volume Multiplier Misc/App.h  
Checks whether the application should run multi-threaded for performance critical features. Misc/App.h  

static void UpdateLastTime()

 Updates Last time to CurrentTime. Misc/App.h  

static bool UseFixedTimeStep()

 Gets whether we want to use a fixed time step or not. Misc/App.h  

static bool UseVRFocus()

 Gets if VRFocus should be used Misc/App.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page