RealDocs UE 5.6

GameplayAbilities

1 views

84 entries in this module.

class Classes (5)

UAbilitySystemComponent BP The core component of the Gameplay Ability System (GAS). UAttributeSet BP The base class for defining numeric attributes (health, stamina, damage) that GAS effects can read and modify. UGameplayAbility BP The base class for all GAS abilities. UGameplayCueManager Manages the routing of Gameplay Cue events (OnActive, WhileActive, Removed, Executed) to UGameplayCueNotify actors and objects. UGameplayEffect BP A data-only class that defines how gameplay attributes are modified: damage, healing, buffs, debuffs, and cooldowns.

struct Structs (1)

FGameplayAttribute A lightweight handle that identifies a specific attribute property on an UAttributeSet.

function Global Functions (77)

UAbilitySystemComponent::AbilityReplicatedEventDelegate Returns the multicast delegate for a specific Generic Replicated Event and ability/prediction-key pair. UAbilitySystemComponent::AbilitySpecInputPressed Notifies the ASC that the input bound to a specific ability spec was pressed. UAbilitySystemComponent::AbilitySpecInputReleased Notifies the ASC that the input bound to a specific ability spec was released. 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. UAbilitySystemComponent::AbilityTargetDataSetDelegate Returns (and creates if absent) the multicast delegate that fires when replicated target data arrives for a specific ability/prediction-key pair. UAbilitySystemComponent::ApplyGameplayEffectToSelf BP Applies a Gameplay Effect directly to this component's owner. UAbilitySystemComponent::BeginPlay Called when the owning actor's BeginPlay fires. 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. 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. 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. UAbilitySystemComponent::CallReplicatedEventDelegateIfSet Fires the delegate for a specific Generic Replicated Event if that event has already been sent, returning true if it fired. UAbilitySystemComponent::CallReplicatedTargetDataDelegatesIfSet Fires the TargetData Confirm and Cancel delegates if target data has already been replicated for the given ability and prediction key pair. UAbilitySystemComponent::CancelAbilityTargetData Cancels pending ability target data and fires any registered cancel callbacks for the given ability/prediction-key pair. UAbilitySystemComponent::ClearActorInfo Clears the owner and avatar actor references from the AbilityActorInfo structure. 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. UAbilitySystemComponent::ConfirmAbilityTargetData Stores the incoming target data and fires the TargetDataSet delegate so ability tasks waiting on target data can proceed. UAbilitySystemComponent::ConsumeAllReplicatedData Deletes all cached replicated data (target data and generic events) for the given ability handle and prediction key. UAbilitySystemComponent::ConsumeClientReplicatedTargetData Clears only the cached client target data for the given ability handle and prediction key, leaving generic replicated event data intact. 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. 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. UAbilitySystemComponent::GetAvatarActor Returns the avatar actor for this component — the physical actor in the world that abilities act upon. UAbilitySystemComponent::GetAvatarActor_Direct Returns the raw AvatarActor pointer stored in this component. UAbilitySystemComponent::GetGameplayTaskAvatar Returns the avatar actor to use for the given gameplay task, implementing the IGameplayTaskOwnerInterface contract. 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. 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. UAbilitySystemComponent::GetShouldTick Returns whether the ASC needs to tick this frame. UAbilitySystemComponent::GiveAbility BP Grants an ability to this component so it can later be activated. 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. UAbilitySystemComponent::InitializeComponent Called when the component is registered and initialized. UAbilitySystemComponent::InvokeReplicatedEvent Fires all delegates registered for the given generic replicated event on this machine, if any. UAbilitySystemComponent::InvokeReplicatedEventWithPayload Fires registered delegates for the given generic replicated event and delivers the accompanying vector payload. UAbilitySystemComponent::OnAvatarActorDestroyed Internal callback bound to the avatar actor's OnDestroyed delegate. UAbilitySystemComponent::OnComponentDestroyed Called when the component is about to be destroyed. UAbilitySystemComponent::OnOwnerActorDestroyed Internal callback bound to the owner actor's OnDestroyed delegate. UAbilitySystemComponent::OnPlayerControllerSet Called when the ASC's AbilityActorInfo has a PlayerController assigned. UAbilitySystemComponent::OnRegister Called when the component is registered with its owning actor. UAbilitySystemComponent::OnRep_OwningActor RepNotify called on clients when the owning or avatar actor reference replicates. 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. UAbilitySystemComponent::OnUnregister Called when the component is unregistered from its owning actor. UAbilitySystemComponent::PostNetReceive Engine replication callback invoked on clients after replicated properties have been applied. UAbilitySystemComponent::PreNetReceive Engine replication callback invoked on clients immediately before replicated properties are applied to this component. UAbilitySystemComponent::ReadyForReplication Called by the replication system when this component is ready to begin replication. 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. UAbilitySystemComponent::ReplicateSubobjects Called by the replication system to replicate gameplay ability instances and other subobjects owned by this component. UAbilitySystemComponent::ServerSetInputPressed Server RPC that directly replicates an input-pressed event for the given ability. UAbilitySystemComponent::ServerSetInputReleased Server RPC that directly replicates an input-released event for the given ability. UAbilitySystemComponent::ServerSetReplicatedEvent Reliable server RPC that tells the server a generic replicated event occurred on the client (e. 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. UAbilitySystemComponent::ServerSetReplicatedTargetData Reliable server RPC that sends confirmed targeting data from the client to the server. UAbilitySystemComponent::ServerSetReplicatedTargetDataCancelled Reliable server RPC that notifies the server the player cancelled targeting. UAbilitySystemComponent::SetAvatarActor Changes the avatar actor while keeping the owner actor the same. UAbilitySystemComponent::SetAvatarActor_Direct Directly sets the AvatarActor pointer without triggering the full actor-info refresh that SetAvatarActor performs. UAbilitySystemComponent::SetOwnerActor Sets the logical owner actor for this component without triggering a full InitAbilityActorInfo refresh. UAbilitySystemComponent::TickComponent Per-frame update for the ASC. UAbilitySystemComponent::TryActivateAbility Attempts to activate a previously granted ability. UAbilitySystemComponent::UninitializeComponent Called when the component is unregistered. UAttributeSet::GetActorInfo Returns the FGameplayAbilityActorInfo cached on the owning AbilitySystemComponent, giving access to the avatar actor, movement component, and other ability-system actor context. UAttributeSet::GetAttributesFromSetClass Reflects over an AttributeSet subclass and appends an FGameplayAttribute for every FGameplayAttributeData or supported float property it declares. UAttributeSet::GetOwningAbilitySystemComponent Returns the ability system component that owns this attribute set, or nullptr if it isn't registered with one. UAttributeSet::GetOwningAbilitySystemComponentChecked Returns the ability system component that owns this attribute set, asserting if it isn't registered with one. UAttributeSet::GetOwningActor Returns the actor that owns this AttributeSet, resolved by walking up to the AttributeSet's Outer. 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. 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. UAttributeSet::IsSupportedForNetworking Returns true, marking AttributeSets as supported for UObject replication so they can be sent as subobjects of their owning actor or AbilitySystemComponent. 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. UAttributeSet::PostAttributeBaseChange Called just after an attribute's base value has changed when that attribute has an active aggregator. UAttributeSet::PostAttributeChange Called just after any modification has changed an attribute's current value. UAttributeSet::PostGameplayEffectExecute Called immediately after a GameplayEffect execution has modified an attribute's base value. UAttributeSet::PostNetReceive Called on clients just after replicated properties on this AttributeSet have been applied from the network. UAttributeSet::PreAttributeBaseChange Called just before an attribute's base value changes when that attribute has an active aggregator. UAttributeSet::PreAttributeChange Called just before any modification changes an attribute's current value, regardless of the source. 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. UAttributeSet::PreNetReceive Called on clients just before replicated properties on this AttributeSet are applied from the network. UAttributeSet::PrintDebug Logs debug information about this AttributeSet's current state. UAttributeSet::RegisterReplicationFragments Registers this attribute set's replication fragments with the Iris replication system, overriding UObject's default implementation. 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. UAttributeSet::ShouldInitProperty Override to opt specific properties out of the default initialization pass an AttributeSet runs when it's constructed or reset.

property Properties (1)

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.