UAttributeSet

class GameplayAbilities Blueprint Since unknown

#include "AttributeSet.h"

Description

The base class for defining numeric attributes (health, stamina, damage) that GAS effects can read and modify. Subclass this and declare FGameplayAttributeData properties.

Caveats & Gotchas

• Use the ATTRIBUTE_ACCESSORS macro to generate GetHealth/SetHealth/InitHealth helpers — writing these by hand is error-prone.
• PreAttributeChange and PostAttributeChange are your hooks to clamp values. Clamping in PreAttributeChange is preferred to avoid out-of-range reads, but the value is already applied by the time PostAttributeChange fires.
• Attributes are replicated individually — mark them with UPROPERTY(Replicated) and implement GetLifetimeReplicatedProps. Forgetting replication means clients see stale values.

Example

Minimal attribute set with health C++

UCLASS()
class UMyAttributeSet : public UAttributeSet
{
    GENERATED_BODY()
public:
    UPROPERTY(BlueprintReadOnly, ReplicatedUsing=OnRep_Health, Category="Attributes")
    FGameplayAttributeData Health;
    ATTRIBUTE_ACCESSORS(UMyAttributeSet, Health)

    virtual void PreAttributeChange(const FGameplayAttribute& Attribute, float& NewValue) override
    {
        if (Attribute == GetHealthAttribute())
            NewValue = FMath::Clamp(NewValue, 0.f, GetMaxHealth());
    }
};

Functions (21)

Networking 6 Utility 2 Effects 7 Initialization 2 Ownership 4

Networking

6 ▼

Access	Type	Name	Description
public	function	UAttributeSet::IsNameStableForNetworking	Returns true when this AttributeSet was marked net addressable via SetNetAddressable(), telling the networking system it can be referenced by a stable name instead of an index.
public	function	UAttributeSet::IsSupportedForNetworking	Returns true, marking AttributeSets as supported for UObject replication so they can be sent as subobjects of their owning actor or AbilitySystemComponent.
public	function	UAttributeSet::PostNetReceive	Called on clients just after replicated properties on this AttributeSet have been applied from the network.
public	function	UAttributeSet::PreNetReceive	Called on clients just before replicated properties on this AttributeSet are applied from the network.
public	function	UAttributeSet::RegisterReplicationFragments	Registers this attribute set's replication fragments with the Iris replication system, overriding UObject's default implementation.
public	function	UAttributeSet::SetNetAddressable	Marks this AttributeSet so it can be identified by name, rather than by index, when replicated as part of a fast array or subobject list.

Utility

2 ▼

Access	Type	Name	Description
public	function	UAttributeSet::GetAttributesFromSetClass	Reflects over an AttributeSet subclass and appends an FGameplayAttribute for every FGameplayAttributeData or supported float property it declares.
public	function	UAttributeSet::PrintDebug	Logs debug information about this AttributeSet's current state.

Effects

7 ▼

Access	Type	Name	Description
public	function	UAttributeSet::PostAttributeChange	Called just after any modification has changed an attribute's current value.
public	function	UAttributeSet::PostGameplayEffectExecute	Called immediately after a GameplayEffect execution has modified an attribute's base value.
public	function	UAttributeSet::PreAttributeChange	Called just before any modification changes an attribute's current value, regardless of the source.
public	function	UAttributeSet::PreGameplayEffectExecute	Called immediately before a GameplayEffect execution modifies an attribute's base value, giving the AttributeSet a chance to inspect or reject the change.
public	function	UAttributeSet::OnAttributeAggregatorCreated	Called when the ability system creates an FAggregator for one of this set's attributes, letting you customize the aggregator's EvaluationMetaData before it starts combining modifiers.
public	function	UAttributeSet::PostAttributeBaseChange	Called just after an attribute's base value has changed when that attribute has an active aggregator.
public	function	UAttributeSet::PreAttributeBaseChange	Called just before an attribute's base value changes when that attribute has an active aggregator.

Initialization

2 ▼

Access	Type	Name	Description
public	function	UAttributeSet::InitFromMetaDataTable	Initializes every FGameplayAttributeData property on this set from a metadata DataTable, using each attribute's property name to look up a matching row.
public	function	UAttributeSet::ShouldInitProperty	Override to opt specific properties out of the default initialization pass an AttributeSet runs when it's constructed or reset.

Ownership

4 ▼

Access	Type	Name	Description
public	function	UAttributeSet::GetOwningAbilitySystemComponent	Returns the ability system component that owns this attribute set, or nullptr if it isn't registered with one.
public	function	UAttributeSet::GetOwningAbilitySystemComponentChecked	Returns the ability system component that owns this attribute set, asserting if it isn't registered with one.
public	function	UAttributeSet::GetOwningActor	Returns the actor that owns this AttributeSet, resolved by walking up to the AttributeSet's Outer.
public	function	UAttributeSet::GetActorInfo	Returns the FGameplayAbilityActorInfo cached on the owning AbilitySystemComponent, giving access to the avatar actor, movement component, and other ability-system actor context.

Version History

Introduced in: unknown

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?