UDeviceProfile

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/DeviceProfiles/DeviceProfile.h

Include

#include "DeviceProfiles/DeviceProfile.h"

Syntax

class UDeviceProfile : public UTextureLODSettings

Variables

Name Description

Public variable

FString

 

BaseProfileName

The name of the parent profile of this object

Public variable

bool

 

bVisible

Flag used in the editor to determine whether the profile is visible in the property matrix

Public variable

FString

 

ConfigPlatform

This is not a property, it shouldn't be set by the editor

Public variable

TArray< FString...

 

CVars

The collection of CVars which is set from this profile

Public variable

FString

 

DeviceType

The type of this profile, I.e. IOS, Windows, PS4 etc

Public variable

UObject *

 

Parent

The parent object of this profile, it is the object matching this DeviceType with the BaseProfileName

Constructors

Name Description

Public function

UDeviceProfile

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

void

 

GatherParentCVarInformationRecursively

(
    OUTTMap< FString, FString >& CVarI...
)

Get the collection of Console Variables that this profile inherits from its' parents

Public function Const

const TMap< ...

 

GetConsolidatedCVars()

Lazily generate a consolidated list of CVars, recursing up the device profile hierarchy

Public function Const

bool

 

GetConsolidatedCVarValue

(
    const TCHAR* CVarName,
    FString& OutString,
    bool bCheckDefaults
)

Get the string value of a CVar that is held in this device profile, or in any parent device profile.

Public function Const

bool

 

GetConsolidatedCVarValue

(
    const TCHAR* CVarName,
    int32& OutValue,
    bool bCheckDefaults
)

Get the int32 value of a CVar that is held in this device profile, or in any parent device profile.

Public function Const

bool

 

GetConsolidatedCVarValue

(
    const TCHAR* CVarName,
    float& OutValue,
    bool bCheckDefaults
)

Get the float value of a CVar that is held in this device profile, or in any parent device profile.

Public function Const

FString

 

GetCVarValue

(
    const FString& CVarName
)

Public function Const

UTextureLODS...

 

GetTextureLODSettings()

Access to the device profiles Texture LOD Settings

Public function

bool

 

ModifyCVarValue

(
    const FString& CVarName,
    const FString& CVarValue,
    bool bAddIfNonExistant
)

Public function

FOnCVarsUpda...

 

OnCVarsUpdated()

Accessor to the delegate object fired when there has been any changes to the console variables

Public function

void

 

ValidateProfile()

ValidateProfile() Validate the Profile after changes by loading it's config (.ini)

Overridden from UObject

Name Description

Public function Virtual Const

const TCHAR ...

 

GetConfigOverridePlatform()

Prefer to load the DP from its platform's hierarchy

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

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