AnalyticsSettings.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Misc/Paths.h"
#include "Misc/ConfigCacheIni.h"
#include "Engine/DeveloperSettings.h"
#include "AnalyticsSettings.generated.h"
 
struct FPropertyChangedEvent;
 
UCLASS(Abstract)
class ANALYTICSVISUALEDITING_API UAnalyticsSettingsBase
    : public UDeveloperSettings
{
    GENERATED_UCLASS_BODY()
 
    UPROPERTY()
    FText SettingsDisplayName;
 
    UPROPERTY()
    FText SettingsTooltip;
 
    inline FString GetReleaseIniSection() const { return TEXT("Analytics"); }
    inline FString GetDebugIniSection() const { return TEXT("AnalyticsDebug"); }
    inline FString GetTestIniSection() const { return TEXT("AnalyticsTest"); }
    inline FString GetDevelopmentIniSection() const { return TEXT("AnalyticsDevelopment"); }
    inline FString GetIniName() const { return FString::Printf(TEXT("%sDefaultEngine.ini"), *FPaths::SourceConfigDir()); }
 
private:
#if WITH_EDITOR
    virtual void PostInitProperties() override
    {
        Super::PostInitProperties();
 
        ReadConfigSettings();
    }
 
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override
    {
        Super::PostEditChangeProperty(PropertyChangedEvent);
 
        WriteConfigSettings();
 
        GConfig->Flush(false, GetIniName());
    }
#endif
 
// UDeveloperSettings interface
    virtual FName GetCategoryName() const override;
 
// UAnalyticsSettingsBase interface  - derived classes should implement
protected:
    virtual void ReadConfigSettings() {}
    virtual void WriteConfigSettings() {}
 
#if WITH_EDITOR
    virtual FText GetSectionText() const
    {
        return SettingsDisplayName;
    }
    virtual FText GetSectionDescription() const
    {
        return SettingsTooltip;
    }
#endif
};
 
UCLASS()
class UAnalyticsSettings
    : public UAnalyticsSettingsBase
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditAnywhere, DisplayName="Development", Category=Providers, meta=(ConfigRestartRequired=true))
    FString DevelopmentProviderName;
 
    UPROPERTY(EditAnywhere, DisplayName="Debug", Category=Providers, meta=(ConfigRestartRequired=true))
    FString DebugProviderName;
 
    UPROPERTY(EditAnywhere, DisplayName="Test", Category=Providers, meta=(ConfigRestartRequired=true))
    FString TestProviderName;
 
    UPROPERTY(EditAnywhere, DisplayName="Release", Category=Providers, meta=(ConfigRestartRequired=true))
    FString ReleaseProviderName;
 
// UAnalyticsSettingsBase interface
protected:
    virtual void ReadConfigSettings();
    virtual void WriteConfigSettings();
};