File size: 3,982 Bytes
b315adb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 | // Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
#include "GameSettingValueScalar.h"
#include "GameSettingValueScalarDynamic.generated.h"
#define UE_API GAMESETTINGS_API
struct FNumberFormattingOptions;
class FGameSettingDataSource;
class UObject;
//////////////////////////////////////////////////////////////////////////
// UGameSettingValueScalarDynamic
//////////////////////////////////////////////////////////////////////////
typedef TFunction<FText(double SourceValue, double NormalizedValue)> FSettingScalarFormatFunction;
UCLASS(MinimalAPI)
class UGameSettingValueScalarDynamic : public UGameSettingValueScalar
{
GENERATED_BODY()
public:
static UE_API FSettingScalarFormatFunction Raw;
static UE_API FSettingScalarFormatFunction RawOneDecimal;
static UE_API FSettingScalarFormatFunction RawTwoDecimals;
static UE_API FSettingScalarFormatFunction ZeroToOnePercent;
static UE_API FSettingScalarFormatFunction ZeroToOnePercent_OneDecimal;
static UE_API FSettingScalarFormatFunction SourceAsPercent1;
static UE_API FSettingScalarFormatFunction SourceAsPercent100;
static UE_API FSettingScalarFormatFunction SourceAsInteger;
private:
static const FNumberFormattingOptions& GetOneDecimalFormattingOptions();
public:
UE_API UGameSettingValueScalarDynamic();
/** UGameSettingValue */
UE_API virtual void Startup() override;
UE_API virtual void StoreInitial() override;
UE_API virtual void ResetToDefault() override;
UE_API virtual void RestoreToInitial() override;
/** UGameSettingValueScalar */
UE_API virtual TOptional<double> GetDefaultValue() const override;
UE_API virtual void SetValue(double Value, EGameSettingChangeReason Reason = EGameSettingChangeReason::Change) override;
UE_API virtual double GetValue() const override;
UE_API virtual TRange<double> GetSourceRange() const override;
UE_API virtual double GetSourceStep() const override;
UE_API virtual FText GetFormattedText() const override;
/** UGameSettingValueDiscreteDynamic */
UE_API void SetDynamicGetter(const TSharedRef<FGameSettingDataSource>& InGetter);
UE_API void SetDynamicSetter(const TSharedRef<FGameSettingDataSource>& InSetter);
UE_API void SetDefaultValue(double InValue);
/** */
UE_API void SetDisplayFormat(FSettingScalarFormatFunction InDisplayFormat);
/** */
UE_API void SetSourceRangeAndStep(const TRange<double>& InRange, double InSourceStep);
/**
* The SetSourceRangeAndStep defines the actual range the numbers could move in, but often
* the true minimum for the user is greater than the minimum source range, so for example, the range
* of some slider might be 0..100, but you want to restrict the slider so that while it shows
* a bar that travels from 0 to 100, the user can't set anything lower than some minimum, e.g. 1.
* That is the Minimum Limit.
*/
UE_API void SetMinimumLimit(const TOptional<double>& InMinimum);
/**
* The SetSourceRangeAndStep defines the actual range the numbers could move in, but rarely
* the true maximum for the user is less than the maximum source range, so for example, the range
* of some slider might be 0..100, but you want to restrict the slider so that while it shows
* a bar that travels from 0 to 100, the user can't set anything lower than some maximum, e.g. 95.
* That is the Maximum Limit.
*/
UE_API void SetMaximumLimit(const TOptional<double>& InMaximum);
protected:
/** UGameSettingValue */
UE_API virtual void OnInitialized() override;
UE_API void OnDataSourcesReady();
protected:
TSharedPtr<FGameSettingDataSource> Getter;
TSharedPtr<FGameSettingDataSource> Setter;
TOptional<double> DefaultValue;
double InitialValue = 0;
TRange<double> SourceRange = TRange<double>(0, 1);
double SourceStep = 0.01;
TOptional<double> Minimum;
TOptional<double> Maximum;
FSettingScalarFormatFunction DisplayFormat;
};
#undef UE_API
|