Navigation
API > API/Plugins > API/Plugins/GameplayAbilities
References
| Module | GameplayAbilities |
| Header | /Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/AttributeSet.h |
| Include | #include "AttributeSet.h" |
Syntax
USTRUCT&40;BlueprintType&41;
struct FGameplayAttribute
Remarks
Describes a FGameplayAttributeData or float property inside an attribute set. Using this provides editor UI and helper functions
Variables
| Type | Name | Description | |
|---|---|---|---|
| FString | AttributeName | Name of the attribute, usually the same as property name |
Constructors
| Type | Name | Description | |
|---|---|---|---|
FGameplayAttribute
(
FProperty* NewProperty |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | GetAllAttributeProperties
(
TArray< FProperty* >& OutProperties, |
In editor, this will filter out properties with meta tag "HideInDetailsView" or equal to FilterMetaStr. | |
| UClass * | Returns the AttributeSet subclass holding this attribute | ||
| FGameplayAttributeData * | GetGameplayAttributeData
(
UAttributeSet* Src |
Returns the AttributeData, will fail if this is a float attribute | |
| const FGameplayAttributeData * | GetGameplayAttributeData
(
const UAttributeSet* Src |
Returns the AttributeData, will fail if this is a float attribute | |
| const FGameplayAttributeData * | GetGameplayAttributeDataChecked
(
const UAttributeSet* Src |
Returns the AttributeData, will fail if this is a float attribute | |
| FGameplayAttributeData * | Returns the AttributeData, will fail if this is a float attribute | ||
| FString | GetName () |
Returns name of attribute, usually the same as the property | |
| float | GetNumericValue
(
const UAttributeSet* Src |
Returns the current value of an attribute | |
| float | GetNumericValueChecked
(
const UAttributeSet* Src |
Returns the current value of an attribute | |
| FProperty * | GetUProperty () |
Returns raw property | |
| bool | IsGameplayAttributeDataProperty
(
const FProperty* Property |
Returns true if the variable associated with Property is of type FGameplayAttributeData or one of its subclasses | |
| bool | Returns true if this is one of the special attributes defined on the AbilitySystemComponent itself | ||
| bool | IsValid () |
||
| void | PostSerialize
(
const FArchive& Ar |
Custom serialization | |
| void | SetNumericValueChecked
(
float& NewValue, |
Modifies the current value of an attribute, will not modify base value if that is supported | |
| void | SetUProperty
(
FProperty* NewProperty |
Set up from a FProperty inside a set |
Operators
| Type | Name | Description | |
|---|---|---|---|
| bool | operator!=
(
const FGameplayAttribute& Other |
||
| bool | operator==
(
const FGameplayAttribute& Other |
Equality/Inequality operators |