Project Settings - Adding a way to easily introduce per platform settings objects that are correctly saved outside the game ini, and instead store their configuration to each platform's NDA'ed location, if they're a confidential platform. These platform options are kept in sync with what platforms you have enabled for your project (though a restart is required to see that reflected in the settings).
The base class of any per platform settings. The pattern for using these is as follows.
Step 1) Subclass UPlatformSettings, UMyPerPlatformSettings : public UPlatformSettings.
Step 2) For your system should already have a UDeveloperSettings that you created so that
users can customize other properties for your system in the project. On that class
you need to create a property of type FPerPlatformSettings, e.g.
UPROPERTY(EditAnywhere, Category=Platform)
FPerPlatformSettings PlatformOptions
Step 3) In your UDeveloperSettings subclasses construct, there should be a line like this,
PlatformOptions.Settings = UPlatformSettings::GetAllPlatformSettings<UMyPerPlatformSettings>();
This will actually ensure that you initialize the settings exposed in the editor to whatever
the current platform configuration is for them.
Step 4) Nothing else needed. In your system code, you will just call
UMyPerPlatformSettings* MySettings = UPlatformSettings::GetSettingsForPlatform<UMyPerPlatformSettings>()
that will get you the current settings for the active platform, or the simulated platform in the editor.
#review-16603960 Josh.Adams, Michael.Noland, Daren.Cheng
#fyi Josh.Adams, Michael.Noland, Daren.Cheng
[CL 16603959 by Nick Darnell in ue5-main branch]
2021-06-09 09:14:21 -04:00
|
|
|
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
|
|
|
|
|
|
#include "PerPlatformSettingsCustomization.h"
|
|
|
|
|
#include "DetailWidgetRow.h"
|
|
|
|
|
#include "Widgets/SBoxPanel.h"
|
|
|
|
|
#include "Widgets/Images/SImage.h"
|
2022-05-09 13:12:28 -04:00
|
|
|
#include "Styling/AppStyle.h"
|
Project Settings - Adding a way to easily introduce per platform settings objects that are correctly saved outside the game ini, and instead store their configuration to each platform's NDA'ed location, if they're a confidential platform. These platform options are kept in sync with what platforms you have enabled for your project (though a restart is required to see that reflected in the settings).
The base class of any per platform settings. The pattern for using these is as follows.
Step 1) Subclass UPlatformSettings, UMyPerPlatformSettings : public UPlatformSettings.
Step 2) For your system should already have a UDeveloperSettings that you created so that
users can customize other properties for your system in the project. On that class
you need to create a property of type FPerPlatformSettings, e.g.
UPROPERTY(EditAnywhere, Category=Platform)
FPerPlatformSettings PlatformOptions
Step 3) In your UDeveloperSettings subclasses construct, there should be a line like this,
PlatformOptions.Settings = UPlatformSettings::GetAllPlatformSettings<UMyPerPlatformSettings>();
This will actually ensure that you initialize the settings exposed in the editor to whatever
the current platform configuration is for them.
Step 4) Nothing else needed. In your system code, you will just call
UMyPerPlatformSettings* MySettings = UPlatformSettings::GetSettingsForPlatform<UMyPerPlatformSettings>()
that will get you the current settings for the active platform, or the simulated platform in the editor.
#review-16603960 Josh.Adams, Michael.Noland, Daren.Cheng
#fyi Josh.Adams, Michael.Noland, Daren.Cheng
[CL 16603959 by Nick Darnell in ue5-main branch]
2021-06-09 09:14:21 -04:00
|
|
|
#include "Engine/PlatformSettings.h"
|
|
|
|
|
#include "IDetailGroup.h"
|
|
|
|
|
#include "IDetailChildrenBuilder.h"
|
|
|
|
|
|
|
|
|
|
TSharedRef<IPropertyTypeCustomization> FPerPlatformSettingsCustomization::MakeInstance()
|
|
|
|
|
{
|
|
|
|
|
return MakeShareable(new FPerPlatformSettingsCustomization);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
FPerPlatformSettingsCustomization::FPerPlatformSettingsCustomization()
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void FPerPlatformSettingsCustomization::CustomizeHeader(TSharedRef<IPropertyHandle> PropertyHandle, FDetailWidgetRow& HeaderRow, IPropertyTypeCustomizationUtils& CustomizationUtils)
|
|
|
|
|
{
|
|
|
|
|
HeaderRow
|
|
|
|
|
.WholeRowContent()
|
|
|
|
|
.MaxDesiredWidth(TOptional<float>())
|
|
|
|
|
.MaxDesiredWidth(TOptional<float>())
|
|
|
|
|
[
|
|
|
|
|
PropertyHandle->CreatePropertyNameWidget()
|
|
|
|
|
];
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void FPerPlatformSettingsCustomization::CustomizeChildren(TSharedRef<IPropertyHandle> PropertyHandle, IDetailChildrenBuilder& ChildBuilder, IPropertyTypeCustomizationUtils& CustomizationUtils)
|
|
|
|
|
{
|
|
|
|
|
TSharedPtr<IPropertyHandle> SettingsProperty = PropertyHandle->GetChildHandle(GET_MEMBER_NAME_CHECKED(FPerPlatformSettings, Settings));
|
|
|
|
|
TSharedPtr<IPropertyHandleArray> SettingsPropertyArray = SettingsProperty->AsArray();
|
|
|
|
|
|
|
|
|
|
uint32 NumSettings;
|
|
|
|
|
SettingsPropertyArray->GetNumElements(NumSettings);
|
|
|
|
|
for (uint32 Index = 0; Index < NumSettings; ++Index)
|
|
|
|
|
{
|
|
|
|
|
TSharedPtr<IPropertyHandle> PlatformSettingsProperty = SettingsPropertyArray->GetElement(Index);
|
|
|
|
|
if (PlatformSettingsProperty->IsValidHandle())
|
|
|
|
|
{
|
|
|
|
|
UObject* PlatformSettingsObject;
|
|
|
|
|
FPropertyAccess::Result Result = PlatformSettingsProperty->GetValue(PlatformSettingsObject);
|
|
|
|
|
if (Result == FPropertyAccess::Success)
|
|
|
|
|
{
|
|
|
|
|
if (UPlatformSettings* PlatformSettings = Cast<UPlatformSettings>(PlatformSettingsObject))
|
|
|
|
|
{
|
|
|
|
|
FAddPropertyParams Params = FAddPropertyParams()
|
|
|
|
|
.UniqueId(PlatformSettings->GetFName())
|
|
|
|
|
.AllowChildren(true)
|
|
|
|
|
.CreateCategoryNodes(false);
|
|
|
|
|
|
2022-02-24 14:23:31 -05:00
|
|
|
IDetailGroup& PlatformGroup = ChildBuilder.AddGroup(PlatformSettings->GetFName(), FText::FromName(PlatformSettings->GetPlatformIniName()));
|
Project Settings - Adding a way to easily introduce per platform settings objects that are correctly saved outside the game ini, and instead store their configuration to each platform's NDA'ed location, if they're a confidential platform. These platform options are kept in sync with what platforms you have enabled for your project (though a restart is required to see that reflected in the settings).
The base class of any per platform settings. The pattern for using these is as follows.
Step 1) Subclass UPlatformSettings, UMyPerPlatformSettings : public UPlatformSettings.
Step 2) For your system should already have a UDeveloperSettings that you created so that
users can customize other properties for your system in the project. On that class
you need to create a property of type FPerPlatformSettings, e.g.
UPROPERTY(EditAnywhere, Category=Platform)
FPerPlatformSettings PlatformOptions
Step 3) In your UDeveloperSettings subclasses construct, there should be a line like this,
PlatformOptions.Settings = UPlatformSettings::GetAllPlatformSettings<UMyPerPlatformSettings>();
This will actually ensure that you initialize the settings exposed in the editor to whatever
the current platform configuration is for them.
Step 4) Nothing else needed. In your system code, you will just call
UMyPerPlatformSettings* MySettings = UPlatformSettings::GetSettingsForPlatform<UMyPerPlatformSettings>()
that will get you the current settings for the active platform, or the simulated platform in the editor.
#review-16603960 Josh.Adams, Michael.Noland, Daren.Cheng
#fyi Josh.Adams, Michael.Noland, Daren.Cheng
[CL 16603959 by Nick Darnell in ue5-main branch]
2021-06-09 09:14:21 -04:00
|
|
|
|
|
|
|
|
TSharedPtr<IPropertyHandle> PlatformSettingsPropertyArrayEntry = PlatformSettingsProperty->GetChildHandle(0);
|
|
|
|
|
|
|
|
|
|
//FDetailWidgetRow& PlatformGroup = ChildBuilder.AddCustomRow(FText::FromString(PlatformSettings->GetPlatformIniName()));
|
|
|
|
|
|
|
|
|
|
uint32 PlatformPropertiesChildHandleCount;
|
|
|
|
|
PlatformSettingsPropertyArrayEntry->GetNumChildren(PlatformPropertiesChildHandleCount);
|
|
|
|
|
for (uint32 PlatformPropertyIndex = 0; PlatformPropertyIndex < PlatformPropertiesChildHandleCount; PlatformPropertyIndex++)
|
|
|
|
|
{
|
|
|
|
|
TSharedPtr<IPropertyHandle> PlatformPropertyHandle = PlatformSettingsPropertyArrayEntry->GetChildHandle(PlatformPropertyIndex);
|
|
|
|
|
PlatformGroup.AddPropertyRow(PlatformPropertyHandle.ToSharedRef());
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
