UGantrySettingToggle
ClassGantrySettingsBlueprint-visibleshown as “Toggle Setting”
An on or off setting, usually drawn as a check box.
It is a choice with two options, "False" and "True". The values "0" and "1" count as the same, so a toggle works over a console variable as well as over a saved value. Without a Default Value, it starts off.
- Inherits
UGantrySettingChoice
Properties
| Property | Type | Default | Description |
|---|---|---|---|
OnText read-only | FText | NSLOCTEXT("GantrySetting", "On", "On") | What "on" reads as. |
OffText read-only | FText | NSLOCTEXT("GantrySetting", "Off", "Off") | What "off" reads as. |
Functions
IsOn
BlueprintCallableBlueprintPureGantry|Settings
| Pin | Type | Direction | Description |
|---|---|---|---|
| Return Value | bool | out | Whether it is on. |
SetOn
BlueprintCallableGantry|Settings
Turns it on or off.
| Pin | Type | Direction | Description |
|---|---|---|---|
bOn | bool | in |
C++
Public C++ members that Blueprint does not see.
UGantrySettingToggle
Sets the On and Off texts to "On" and "Off".
GetOptions_Implementation
virtual TArray< FGantrySettingOption >
Returns: Off ("False") and On ("True"), in that order.