UGameUserSettings Class Reference

#include <GameUserSettings.h>

Inheritance diagram for UGameUserSettings:

Public Member Functions
virtual ENGINE_API void	ApplySettings (bool bCheckForCommandLineOverrides)
virtual ENGINE_API void	ApplyNonResolutionSettings ()
ENGINE_API void	ApplyResolutionSettings (bool bCheckForCommandLineOverrides)
ENGINE_API FIntPoint	GetScreenResolution () const
ENGINE_API FIntPoint	GetLastConfirmedScreenResolution () const
ENGINE_API FIntPoint	GetDesktopResolution () const
ENGINE_API void	SetScreenResolution (FIntPoint Resolution)
ENGINE_API EWindowMode::Type	GetFullscreenMode () const
ENGINE_API EWindowMode::Type	GetLastConfirmedFullscreenMode () const
ENGINE_API void	SetFullscreenMode (EWindowMode::Type InFullscreenMode)
ENGINE_API EWindowMode::Type	GetPreferredFullscreenMode () const
ENGINE_API void	SetVSyncEnabled (bool bEnable)
ENGINE_API bool	IsVSyncEnabled () const
ENGINE_API void	SetDynamicResolutionEnabled (bool bEnable)
virtual ENGINE_API bool	IsDynamicResolutionEnabled () const
ENGINE_API bool	IsScreenResolutionDirty () const
ENGINE_API bool	IsFullscreenModeDirty () const
ENGINE_API bool	IsVSyncDirty () const
ENGINE_API bool	IsDynamicResolutionDirty () const
virtual ENGINE_API void	ConfirmVideoMode ()
ENGINE_API void	RevertVideoMode ()
ENGINE_API void	SetBenchmarkFallbackValues ()
ENGINE_API void	SetAudioQualityLevel (int32 QualityLevel)
int32	GetAudioQualityLevel () const
ENGINE_API void	SetFrameRateLimit (float NewLimit)
ENGINE_API float	GetFrameRateLimit () const
virtual ENGINE_API void	SetOverallScalabilityLevel (int32 Value)
virtual ENGINE_API int32	GetOverallScalabilityLevel () const
ENGINE_API void	GetResolutionScaleInformationEx (float &CurrentScaleNormalized, float &CurrentScaleValue, float &MinScaleValue, float &MaxScaleValue) const
ENGINE_API float	GetResolutionScaleNormalized () const
ENGINE_API void	SetResolutionScaleValueEx (float NewScaleValue)
ENGINE_API void	SetResolutionScaleNormalized (float NewScaleNormalized)
ENGINE_API void	SetViewDistanceQuality (int32 Value)
ENGINE_API int32	GetViewDistanceQuality () const
ENGINE_API void	SetShadowQuality (int32 Value)
ENGINE_API int32	GetShadowQuality () const
ENGINE_API void	SetGlobalIlluminationQuality (int32 Value)
ENGINE_API int32	GetGlobalIlluminationQuality () const
ENGINE_API void	SetReflectionQuality (int32 Value)
ENGINE_API int32	GetReflectionQuality () const
ENGINE_API void	SetAntiAliasingQuality (int32 Value)
ENGINE_API int32	GetAntiAliasingQuality () const
ENGINE_API void	SetTextureQuality (int32 Value)
ENGINE_API int32	GetTextureQuality () const
ENGINE_API void	SetVisualEffectQuality (int32 Value)
ENGINE_API int32	GetVisualEffectQuality () const
ENGINE_API void	SetPostProcessingQuality (int32 Value)
ENGINE_API int32	GetPostProcessingQuality () const
ENGINE_API void	SetFoliageQuality (int32 Value)
ENGINE_API int32	GetFoliageQuality () const
ENGINE_API void	SetShadingQuality (int32 Value)
ENGINE_API int32	GetShadingQuality () const
virtual ENGINE_API bool	IsDirty () const
virtual ENGINE_API void	ValidateSettings ()
virtual ENGINE_API void	LoadSettings (bool bForceReload=false)
virtual ENGINE_API void	SaveSettings ()
virtual ENGINE_API void	ResetToCurrentSettings ()
virtual ENGINE_API void	SetWindowPosition (int32 WindowPosX, int32 WindowPosY)
virtual ENGINE_API void	SetWindowPosition (int32 WindowPosX, int32 WindowPosY, int32 SaveSlotIndex)
virtual ENGINE_API FIntPoint	GetWindowPosition ()
virtual ENGINE_API FIntPoint	GetWindowPosition (int32 SaveSlotIndex)
ENGINE_API void	ReloadWindowPositions ()
virtual ENGINE_API void	SetToDefaults ()
virtual ENGINE_API float	GetDefaultResolutionScale ()
virtual ENGINE_API float	GetRecommendedResolutionScale ()
virtual ENGINE_API void	RunHardwareBenchmark (int32 WorkScale=10, float CPUMultiplier=1.0f, float GPUMultiplier=1.0f)
virtual ENGINE_API void	ApplyHardwareBenchmarkResults ()
virtual ENGINE_API bool	SupportsHDRDisplayOutput () const
ENGINE_API void	EnableHDRDisplayOutput (bool bEnable, int32 DisplayNits=1000)
ENGINE_API int32	GetCurrentHDRDisplayNits () const
ENGINE_API bool	IsHDREnabled () const
float	GetLastCPUBenchmarkResult () const
float	GetLastGPUBenchmarkResult () const
TArray< float >	GetLastCPUBenchmarkSteps () const
TArray< float >	GetLastGPUBenchmarkSteps () const
void	RequestUIUpdate ()
int32	GetMaxNumWindowPositionSaveSlots () const
	DECLARE_DELEGATE_RetVal_OneParam (bool, FUpdateGameUserSettingsFileFromCloud, const FString &)
	DECLARE_DELEGATE_RetVal_OneParam (bool, FUpdateCloudDataFromGameUserSettings, const FString &)
Public Member Functions inherited from UObject
COREUOBJECT_API	UObject ()
COREUOBJECT_API	UObject (const FObjectInitializer &ObjectInitializer)
COREUOBJECT_API	UObject (EStaticConstructor, EObjectFlags InFlags)
COREUOBJECT_API	UObject (FVTableHelper &Helper)
COREUOBJECT_API UObject *	CreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
template<class TReturnType >
TReturnType *	CreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
template<class TReturnType >
TReturnType *	CreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
template<class TReturnType , class TClassToConstructByDefault >
TReturnType *	CreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
template<class TReturnType >
TReturnType *	CreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
template<class TReturnType , class TClassToConstructByDefault >
TReturnType *	CreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
COREUOBJECT_API void	GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
COREUOBJECT_API UObject *	GetDefaultSubobjectByName (FName ToFind)
virtual COREUOBJECT_API void	PostInitProperties ()
virtual COREUOBJECT_API void	PostReinitProperties ()
virtual void	PostCDOContruct ()
virtual COREUOBJECT_API void	PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
virtual COREUOBJECT_API void	PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
virtual COREUOBJECT_API void	PreSave (FObjectPreSaveContext SaveContext)
virtual COREUOBJECT_API void	CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
UE_FORCEINLINE_HINT bool	Modify (bool bAlwaysMarkDirty=true)
UE_FORCEINLINE_HINT bool	IsCapturingAsRootObjectForTransaction () const
virtual bool	ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
virtual bool	IsReadyForAsyncPostLoad () const
virtual COREUOBJECT_API void	PostLoad ()
virtual COREUOBJECT_API void	PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
virtual COREUOBJECT_API void	BeginDestroy ()
virtual bool	IsReadyForFinishDestroy ()
virtual COREUOBJECT_API void	FinishDestroy ()
virtual COREUOBJECT_API void	Serialize (FArchive &Ar)
virtual COREUOBJECT_API void	Serialize (FStructuredArchive::FRecord Record)
virtual void	ShutdownAfterError ()
virtual void	PostInterpChange (FProperty *PropertyThatChanged)
virtual COREUOBJECT_API void	PostRename (UObject *OldOuter, const FName OldName)
virtual void	PreDuplicate (FObjectDuplicationParameters &DupParams)
virtual void	PostDuplicate (bool bDuplicateForPIE)
virtual void	PostDuplicate (EDuplicateMode::Type DuplicateMode)
virtual COREUOBJECT_API bool	NeedsLoadForClient () const
virtual COREUOBJECT_API bool	NeedsLoadForServer () const
virtual COREUOBJECT_API bool	NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
virtual bool	NeedsLoadForEditorGame () const
virtual bool	IsEditorOnly () const
virtual bool	HasNonEditorOnlyReferences () const
virtual bool	IsPostLoadThreadSafe () const
virtual COREUOBJECT_API bool	IsDestructionThreadSafe () const
virtual COREUOBJECT_API void	GetPreloadDependencies (TArray< UObject * > &OutDeps)
virtual void	GetPrestreamPackages (TArray< UObject * > &OutPrestream)
virtual void	ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
virtual void	ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
virtual void	PostEditImport ()
virtual void	PostReloadConfig (class FProperty *PropertyThatWasLoaded)
virtual COREUOBJECT_API bool	Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
virtual FString	GetDesc ()
COREUOBJECT_API UScriptStruct *	GetSparseClassDataStruct () const
virtual bool	GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
virtual COREUOBJECT_API void	GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
SIZE_T	GetResourceSizeBytes (EResourceSizeMode::Type Mode)
virtual FName	GetExporterName (void)
COREUOBJECT_API void	CallAddReferencedObjects (FReferenceCollector &Collector)
virtual FRestoreForUObjectOverwrite *	GetRestoreForUObjectOverwrite ()
virtual bool	AreNativePropertiesIdenticalTo (UObject *Other) const
virtual COREUOBJECT_API void	GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
virtual COREUOBJECT_API void	GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
COREUOBJECT_API void	GetAssetRegistryTags (FAssetData &Out) const
COREUOBJECT_API void	GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
virtual COREUOBJECT_API bool	IsAsset () const
virtual COREUOBJECT_API FPrimaryAssetId	GetPrimaryAssetId () const
virtual COREUOBJECT_API bool	IsLocalizedResource () const
virtual COREUOBJECT_API bool	IsSafeForRootSet () const
virtual COREUOBJECT_API void	TagSubobjects (EObjectFlags NewFlags)
virtual COREUOBJECT_API void	GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
virtual COREUOBJECT_API void	GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
virtual COREUOBJECT_API void	RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
virtual COREUOBJECT_API bool	IsNameStableForNetworking () const
virtual COREUOBJECT_API bool	IsFullNameStableForNetworking () const
virtual COREUOBJECT_API bool	IsSupportedForNetworking () const
virtual void	GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
virtual COREUOBJECT_API void	PreNetReceive ()
virtual COREUOBJECT_API void	PostNetReceive ()
virtual void	PostRepNotifies ()
virtual COREUOBJECT_API void	PreDestroyFromReplication ()
COREUOBJECT_API bool	IsSelected () const
COREUOBJECT_API void	SerializeScriptProperties (FArchive &Ar) const
COREUOBJECT_API void	SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
COREUOBJECT_API void	ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
COREUOBJECT_API FString	GetDetailedInfo () const
COREUOBJECT_API bool	ConditionalBeginDestroy ()
COREUOBJECT_API bool	ConditionalFinishDestroy ()
COREUOBJECT_API void	ConditionalPostLoad ()
COREUOBJECT_API void	ConditionalPreload ()
COREUOBJECT_API void	ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
bool	IsBasedOnArchetype (const UObject *const SomeObject) const
COREUOBJECT_API UFunction *	FindFunction (FName InName) const
COREUOBJECT_API UFunction *	FindFunctionChecked (FName InName) const
virtual COREUOBJECT_API void	BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
COREUOBJECT_API void	CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
COREUOBJECT_API bool	CheckDefaultSubobjects (bool bForceCheck=false) const
COREUOBJECT_API void	SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
COREUOBJECT_API void	SaveConfig (const FSaveConfigContext &Context)
COREUOBJECT_API void	UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
COREUOBJECT_API bool	TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
COREUOBJECT_API void	UpdateGlobalUserConfigFile ()
COREUOBJECT_API void	UpdateProjectUserConfigFile ()
COREUOBJECT_API void	UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
COREUOBJECT_API FString	GetDefaultConfigFilename () const
COREUOBJECT_API FString	GetGlobalUserConfigFilename () const
COREUOBJECT_API FString	GetProjectUserConfigFilename () const
virtual const TCHAR *	GetConfigOverridePlatform () const
virtual void	OverrideConfigSection (FString &SectionName)
virtual void	OverridePerObjectConfigSection (FString &SectionName)
COREUOBJECT_API void	LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
COREUOBJECT_API void	ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
COREUOBJECT_API void	ParseParms (const TCHAR *Parms)
COREUOBJECT_API void	OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
COREUOBJECT_API void	RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
COREUOBJECT_API void	SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
COREUOBJECT_API UObject *	GetArchetype () const
COREUOBJECT_API void	GetArchetypeInstances (TArray< UObject * > &Instances)
COREUOBJECT_API void	InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
template<class T >
bool	Implements () const
virtual COREUOBJECT_API void	ProcessEvent (UFunction *Function, void *Parms)
virtual int32	GetFunctionCallspace (UFunction *Function, FFrame *Stack)
virtual bool	CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
COREUOBJECT_API bool	CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
COREUOBJECT_API void	CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
	DECLARE_FUNCTION (ProcessInternal)
virtual bool	ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
COREUOBJECT_API void	SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
virtual UClass *	RegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
COREUOBJECT_API bool	IsInBlueprint () const
COREUOBJECT_API void	DestroyNonNativeProperties ()
virtual void	MarkAsEditorOnlySubobject ()
COREUOBJECT_API void	AbortInsideMemberFunction () const
	DECLARE_FUNCTION (execUndefined)
	DECLARE_FUNCTION (execLocalVariable)
	DECLARE_FUNCTION (execInstanceVariable)
	DECLARE_FUNCTION (execDefaultVariable)
	DECLARE_FUNCTION (execLocalOutVariable)
	DECLARE_FUNCTION (execInterfaceVariable)
	DECLARE_FUNCTION (execClassSparseDataVariable)
	DECLARE_FUNCTION (execInterfaceContext)
	DECLARE_FUNCTION (execArrayElement)
	DECLARE_FUNCTION (execBoolVariable)
	DECLARE_FUNCTION (execClassDefaultVariable)
	DECLARE_FUNCTION (execEndFunctionParms)
	DECLARE_FUNCTION (execNothing)
	DECLARE_FUNCTION (execNothingInt32)
	DECLARE_FUNCTION (execNothingOp4a)
	DECLARE_FUNCTION (execBreakpoint)
	DECLARE_FUNCTION (execTracepoint)
	DECLARE_FUNCTION (execWireTracepoint)
	DECLARE_FUNCTION (execInstrumentation)
	DECLARE_FUNCTION (execEndOfScript)
	DECLARE_FUNCTION (execReturnNothing)
	DECLARE_FUNCTION (execEmptyParmValue)
	DECLARE_FUNCTION (execJump)
	DECLARE_FUNCTION (execJumpIfNot)
	DECLARE_FUNCTION (execAssert)
	DECLARE_FUNCTION (execPushExecutionFlow)
	DECLARE_FUNCTION (execPopExecutionFlow)
	DECLARE_FUNCTION (execComputedJump)
	DECLARE_FUNCTION (execPopExecutionFlowIfNot)
	DECLARE_FUNCTION (execLet)
	DECLARE_FUNCTION (execLetObj)
	DECLARE_FUNCTION (execLetWeakObjPtr)
	DECLARE_FUNCTION (execLetBool)
	DECLARE_FUNCTION (execLetDelegate)
	DECLARE_FUNCTION (execLetMulticastDelegate)
	DECLARE_FUNCTION (execAddMulticastDelegate)
	DECLARE_FUNCTION (execClearMulticastDelegate)
	DECLARE_FUNCTION (execEatReturnValue)
	DECLARE_FUNCTION (execRemoveMulticastDelegate)
	DECLARE_FUNCTION (execSelf)
	DECLARE_FUNCTION (execContext)
	DECLARE_FUNCTION (execContext_FailSilent)
	DECLARE_FUNCTION (execStructMemberContext)
	DECLARE_FUNCTION (execVirtualFunction)
	DECLARE_FUNCTION (execFinalFunction)
	DECLARE_FUNCTION (execLocalVirtualFunction)
	DECLARE_FUNCTION (execLocalFinalFunction)
	DECLARE_FUNCTION (execStructCmpEq)
	DECLARE_FUNCTION (execStructCmpNe)
	DECLARE_FUNCTION (execStructMember)
	DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
	DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
	DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
	DECLARE_FUNCTION (execNotEqual_DelegateFunction)
	DECLARE_FUNCTION (execIntConst)
	DECLARE_FUNCTION (execInt64Const)
	DECLARE_FUNCTION (execUInt64Const)
	DECLARE_FUNCTION (execSkipOffsetConst)
	DECLARE_FUNCTION (execFloatConst)
	DECLARE_FUNCTION (execDoubleConst)
	DECLARE_FUNCTION (execStringConst)
	DECLARE_FUNCTION (execUnicodeStringConst)
	DECLARE_FUNCTION (execTextConst)
	DECLARE_FUNCTION (execPropertyConst)
	DECLARE_FUNCTION (execObjectConst)
	DECLARE_FUNCTION (execSoftObjectConst)
	DECLARE_FUNCTION (execFieldPathConst)
	DECLARE_FUNCTION (execInstanceDelegate)
	DECLARE_FUNCTION (execNameConst)
	DECLARE_FUNCTION (execByteConst)
	DECLARE_FUNCTION (execIntZero)
	DECLARE_FUNCTION (execIntOne)
	DECLARE_FUNCTION (execTrue)
	DECLARE_FUNCTION (execFalse)
	DECLARE_FUNCTION (execNoObject)
	DECLARE_FUNCTION (execNullInterface)
	DECLARE_FUNCTION (execIntConstByte)
	DECLARE_FUNCTION (execRotationConst)
	DECLARE_FUNCTION (execVectorConst)
	DECLARE_FUNCTION (execVector3fConst)
	DECLARE_FUNCTION (execTransformConst)
	DECLARE_FUNCTION (execStructConst)
	DECLARE_FUNCTION (execSetArray)
	DECLARE_FUNCTION (execSetSet)
	DECLARE_FUNCTION (execSetMap)
	DECLARE_FUNCTION (execArrayConst)
	DECLARE_FUNCTION (execSetConst)
	DECLARE_FUNCTION (execMapConst)
	DECLARE_FUNCTION (execBitFieldConst)
	DECLARE_FUNCTION (execNew)
	DECLARE_FUNCTION (execClassContext)
	DECLARE_FUNCTION (execNativeParm)
	DECLARE_FUNCTION (execCast)
	DECLARE_FUNCTION (execDynamicCast)
	DECLARE_FUNCTION (execMetaCast)
	DECLARE_FUNCTION (execInterfaceCast)
	DECLARE_FUNCTION (execDoubleToFloatCast)
	DECLARE_FUNCTION (execFloatToDoubleCast)
	DECLARE_FUNCTION (execObjectToBool)
	DECLARE_FUNCTION (execInterfaceToBool)
	DECLARE_FUNCTION (execObjectToInterface)
	DECLARE_FUNCTION (execInterfaceToInterface)
	DECLARE_FUNCTION (execInterfaceToObject)
	DECLARE_FUNCTION (execGetDynArrayElement)
	DECLARE_FUNCTION (execSetDynArrayElement)
	DECLARE_FUNCTION (execGetDynArrayLength)
	DECLARE_FUNCTION (execSetDynArrayLength)
	DECLARE_FUNCTION (execDynArrayInsert)
	DECLARE_FUNCTION (execDynArrayRemove)
	DECLARE_FUNCTION (execDynArrayFind)
	DECLARE_FUNCTION (execDynArrayFindStruct)
	DECLARE_FUNCTION (execDynArrayAdd)
	DECLARE_FUNCTION (execDynArrayAddItem)
	DECLARE_FUNCTION (execDynArrayInsertItem)
	DECLARE_FUNCTION (execDynArrayRemoveItem)
	DECLARE_FUNCTION (execDynArraySort)
	DECLARE_FUNCTION (execBindDelegate)
	DECLARE_FUNCTION (execCallMulticastDelegate)
	DECLARE_FUNCTION (execLetValueOnPersistentFrame)
	DECLARE_FUNCTION (execCallMathFunction)
	DECLARE_FUNCTION (execSwitchValue)
	DECLARE_FUNCTION (execArrayGetByRef)
	DECLARE_FUNCTION (execAutoRtfmTransact)
	DECLARE_FUNCTION (execAutoRtfmStopTransact)
	DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
void	ExecuteUbergraph (int32 EntryPoint)
virtual void	ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
virtual uint64	GetNetPushIdDynamic () const
Public Member Functions inherited from UObjectBaseUtility
	UObjectBaseUtility ()
	UObjectBaseUtility (EObjectFlags InFlags)
void	SetFlags (EObjectFlags NewFlags)
void	ClearFlags (EObjectFlags FlagsToClear)
bool	HasAnyFlags (EObjectFlags FlagsToCheck) const
bool	HasAllFlags (EObjectFlags FlagsToCheck) const
UE_FORCEINLINE_HINT EObjectFlags	GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
UE_FORCEINLINE_HINT void	Mark (EObjectMark Marks) const
UE_FORCEINLINE_HINT void	UnMark (EObjectMark Marks) const
UE_FORCEINLINE_HINT bool	HasAnyMarks (EObjectMark Marks) const
UE_FORCEINLINE_HINT bool	HasAllMarks (EObjectMark Marks) const
UE_FORCEINLINE_HINT EObjectMark	GetAllMarks () const
void	MarkAsGarbage ()
void	ClearGarbage ()
UE_FORCEINLINE_HINT void	AddToRoot ()
UE_FORCEINLINE_HINT void	RemoveFromRoot ()
UE_FORCEINLINE_HINT bool	IsRooted () const
UE_FORCEINLINE_HINT int32	GetRefCount () const
bool	ThisThreadAtomicallyClearedRFUnreachable ()
UE_FORCEINLINE_HINT bool	IsUnreachable () const
UE_FORCEINLINE_HINT bool	IsNative () const
void	SetInternalFlags (EInternalObjectFlags FlagsToSet) const
UE_FORCEINLINE_HINT EInternalObjectFlags	GetInternalFlags () const
UE_FORCEINLINE_HINT bool	HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
void	ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
bool	AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
COREUOBJECT_API FString	GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
COREUOBJECT_API void	GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
COREUOBJECT_API void	GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
COREUOBJECT_API FString	GetPathName (const UObject *StopOuter=NULL) const
COREUOBJECT_API void	GetPathName (const UObject *StopOuter, FString &ResultString) const
COREUOBJECT_API void	GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
virtual bool	CanBeClusterRoot () const
virtual COREUOBJECT_API bool	CanBeInCluster () const
virtual COREUOBJECT_API void	CreateCluster ()
virtual void	OnClusterMarkedAsPendingKill ()
COREUOBJECT_API void	AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
COREUOBJECT_API FString	GetFullGroupName (bool bStartWithOuter) const
UE_FORCEINLINE_HINT FString	GetName () const
UE_FORCEINLINE_HINT void	GetName (FString &ResultString) const
UE_FORCEINLINE_HINT void	AppendName (FString &ResultString) const
COREUOBJECT_API bool	IsPackageExternal () const
COREUOBJECT_API void	DetachExternalPackage ()
COREUOBJECT_API void	ReattachExternalPackage ()
COREUOBJECT_API UObject *	GetOutermostObject () const
COREUOBJECT_API UPackage *	GetPackage () const
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath	GetVersePath () const
COREUOBJECT_API UPackage *	GetOutermost () const
COREUOBJECT_API bool	MarkPackageDirty () const
COREUOBJECT_API bool	IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
COREUOBJECT_API UObject *	GetTypedOuter (UClass *Target) const
template<typename T >
T *	GetTypedOuter () const
template<typename InterfaceClassType >
InterfaceClassType *	GetImplementingOuter () const
COREUOBJECT_API UObjectBaseUtility *	GetImplementingOuterObject (const UClass *InInterfaceClass) const
COREUOBJECT_API bool	IsIn (const UObject *SomeOuter) const
COREUOBJECT_API bool	IsIn (const UPackage *SomePackage) const
COREUOBJECT_API bool	IsInOuter (const UObject *SomeOuter) const
COREUOBJECT_API bool	IsInPackage (const UPackage *SomePackage) const
COREUOBJECT_API bool	IsInA (const UClass *SomeBaseClass) const
COREUOBJECT_API bool	RootPackageHasAnyFlags (uint32 CheckFlagMask) const
template<typename OtherClassType >
bool	IsA (OtherClassType SomeBase) const
template<class T >
bool	IsA () const
COREUOBJECT_API const UClass *	FindNearestCommonBaseClass (const UClass *TestClass) const
COREUOBJECT_API void *	GetInterfaceAddress (UClass *InterfaceClass)
COREUOBJECT_API void *	GetNativeInterfaceAddress (UClass *InterfaceClass)
const void *	GetNativeInterfaceAddress (UClass *InterfaceClass) const
COREUOBJECT_API bool	IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
COREUOBJECT_API bool	IsDefaultSubobject () const
COREUOBJECT_API class FLinkerLoad *	GetLinker () const
COREUOBJECT_API int32	GetLinkerIndex () const
COREUOBJECT_API FPackageFileVersion	GetLinkerUEVersion () const
int32	GetLinkerUE4Version () const
COREUOBJECT_API int32	GetLinkerLicenseeUEVersion () const
int32	GetLinkerLicenseeUE4Version () const
COREUOBJECT_API int32	GetLinkerCustomVersion (FGuid CustomVersionKey) const
UE_FORCEINLINE_HINT bool	operator< (const UObjectBaseUtility &Other) const
TStatId	GetStatID (bool bForDeferredUse=false) const
Public Member Functions inherited from UObjectBase
COREUOBJECT_API	UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
virtual COREUOBJECT_API	~UObjectBase ()
COREUOBJECT_API bool	IsValidLowLevel () const
COREUOBJECT_API bool	IsValidLowLevelFast (bool bRecursive=true) const
FORCEINLINE uint32	GetUniqueID () const
FORCEINLINE UClass *	GetClass () const
FORCEINLINE UObject *	GetOuter () const
FORCEINLINE FName	GetFName () const
virtual COREUOBJECT_API FName	GetFNameForStatID () const
COREUOBJECT_API UPackage *	GetExternalPackage () const
COREUOBJECT_API void	SetExternalPackage (UPackage *InPackage)
COREUOBJECT_API UPackage *	GetExternalPackageInternal () const
COREUOBJECT_API void	MarkAsReachable () const
COREUOBJECT_API void	AddRef () const
COREUOBJECT_API void	ReleaseRef () const
FORCEINLINE EObjectFlags	GetFlags () const
FORCENOINLINE void	AtomicallySetFlags (EObjectFlags FlagsToAdd)
FORCENOINLINE void	AtomicallyClearFlags (EObjectFlags FlagsToClear)

Static Public Member Functions
static ENGINE_API FString	GetConfigDir ()
static ENGINE_API void	PreloadResolutionSettings (bool bAllowCmdLineOverrides=true)
static ENGINE_API FIntPoint	GetDefaultResolution ()
static ENGINE_API FIntPoint	GetDefaultWindowPosition ()
static ENGINE_API EWindowMode::Type	GetDefaultWindowMode ()
static ENGINE_API int32	GetSyncInterval ()
static ENGINE_API int32	GetFramePace ()
static ENGINE_API void	LoadConfigIni (bool bForceReload=false)
static ENGINE_API void	RequestResolutionChange (int32 InResolutionX, int32 InResolutionY, EWindowMode::Type InWindowMode, bool bInDoOverrides=true)
static ENGINE_API UGameUserSettings *	GetGameUserSettings ()
Static Public Member Functions inherited from UObject
static COREUOBJECT_API void	UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
static COREUOBJECT_API void	UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
static COREUOBJECT_API bool	CanCreateInCurrentContext (UObject *Template)
static COREUOBJECT_API void	AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
static COREUOBJECT_API const FName &	SourceFileTagName ()
static COREUOBJECT_API UObject *	GetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
Static Public Member Functions inherited from UObjectBaseUtility
static bool	IsGarbageEliminationEnabled ()
static bool	IsPendingKillEnabled ()
static void	SetGarbageEliminationEnabled (bool bEnabled)
static COREUOBJECT_API void	ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString	RemoveClassPrefix (const TCHAR *ClassName)
static void	PrefetchClass (UObject *Object)
static void	PrefetchOuter (UObject *Object)

Public Attributes
bool	bUseVSync
bool	bUseDynamicResolution
Scalability::FQualityLevels	ScalabilityQuality
FUpdateGameUserSettingsFileFromCloud	OnUpdateGameUserSettingsFileFromCloud
FUpdateCloudDataFromGameUserSettings	OnUpdateCloudDataFromGameUserSettings

Protected Member Functions
virtual ENGINE_API bool	IsVersionValid ()
virtual ENGINE_API void	UpdateVersion ()
ENGINE_API float	FindResolutionQualityForScreenSize (float Width, float Height)
virtual ENGINE_API float	GetEffectiveFrameRateLimit ()
ENGINE_API void	UpdateResolutionQuality ()
ENGINE_API void	EnableHDRDisplayOutputInternal (bool bEnable, int32 DisplayNits, bool bFromUserSettings)
Protected Member Functions inherited from UObject
virtual FString	GetDetailedInfoInternal () const
COREUOBJECT_API bool	CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
virtual COREUOBJECT_API bool	CheckDefaultSubobjectsInternal () const
Protected Member Functions inherited from UObjectBase
	UObjectBase ()
COREUOBJECT_API	UObjectBase (EObjectFlags InFlags)
COREUOBJECT_API void	LowLevelRename (FName NewName, UObject *NewOuter=NULL)
virtual void	RegisterDependencies ()
COREUOBJECT_API void	Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
COREUOBJECT_API void	Register (const TCHAR *PackageName, const TCHAR *Name)
virtual COREUOBJECT_API void	DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
FORCEINLINE void	SetFlagsTo (EObjectFlags NewFlags)

Static Protected Member Functions
static ENGINE_API void	SetFrameRateLimitCVar (float InLimit)
static ENGINE_API void	SetSyncTypeCVar (int32 InInterval)

Protected Attributes
uint32	ResolutionSizeX
uint32	ResolutionSizeY
uint32	LastUserConfirmedResolutionSizeX
uint32	LastUserConfirmedResolutionSizeY
int32	WindowPosX_DEPRECATED
int32	WindowPosY_DEPRECATED
TArray< FIntPoint >	WindowPositions
int32	FullscreenMode
int32	LastConfirmedFullscreenMode
int32	PreferredFullscreenMode
uint32	Version
int32	AudioQualityLevel
int32	LastConfirmedAudioQualityLevel
float	FrameRateLimit
float	MinResolutionScale
int32	DesiredScreenWidth
bool	bUseDesiredScreenHeight
int32	DesiredScreenHeight
int32	LastUserConfirmedDesiredScreenWidth
int32	LastUserConfirmedDesiredScreenHeight
float	LastRecommendedScreenWidth
float	LastRecommendedScreenHeight
float	LastCPUBenchmarkResult
float	LastGPUBenchmarkResult
TArray< float >	LastCPUBenchmarkSteps
TArray< float >	LastGPUBenchmarkSteps
float	LastGPUBenchmarkMultiplier
bool	bUseHDRDisplayOutput
int32	HDRDisplayOutputNits
bool	bEnableScalabilitySettings = true

Additional Inherited Members
Public Types inherited from UObject
enum class	ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
typedef UObject	WithinClass

Detailed Description

Stores user settings for a game (for example graphics and sound settings), with the ability to save and load to and from a file.

Member Function Documentation

ApplyHardwareBenchmarkResults()

void UGameUserSettings::ApplyHardwareBenchmarkResults ( )

virtual

Applies the settings stored in ScalabilityQuality and saves settings

ApplyNonResolutionSettings()

void UGameUserSettings::ApplyNonResolutionSettings ( )

virtual

ApplyResolutionSettings()

void UGameUserSettings::ApplyResolutionSettings

(

bool

bCheckForCommandLineOverrides

)

ApplySettings()

void UGameUserSettings::ApplySettings ( bool  bCheckForCommandLineOverrides )

virtual

Applies all current user settings to the game and saves to permanent storage (e.g. file), optionally checking for command line overrides.

ConfirmVideoMode()

void UGameUserSettings::ConfirmVideoMode ( )

virtual

Mark current video mode settings (fullscreenmode/resolution) as being confirmed by the user

DECLARE_DELEGATE_RetVal_OneParam() [1/2]

UGameUserSettings::DECLARE_DELEGATE_RetVal_OneParam	(	bool	,
		FUpdateCloudDataFromGameUserSettings	,
		const FString &
	)

We call this to notify any listening Cloud subsystem that we have updated the config file.

DECLARE_DELEGATE_RetVal_OneParam() [2/2]

UGameUserSettings::DECLARE_DELEGATE_RetVal_OneParam	(	bool	,
		FUpdateGameUserSettingsFileFromCloud	,
		const FString &
	)

We call this to refresh the config file from a listening Cloud subsystem, before we open it.

EnableHDRDisplayOutput()

void UGameUserSettings::EnableHDRDisplayOutput	(	bool	bEnable,
		int32	DisplayNits = 1000
	)

Enables or disables HDR display output. Can be called again to change the desired nit level

EnableHDRDisplayOutputInternal()

void UGameUserSettings::EnableHDRDisplayOutputInternal ( bool  bEnable, int32  DisplayNits, bool  bFromUserSettings  )

protected

FindResolutionQualityForScreenSize()

float UGameUserSettings::FindResolutionQualityForScreenSize ( float  Width, float  Height  )

protected

Picks the best resolution quality for a given screen size

GetAntiAliasingQuality()

int32 UGameUserSettings::GetAntiAliasingQuality

(

)

const

GetAudioQualityLevel()

int32 UGameUserSettings::GetAudioQualityLevel ( ) const

inline

Returns the user's audio quality level setting

GetConfigDir()

static ENGINE_API FString UGameUserSettings::GetConfigDir ( )

static

Returns

the location where GGameUserSettingsIni will be found

GetCurrentHDRDisplayNits()

int32 UGameUserSettings::GetCurrentHDRDisplayNits

(

)

const

Returns 0 if HDR isn't supported or is turned off

GetDefaultResolution()

FIntPoint UGameUserSettings::GetDefaultResolution ( )

static

Returns the default resolution when no resolution is set

GetDefaultResolutionScale()

float UGameUserSettings::GetDefaultResolutionScale ( )

virtual

Gets the desired resolution quality based on DesiredScreenWidth/Height and the current screen resolution

GetDefaultWindowMode()

EWindowMode::Type UGameUserSettings::GetDefaultWindowMode ( )

static

Returns the default window mode when no mode is set

GetDefaultWindowPosition()

FIntPoint UGameUserSettings::GetDefaultWindowPosition ( )

static

Returns the default window position when no position is set

GetDesktopResolution()

FIntPoint UGameUserSettings::GetDesktopResolution

(

)

const

Returns user's desktop resolution, in pixels.

GetEffectiveFrameRateLimit()

float UGameUserSettings::GetEffectiveFrameRateLimit ( )

protectedvirtual

Returns the effective frame rate limit (by default it returns the FrameRateLimit member)

GetFoliageQuality()

int32 UGameUserSettings::GetFoliageQuality

(

)

const

GetFramePace()

int32 UGameUserSettings::GetFramePace ( )

static

Gets the current frame pacing frame rate in fps, or 0 if none

GetFrameRateLimit()

float UGameUserSettings::GetFrameRateLimit

(

)

const

Gets the user's frame rate limit (0 indiciates the frame rate limit is disabled)

GetFullscreenMode()

EWindowMode::Type UGameUserSettings::GetFullscreenMode

(

)

const

Returns the user setting for game window fullscreen mode.

GetGameUserSettings()

UGameUserSettings * UGameUserSettings::GetGameUserSettings ( )

static

Returns the game local machine settings (resolution, windowing mode, scalability settings, etc...)

GetGlobalIlluminationQuality()

int32 UGameUserSettings::GetGlobalIlluminationQuality

(

)

const

GetLastConfirmedFullscreenMode()

EWindowMode::Type UGameUserSettings::GetLastConfirmedFullscreenMode

(

)

const

Returns the last confirmed user setting for game window fullscreen mode.

GetLastConfirmedScreenResolution()

FIntPoint UGameUserSettings::GetLastConfirmedScreenResolution

(

)

const

Returns the last confirmed user setting for game screen resolution, in pixels.

GetLastCPUBenchmarkResult()

float UGameUserSettings::GetLastCPUBenchmarkResult ( ) const

inline

Returns the last CPU benchmark result (set by RunHardwareBenchmark)

GetLastCPUBenchmarkSteps()

TArray< float > UGameUserSettings::GetLastCPUBenchmarkSteps ( ) const

inline

Returns each individual step of the last CPU benchmark result (set by RunHardwareBenchmark)

GetLastGPUBenchmarkResult()

float UGameUserSettings::GetLastGPUBenchmarkResult ( ) const

inline

Returns the last GPU benchmark result (set by RunHardwareBenchmark)

GetLastGPUBenchmarkSteps()

TArray< float > UGameUserSettings::GetLastGPUBenchmarkSteps ( ) const

inline

Returns each individual step of the last GPU benchmark result (set by RunHardwareBenchmark)

GetMaxNumWindowPositionSaveSlots()

int32 UGameUserSettings::GetMaxNumWindowPositionSaveSlots

(

)

const

Returns the maximum supported number save slots for window positions.

GetOverallScalabilityLevel()

int32 UGameUserSettings::GetOverallScalabilityLevel ( ) const

virtual

GetPostProcessingQuality()

int32 UGameUserSettings::GetPostProcessingQuality

(

)

const

GetPreferredFullscreenMode()

EWindowMode::Type UGameUserSettings::GetPreferredFullscreenMode

(

)

const

Returns the user setting for game window fullscreen mode.

GetRecommendedResolutionScale()

float UGameUserSettings::GetRecommendedResolutionScale ( )

virtual

Gets the recommended resolution quality based on LastRecommendedScreenWidth/Height and the current screen resolution

GetReflectionQuality()

int32 UGameUserSettings::GetReflectionQuality

(

)

const

GetResolutionScaleInformationEx()

void UGameUserSettings::GetResolutionScaleInformationEx	(	float &	CurrentScaleNormalized,
		float &	CurrentScaleValue,
		float &	MinScaleValue,
		float &	MaxScaleValue
	)		const

GetResolutionScaleNormalized()

float UGameUserSettings::GetResolutionScaleNormalized

(

)

const

GetScreenResolution()

FIntPoint UGameUserSettings::GetScreenResolution

(

)

const

Returns the user setting for game screen resolution, in pixels.

GetShadingQuality()

int32 UGameUserSettings::GetShadingQuality

(

)

const

GetShadowQuality()

int32 UGameUserSettings::GetShadowQuality

(

)

const

GetSyncInterval()

int32 UGameUserSettings::GetSyncInterval ( )

static

Gets the current vsync interval setting

GetTextureQuality()

int32 UGameUserSettings::GetTextureQuality

(

)

const

GetViewDistanceQuality()

int32 UGameUserSettings::GetViewDistanceQuality

(

)

const

GetVisualEffectQuality()

int32 UGameUserSettings::GetVisualEffectQuality

(

)

const

GetWindowPosition() [1/2]

FIntPoint UGameUserSettings::GetWindowPosition ( )

virtual

Returns the window position in save slot index 0.

GetWindowPosition() [2/2]

FIntPoint UGameUserSettings::GetWindowPosition ( int32  SaveSlotIndex )

virtual

Returns the window position in the given index, or the default if the index is invalid.

IsDirty()

bool UGameUserSettings::IsDirty ( ) const

virtual

Checks if any user settings is different from current

IsDynamicResolutionDirty()

bool UGameUserSettings::IsDynamicResolutionDirty

(

)

const

Checks if the dynamic resolution user setting is different from current system setting

IsDynamicResolutionEnabled()

bool UGameUserSettings::IsDynamicResolutionEnabled ( ) const

virtual

Returns the user setting for dynamic resolution.

IsFullscreenModeDirty()

bool UGameUserSettings::IsFullscreenModeDirty

(

)

const

Checks if the FullscreenMode user setting is different from current

IsHDREnabled()

bool UGameUserSettings::IsHDREnabled

(

)

const

IsScreenResolutionDirty()

bool UGameUserSettings::IsScreenResolutionDirty

(

)

const

Checks if the Screen Resolution user setting is different from current

IsVersionValid()

bool UGameUserSettings::IsVersionValid ( )

protectedvirtual

Check if the current version of the game user settings is valid. Sub-classes can override this to provide game-specific versioning as necessary.

Returns

True if the current version is valid, false if it is not

IsVSyncDirty()

bool UGameUserSettings::IsVSyncDirty

(

)

const

Checks if the vsync user setting is different from current system setting

IsVSyncEnabled()

bool UGameUserSettings::IsVSyncEnabled

(

)

const

Returns the user setting for vsync.

LoadConfigIni()

void UGameUserSettings::LoadConfigIni ( bool  bForceReload = false )

static

Loads the user .ini settings into GConfig

LoadSettings()

void UGameUserSettings::LoadSettings ( bool  bForceReload = false )

virtual

Loads the user settings from persistent storage

PreloadResolutionSettings()

void UGameUserSettings::PreloadResolutionSettings ( bool  bAllowCmdLineOverrides = true )

static

Loads the resolution settings before is object is available

ReloadWindowPositions()

void UGameUserSettings::ReloadWindowPositions

(

)

Reloads the WindowPositions array from config files. Use before SaveConfig to avoid clobbering other processes' window positions.

RequestResolutionChange()

void UGameUserSettings::RequestResolutionChange ( int32  InResolutionX, int32  InResolutionY, EWindowMode::Type  InWindowMode, bool  bInDoOverrides = true  )

static

Request a change to the specified resolution and window mode. Optionally apply cmd line overrides.

RequestUIUpdate()

void UGameUserSettings::RequestUIUpdate ( )

inline

ResetToCurrentSettings()

void UGameUserSettings::ResetToCurrentSettings ( )

virtual

This function resets all settings to the current system settings

RevertVideoMode()

void UGameUserSettings::RevertVideoMode

(

)

Revert video mode (fullscreenmode/resolution) back to the last user confirmed values

RunHardwareBenchmark()

void UGameUserSettings::RunHardwareBenchmark ( int32  WorkScale = 10, float  CPUMultiplier = 1.0f, float  GPUMultiplier = 1.0f  )

virtual

Runs the hardware benchmark and populates ScalabilityQuality as well as the last benchmark results config members, but does not apply the settings it determines. Designed to be called in conjunction with ApplyHardwareBenchmarkResults

SaveSettings()

void UGameUserSettings::SaveSettings ( )

virtual

Save the user settings to persistent storage (automatically happens as part of ApplySettings)

SetAntiAliasingQuality()

void UGameUserSettings::SetAntiAliasingQuality

(

int32

Value

)

SetAudioQualityLevel()

void UGameUserSettings::SetAudioQualityLevel

(

int32

QualityLevel

)

Sets the user's audio quality level setting

SetBenchmarkFallbackValues()

void UGameUserSettings::SetBenchmarkFallbackValues

(

)

Set scalability settings to sensible fallback values, for use when the benchmark fails or potentially causes a crash

SetDynamicResolutionEnabled()

void UGameUserSettings::SetDynamicResolutionEnabled

(

bool

bEnable

)

Sets the user setting for dynamic resolution. See UGameUserSettings::bUseDynamicResolution.

SetFoliageQuality()

void UGameUserSettings::SetFoliageQuality

(

int32

Value

)

SetFrameRateLimit()

void UGameUserSettings::SetFrameRateLimit

(

float

NewLimit

)

Sets the user's frame rate limit (0 will disable frame rate limiting)

SetFrameRateLimitCVar()

void UGameUserSettings::SetFrameRateLimitCVar ( float  InLimit )

staticprotected

Sets the frame rate limit CVar to the passed in value, 0.0 indicates no limit

SetFullscreenMode()

void UGameUserSettings::SetFullscreenMode

(

EWindowMode::Type

InFullscreenMode

)

Sets the user setting for the game window fullscreen mode. See UGameUserSettings::FullscreenMode.

SetGlobalIlluminationQuality()

void UGameUserSettings::SetGlobalIlluminationQuality

(

int32

Value

)

SetOverallScalabilityLevel()

void UGameUserSettings::SetOverallScalabilityLevel ( int32  Value )

virtual

SetPostProcessingQuality()

void UGameUserSettings::SetPostProcessingQuality

(

int32

Value

)

SetReflectionQuality()

void UGameUserSettings::SetReflectionQuality

(

int32

Value

)

SetResolutionScaleNormalized()

void UGameUserSettings::SetResolutionScaleNormalized

(

float

NewScaleNormalized

)

SetResolutionScaleValueEx()

void UGameUserSettings::SetResolutionScaleValueEx

(

float

NewScaleValue

)

SetScreenResolution()

void UGameUserSettings::SetScreenResolution

(

FIntPoint

Resolution

)

Sets the user setting for game screen resolution, in pixels.

SetShadingQuality()

void UGameUserSettings::SetShadingQuality

(

int32

Value

)

SetShadowQuality()

void UGameUserSettings::SetShadowQuality

(

int32

Value

)

SetSyncTypeCVar()

void UGameUserSettings::SetSyncTypeCVar ( int32  InInterval )

staticprotected

Sets the input latency mode 0 and 2

SetTextureQuality()

void UGameUserSettings::SetTextureQuality

(

int32

Value

)

SetToDefaults()

void UGameUserSettings::SetToDefaults ( )

virtual

SetViewDistanceQuality()

void UGameUserSettings::SetViewDistanceQuality

(

int32

Value

)

SetVisualEffectQuality()

void UGameUserSettings::SetVisualEffectQuality

(

int32

Value

)

SetVSyncEnabled()

void UGameUserSettings::SetVSyncEnabled

(

bool

bEnable

)

Sets the user setting for vsync. See UGameUserSettings::bUseVSync.

SetWindowPosition() [1/2]

void UGameUserSettings::SetWindowPosition ( int32  WindowPosX, int32  WindowPosY  )

virtual

Sets the window position in save slot index 0.

SetWindowPosition() [2/2]

void UGameUserSettings::SetWindowPosition ( int32  WindowPosX, int32  WindowPosY, int32  SaveSlotIndex  )

virtual

Sets the window position in the given index, which must be less than GetMaxNumWindowPositionSaveSlots().

SupportsHDRDisplayOutput()

bool UGameUserSettings::SupportsHDRDisplayOutput ( ) const

virtual

Whether the curently running system supports HDR display output

UpdateResolutionQuality()

void UGameUserSettings::UpdateResolutionQuality ( )

protected

UpdateVersion()

void UGameUserSettings::UpdateVersion ( )

protectedvirtual

Update the version of the game user settings to the current version

ValidateSettings()

void UGameUserSettings::ValidateSettings ( )

virtual

Validates and resets bad user settings to default. Deletes stale user settings file if necessary.

Member Data Documentation

AudioQualityLevel

int32 UGameUserSettings::AudioQualityLevel

protected

bEnableScalabilitySettings

bool UGameUserSettings::bEnableScalabilitySettings = true

protected

When set to false, scalability settings (ScalabilityQuality) are not considered user settings i.e. they are not saved and applied.

bUseDesiredScreenHeight

bool UGameUserSettings::bUseDesiredScreenHeight

protected

If true, the desired screen height will be used to scale the render resolution automatically.

bUseDynamicResolution

bool UGameUserSettings::bUseDynamicResolution

Whether to use dynamic resolution or not. (public to allow UI to connect to it)

bUseHDRDisplayOutput

bool UGameUserSettings::bUseHDRDisplayOutput

protected

HDR

bUseVSync

bool UGameUserSettings::bUseVSync

Whether to use VSync or not. (public to allow UI to connect to it)

DesiredScreenHeight

int32 UGameUserSettings::DesiredScreenHeight

protected

Desired screen height used to calculate the resolution scale when user changes display mode

DesiredScreenWidth

int32 UGameUserSettings::DesiredScreenWidth

protected

Desired screen width used to calculate the resolution scale when user changes display mode

FrameRateLimit

float UGameUserSettings::FrameRateLimit

protected

Frame rate cap

FullscreenMode

int32 UGameUserSettings::FullscreenMode

protected

Game window fullscreen mode 0 = Fullscreen 1 = Windowed fullscreen 2 = Windowed

HDRDisplayOutputNits

int32 UGameUserSettings::HDRDisplayOutputNits

protected

HDR

LastConfirmedAudioQualityLevel

int32 UGameUserSettings::LastConfirmedAudioQualityLevel

protected

LastConfirmedFullscreenMode

int32 UGameUserSettings::LastConfirmedFullscreenMode

protected

Last user confirmed fullscreen mode setting.

LastCPUBenchmarkResult

float UGameUserSettings::LastCPUBenchmarkResult

protected

Result of the last benchmark (CPU); -1 if there has not been a benchmark run

LastCPUBenchmarkSteps

TArray<float> UGameUserSettings::LastCPUBenchmarkSteps

protected

Result of each individual sub-section of the last CPU benchmark; empty if there has not been a benchmark run

LastGPUBenchmarkMultiplier

float UGameUserSettings::LastGPUBenchmarkMultiplier

protected

Multiplier used against the last GPU benchmark

LastGPUBenchmarkResult

float UGameUserSettings::LastGPUBenchmarkResult

protected

Result of the last benchmark (GPU); -1 if there has not been a benchmark run

LastGPUBenchmarkSteps

TArray<float> UGameUserSettings::LastGPUBenchmarkSteps

protected

Result of each individual sub-section of the last GPU benchmark; empty if there has not been a benchmark run

LastRecommendedScreenHeight

float UGameUserSettings::LastRecommendedScreenHeight

protected

Result of the last benchmark; calculated resolution to use.

LastRecommendedScreenWidth

float UGameUserSettings::LastRecommendedScreenWidth

protected

Result of the last benchmark; calculated resolution to use.

LastUserConfirmedDesiredScreenHeight

int32 UGameUserSettings::LastUserConfirmedDesiredScreenHeight

protected

Desired screen height used to calculate the resolution scale when user changes display mode

LastUserConfirmedDesiredScreenWidth

int32 UGameUserSettings::LastUserConfirmedDesiredScreenWidth

protected

Desired screen width used to calculate the resolution scale when user changes display mode

LastUserConfirmedResolutionSizeX

uint32 UGameUserSettings::LastUserConfirmedResolutionSizeX

protected

Game screen resolution width, in pixels.

LastUserConfirmedResolutionSizeY

uint32 UGameUserSettings::LastUserConfirmedResolutionSizeY

protected

Game screen resolution height, in pixels.

MinResolutionScale

float UGameUserSettings::MinResolutionScale

protected

Min resolution scale we allow in current display mode

OnUpdateCloudDataFromGameUserSettings

FUpdateCloudDataFromGameUserSettings UGameUserSettings::OnUpdateCloudDataFromGameUserSettings

OnUpdateGameUserSettingsFileFromCloud

FUpdateGameUserSettingsFileFromCloud UGameUserSettings::OnUpdateGameUserSettingsFileFromCloud

PreferredFullscreenMode

int32 UGameUserSettings::PreferredFullscreenMode

protected

Fullscreen mode to use when toggling between windowed and fullscreen. Same values as r.FullScreenMode.

ResolutionSizeX

uint32 UGameUserSettings::ResolutionSizeX

protected

Game screen resolution width, in pixels.

ResolutionSizeY

uint32 UGameUserSettings::ResolutionSizeY

protected

Game screen resolution height, in pixels.

ScalabilityQuality

Scalability::FQualityLevels UGameUserSettings::ScalabilityQuality

Version

uint32 UGameUserSettings::Version

protected

All settings will be wiped and set to default if the serialized version differs from UE_GAMEUSERSETTINGS_VERSION.

WindowPositions

TArray<FIntPoint> UGameUserSettings::WindowPositions

protected

Saved window positions. Multiple instances running simultaneously can use different ones.

WindowPosX_DEPRECATED

int32 UGameUserSettings::WindowPosX_DEPRECATED

protected

Window PosX

WindowPosY_DEPRECATED

int32 UGameUserSettings::WindowPosY_DEPRECATED

protected

Window PosY

---

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

• Engine/Source/Runtime/Engine/Classes/GameFramework/GameUserSettings.h
• Engine/Source/Runtime/Engine/Private/GameUserSettings.cpp