Class USFSettingDefinition_Key
ClassList > USFSettingDefinition_Key
Setting definition for setting keybind for an action. More...
#include "Definitions/SFSettingDefinition.h"
Inherits the following classes: USFSettingDefinition
Public Attributes
| Type | Name |
|---|---|
| FGameplayTagContainer | CollisionChannels |
| FName | GamepadName |
| FName | KBMPrimaryName |
| FName | KBMSecondaryName |
Public Attributes inherited from USFSettingDefinition
| Type | Name |
|---|---|
| FText | Description |
| FText | DisplayName |
| TArray< TObjectPtr< class USFSettingCondition > > | EditabilityConditions |
| FGameplayTag | SettingTag |
| TArray< TObjectPtr< class USFSettingCondition > > | VisibilityConditions |
| bool | bRevertToDefaultOnDisable = false |
Public Functions
| Type | Name |
|---|---|
| virtual TSubclassOf< USFSettingValue > | GetValueClass () override const |
Public Functions inherited from USFSettingDefinition
| Type | Name |
|---|---|
| virtual class USFSettingValue * | GetDefaultValue (const UObject * WorldContextObject) const |
| virtual TSubclassOf< USFSettingValue > | GetValueClass () const |
Protected Attributes inherited from USFSettingDefinition
| Type | Name |
|---|---|
| TObjectPtr< class USFSettingValue > | DefaultValue |
Detailed Description
Setting definition for setting keybind for an action.
Blueprint display name: SF Keybind Setting.
Public Attributes Documentation
variable CollisionChannels
FGameplayTagContainer USFSettingDefinition_Key::CollisionChannels;
Channels identified by Gameplay Tags for collision checking. Only settings that share at least one channel will trigger collision warnings. Useful for categorizing keybinds into different groups such as "Global", "Combat", "UI", etc., so that only keybinds in the same group will trigger collision warnings.
Note:
EditDefaultsOnly
variable GamepadName
FName USFSettingDefinition_Key::GamepadName;
The identifier for the gamepad keybind in the Input Mapping Context.
Note:
EditDefaultsOnly BlueprintReadOnly
variable KBMPrimaryName
FName USFSettingDefinition_Key::KBMPrimaryName;
The identifier for the primary KBM keybind in the Input Mapping Context.
Note:
EditDefaultsOnly BlueprintReadOnly
variable KBMSecondaryName
FName USFSettingDefinition_Key::KBMSecondaryName;
The identifier for the secondary KBM keybind in the Input Mapping Context.
Note:
EditDefaultsOnly BlueprintReadOnly
Public Functions Documentation
function GetValueClass
inline virtual TSubclassOf< USFSettingValue > USFSettingDefinition_Key::GetValueClass () override const
Get the USFSettingValue-derived class of the value this setting uses.
Returns:
The USFSettingValue-derived class of the value this setting uses.
Implements USFSettingDefinition::GetValueClass
The documentation for this class was generated from the following file Source/SettingsFramework/Public/Definitions/SFSettingDefinition.h