UAbilitySystemComponent

class GameplayAbilities Blueprint Since unknown

Inherits: UObject › UActorComponent › UGameplayTasksComponent › UAbilitySystemComponent

#include "AbilitySystemComponent.h"

Description

The core component of the Gameplay Ability System (GAS). Manages a character's granted abilities, active gameplay effects, and attribute sets. Must be added to any actor that participates in GAS.

Caveats & Gotchas

• GiveAbility and most effect-application functions require server authority. On clients, only call functions marked BlueprintCallable without BlueprintAuthorityOnly.
• The component implements IAbilitySystemInterface on the owning actor — implement that interface to allow other GAS helpers to find it.
• Ability activation is asynchronous on clients using prediction; never assume an ability is active immediately after calling TryActivateAbility on a client.

Example

Add the component in a Character constructor C++

AbilitySystemComponent = CreateDefaultSubobject<UAbilitySystemComponent>(TEXT("AbilitySystemComponent"));
AbilitySystemComponent->SetIsReplicated(true);
AbilitySystemComponent->SetReplicationMode(EGameplayEffectReplicationMode::Minimal);

Functions (56)

Lifecycle 9 Input 2 Networking 27 Abilities 2 Actor Info 13 Effects 1 Targeting 2

Lifecycle

9 ▼

Access	Type	Name	Description
public	function	UAbilitySystemComponent::BeginPlay	Called when the owning actor's BeginPlay fires.
public	function	UAbilitySystemComponent::InitializeComponent	Called when the component is registered and initialized.
public	function	UAbilitySystemComponent::OnComponentDestroyed	Called when the component is about to be destroyed.
public	function	UAbilitySystemComponent::TickComponent	Per-frame update for the ASC.
public	function	UAbilitySystemComponent::UninitializeComponent	Called when the component is unregistered.
public	function	UAbilitySystemComponent::GetShouldTick	Returns whether the ASC needs to tick this frame.
public	function	UAbilitySystemComponent::OnRegister	Called when the component is registered with its owning actor.
public	function	UAbilitySystemComponent::OnSpawnedAttributesEndPlayed	Bound to the EndPlay delegate of actors that own spawned attribute sets, so the ASC can remove those attribute sets when the actor leaves play.
public	function	UAbilitySystemComponent::OnUnregister	Called when the component is unregistered from its owning actor.

Input

2 ▼

Access	Type	Name	Description
public	function	UAbilitySystemComponent::AbilitySpecInputPressed	Notifies the ASC that the input bound to a specific ability spec was pressed.
public	function	UAbilitySystemComponent::AbilitySpecInputReleased	Notifies the ASC that the input bound to a specific ability spec was released.

Networking

27 ▼

Access	Type	Name	Description
public	function	UAbilitySystemComponent::AbilityReplicatedEventDelegate	Returns the multicast delegate for a specific Generic Replicated Event and ability/prediction-key pair.
public	function	UAbilitySystemComponent::AbilityTargetDataCancelledDelegate	Returns a reference to the multicast delegate that fires when the client replicates a targeting cancellation for the given ability/prediction-key pair.
public	function	UAbilitySystemComponent::CacheIsNetSimulated	Caches the current net simulated/authority flags on the component so that frequently called GAS internals can read them cheaply without re-evaluating actor net role each time.
public	function	UAbilitySystemComponent::CallAllReplicatedDelegatesIfSet	Fires all pending replicated delegates (target data and generic events) that have already been received but not yet invoked for the given ability activation.
public	function	UAbilitySystemComponent::CallOrAddReplicatedDelegate	Fires the supplied delegate immediately if the Generic Replicated Event has already been received; otherwise registers it to fire when the event arrives.
public	function	UAbilitySystemComponent::CallReplicatedEventDelegateIfSet	Fires the delegate for a specific Generic Replicated Event if that event has already been sent, returning true if it fired.
public	function	UAbilitySystemComponent::CallReplicatedTargetDataDelegatesIfSet	Fires the TargetData Confirm and Cancel delegates if target data has already been replicated for the given ability and prediction key pair.
public	function	UAbilitySystemComponent::ClientSetReplicatedEvent	Reliable client RPC sent by the server to notify the owning client that a generic replicated event has occurred, allowing server-driven ability flow steps to trigger locally.
public	function	UAbilitySystemComponent::ConfirmAbilityTargetData	Stores the incoming target data and fires the TargetDataSet delegate so ability tasks waiting on target data can proceed.
public	function	UAbilitySystemComponent::ConsumeAllReplicatedData	Deletes all cached replicated data (target data and generic events) for the given ability handle and prediction key.
public	function	UAbilitySystemComponent::ConsumeClientReplicatedTargetData	Clears only the cached client target data for the given ability handle and prediction key, leaving generic replicated event data intact.
public	function	UAbilitySystemComponent::ConsumeGenericReplicatedEvent	Clears the cached state of a single generic replicated event, allowing the same event type to be re-registered and fired again within the same ability activation.
public	function	UAbilitySystemComponent::ForceReplication	Forces the owning actor's replication to update immediately so that gameplay cues and ability state changes are sent to clients with minimal latency.
public	function	UAbilitySystemComponent::GetReplicatedDataOfGenericReplicatedEvent	Returns the FAbilityReplicatedData stored for the given generic event, containing whether the event has been received and any vector payload sent with it.
public	function	UAbilitySystemComponent::InvokeReplicatedEvent	Fires all delegates registered for the given generic replicated event on this machine, if any.
public	function	UAbilitySystemComponent::InvokeReplicatedEventWithPayload	Fires registered delegates for the given generic replicated event and delivers the accompanying vector payload.
public	function	UAbilitySystemComponent::OnRep_OwningActor	RepNotify called on clients when the owning or avatar actor reference replicates.
public	function	UAbilitySystemComponent::PostNetReceive	Engine replication callback invoked on clients after replicated properties have been applied.
public	function	UAbilitySystemComponent::PreNetReceive	Engine replication callback invoked on clients immediately before replicated properties are applied to this component.
public	function	UAbilitySystemComponent::ReadyForReplication	Called by the replication system when this component is ready to begin replication.
public	function	UAbilitySystemComponent::ReplicateSubobjects	Called by the replication system to replicate gameplay ability instances and other subobjects owned by this component.
public	function	UAbilitySystemComponent::ServerSetInputPressed	Server RPC that directly replicates an input-pressed event for the given ability.
public	function	UAbilitySystemComponent::ServerSetInputReleased	Server RPC that directly replicates an input-released event for the given ability.
public	function	UAbilitySystemComponent::ServerSetReplicatedEvent	Reliable server RPC that tells the server a generic replicated event occurred on the client (e.
public	function	UAbilitySystemComponent::ServerSetReplicatedEventWithPayload	Variant of ServerSetReplicatedEvent that carries a quantized vector payload, useful for passing aim direction or position data from the client to the server alongside the event.
public	function	UAbilitySystemComponent::ServerSetReplicatedTargetData	Reliable server RPC that sends confirmed targeting data from the client to the server.
public	function	UAbilitySystemComponent::ServerSetReplicatedTargetDataCancelled	Reliable server RPC that notifies the server the player cancelled targeting.

Abilities

2 ▼

Access	Type	Name	Description
public	function	UAbilitySystemComponent::GiveAbility	Grants an ability to this component so it can later be activated.
public	function	UAbilitySystemComponent::TryActivateAbility	Attempts to activate a previously granted ability.

Actor Info

13 ▼

Access	Type	Name	Description
public	function	UAbilitySystemComponent::GetOwnerActor	Returns the logical owner actor stored in this component, which is typically a PlayerState rather than the Pawn when using the GAS split-ownership pattern.
public	function	UAbilitySystemComponent::InitAbilityActorInfo	Initialises the AbilityActorInfo structure with owner and avatar actors, caching movement component, mesh, anim instance, and player controller references used throughout the GAS system.
public	function	UAbilitySystemComponent::ClearActorInfo	Clears the owner and avatar actor references from the AbilityActorInfo structure.
public	function	UAbilitySystemComponent::GetAvatarActor	Returns the avatar actor for this component — the physical actor in the world that abilities act upon.
public	function	UAbilitySystemComponent::GetAvatarActor_Direct	Returns the raw AvatarActor pointer stored in this component.
public	function	UAbilitySystemComponent::RefreshAbilityActorInfo	Re-queries the avatar actor's movement component, mesh, anim instance, and player controller, updating the cached AbilityActorInfo without changing the owner or avatar actor references themselves.
public	function	UAbilitySystemComponent::SetAvatarActor	Changes the avatar actor while keeping the owner actor the same.
public	function	UAbilitySystemComponent::SetOwnerActor	Sets the logical owner actor for this component without triggering a full InitAbilityActorInfo refresh.
public	function	UAbilitySystemComponent::GetGameplayTaskAvatar	Returns the avatar actor to use for the given gameplay task, implementing the IGameplayTaskOwnerInterface contract.
public	function	UAbilitySystemComponent::OnAvatarActorDestroyed	Internal callback bound to the avatar actor's OnDestroyed delegate.
public	function	UAbilitySystemComponent::OnOwnerActorDestroyed	Internal callback bound to the owner actor's OnDestroyed delegate.
public	function	UAbilitySystemComponent::OnPlayerControllerSet	Called when the ASC's AbilityActorInfo has a PlayerController assigned.
public	function	UAbilitySystemComponent::SetAvatarActor_Direct	Directly sets the AvatarActor pointer without triggering the full actor-info refresh that SetAvatarActor performs.

Effects

1 ▼

Access	Type	Name	Description
public	function	UAbilitySystemComponent::ApplyGameplayEffectToSelf	Applies a Gameplay Effect directly to this component's owner.

Targeting

2 ▼

Access	Type	Name	Description
public	function	UAbilitySystemComponent::AbilityTargetDataSetDelegate	Returns (and creates if absent) the multicast delegate that fires when replicated target data arrives for a specific ability/prediction-key pair.
public	function	UAbilitySystemComponent::CancelAbilityTargetData	Cancels pending ability target data and fires any registered cancel callbacks for the given ability/prediction-key pair.

Properties

Access	Type	Name	Description
public	property	UAbilitySystemComponent::ReplicatedPredictionKeyMap	Replicated map that synchronises prediction keys from the autonomous proxy to the server so both sides can correlate client-predicted actions with their authoritative results.

Version History

Introduced in: unknown

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?