UGantrySettingNumber
A number between Minimum and Maximum, usually drawn as a slider.
Every new value is clamped to the range and snapped to Step.
- Inherits
UGantrySettingValue
Properties
| Property | Type | Default | Description |
|---|---|---|---|
Minimum read-only | double | 0.000000 | The smallest value. |
Maximum read-only | double | 1.000000 | The largest value. |
Step read-only | double | 0.010000 | Values snap to multiples of this from Minimum; 0 for none. |
bHasDefault read-only | bool | False | Whether there is a default to reset to. Without one, a saved value starts at Minimum. |
Default read-only | double | 0.000000 | The default. |
Format read-only | EGantrySettingNumberFormat | Number | How the value is written for the player. |
Decimals read-only | int32 | 2 | Decimal places for the Number format. |
Functions
GetFormattedValue
| Pin | Type | Direction | Description |
|---|---|---|---|
| Return Value | FText | out | The value written for the player, in Format. |
GetNormalized
| Pin | Type | Direction | Description |
|---|---|---|---|
| Return Value | double | out | The value as a fraction of the range, 0 to 1, for a slider. |
GetNormalizedStep
| Pin | Type | Direction | Description |
|---|---|---|---|
| Return Value | double | out | One step as a fraction of the range, for a slider's step size. |
GetValue
| Pin | Type | Direction | Description |
|---|---|---|---|
| Return Value | double | out | The current value. |
SetNormalized
Sets the value from a fraction of the range, 0 to 1.
| Pin | Type | Direction | Description |
|---|---|---|---|
Normalized | double | in |
SetValue
Sets the value, snapped to Step and clamped to the range.
| Pin | Type | Direction | Description |
|---|---|---|---|
Value | double | in |
C++
Public C++ members that Blueprint does not see.
ResetToDefault
virtual void
Sets Default, when the setting has one.
HasDefault
virtual bool
Whether Has Default is set.
GetDefaultValueString
virtual FString
Default as text when the setting has one, otherwise Minimum.