Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

> Unreal Engine API Reference > Plugins > GameplayAbilities > FGameplayAttribute

Light Theme

Dark Theme

FGameplayAttribute

Describes a [FGameplayAttributeData](API\Plugins\GameplayAbilities\FGameplayAttributeData) or float property inside an attribute set.

Choose your operating system:

Windows

macOS

Linux

References

Module	GameplayAbilities
Header	/Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/AttributeSet.h
Include	#include "AttributeSet.h"

Syntax

USTRUCT(BlueprintType)
struct FGameplayAttribute

Remarks

Describes a FGameplayAttributeData or float property inside an attribute set. Using this provides editor UI and helper functions

Variables

		Name	Description
	FString	AttributeName	Name of the attribute, usually the same as property name

Constructors

	Name	Description
	FGameplayAttribute()
	FGameplayAttribute ( FProperty* NewProperty )

Functions

	Name	Description
void	GetAllAttributeProperties ( TArray< FProperty* >& OutProp..., FString FilterMetaStr, bool UseEditorOnlyData )	In editor, this will filter out properties with meta tag "HideInDetailsView" or equal to FilterMetaStr.
UClass *	GetAttributeSetClass()	Returns the AttributeSet subclass holding this attribute
FGameplayAtt...	GetGameplayAttributeData ( UAttributeSet* Src )	Returns the AttributeData, will fail if this is a float attribute
const FGamep...	GetGameplayAttributeData ( const UAttributeSet* Src )	Returns the AttributeData, will fail if this is a float attribute
const FGamep...	GetGameplayAttributeDataChecked ( const UAttributeSet* Src )	Returns the AttributeData, will fail if this is a float attribute
FGameplayAtt...	GetGameplayAttributeDataChecked ( UAttributeSet* Src )	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	IsSystemAttribute()	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, UAttributeSet* Dest )	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

		Name	Description
	bool	operator!= ( const FGameplayAttribute& Other )
	bool	operator== ( const FGameplayAttribute& Other )	Equality/Inequality operators