1. Epic GamesDeveloper
  3. UAbilitySystemGlobals

UAbilitySystemGlobals

Holds global data for the ability system. Can be configured per project via config file

API > API/Plugins > API/Plugins/GameplayAbilities

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Config&61;Game&41;  
class UAbilitySystemGlobals : public UObject

Remarks

Holds global data for the ability system. Can be configured per project via config file

Variables

  Type Name Description
Public variable FOnAbilitySystemAssetFoundDelegate AbilityFindAssetInEditorCallbacks  
Public variable FOnAbilitySystemAssetOpenedDelegate AbilityOpenAssetInEditorCallbacks  
Public variable TArray< FString > AbilitySystemDebugStrings Global place to accumulate debug strings for ability system component.
Public variable UProperty Config FSoftClassPath AbilitySystemGlobalsClassName The class to instantiate as the globals object. Defaults to this class but can be overridden
Public variable UProperty Config FName ActivateFailCooldownName  
Public variable UProperty FGameplayTag ActivateFailCooldownTag TryActivate failed due to being on cooldown
Public variable UProperty Config FName ActivateFailCostName  
Public variable UProperty FGameplayTag ActivateFailCostTag TryActivate failed due to not being able to spend costs
Public variable UProperty Config FName ActivateFailIsDeadName  
Public variable UProperty FGameplayTag ActivateFailIsDeadTag TryActivate failed due to being dead
Public variable UProperty Config FName ActivateFailNetworkingName  
Public variable UProperty FGameplayTag ActivateFailNetworkingTag Failed to activate due to invalid networking settings, this is designer error
Public variable UProperty Config FName ActivateFailTagsBlockedName  
Public variable UProperty FGameplayTag ActivateFailTagsBlockedTag TryActivate failed due to being blocked by other abilities
Public variable UProperty Config FName ActivateFailTagsMissingName  
Public variable UProperty FGameplayTag ActivateFailTagsMissingTag TryActivate failed due to missing required tags
Protected variable UProperty Config bool bAllowGameplayModEvaluationChannels Whether the game should allow the usage of gameplay mod evaluation channels or not
Protected variable bool bInitialized  
Public variable UProperty Config bool bUseDebugTargetFromHud Set to true if you want the "ShowDebug AbilitySystem" cheat to use the hud's debug target instead of the ability system's debug target.
Protected variable UProperty Config EGameplayModEvaluationChannel DefaultGameplayModEvaluationChannel The default mod evaluation channel for the game
Public variable UProperty FNetSerializeScriptStructCache EffectContextStructCache  
Protected variable UProperty Config TArray< FString > GameplayCueNotifyPaths Look in these paths for GameplayCueNotifies. These are your "always loaded" set.
Protected variable UProperty Config FName[static_cast< int32 >(EGameplayModEvaluationChannel::Channel_MAX)] GameplayModEvaluationChannelAliases Game-specified named aliases for gameplay mod evaluation channels; Only those with valid aliases are eligible to be used in a game (except Channel0, which is always valid)
Protected variable UProperty TObjectPtr< UGameplayTagReponseTable > GameplayTagResponseTable  
Protected variable UProperty Config FSoftObjectPath GameplayTagResponseTableName The class to instantiate as the GameplayTagResponseTable.
Protected variable UProperty TArray< TObjectPtr< UCurveTable > > GlobalAttributeDefaultsTables Curve tables containing default values for attribute sets, keyed off of Name/Levels
Protected variable UProperty TObjectPtr< UDataTable > GlobalAttributeMetaDataTable  
Protected variable UProperty Config FSoftObjectPath GlobalAttributeMetaDataTableName Holds information about the valid attributes' min and max values and stacking rules
Protected variable UProperty Config FSoftObjectPath GlobalAttributeSetDefaultsTableName Holds default values for attribute sets, keyed off of Name/Levels.
Protected variable UProperty Config TArray< FSoftObjectPath > GlobalAttributeSetDefaultsTableNames Array of curve table names to use for default values for attribute sets, keyed off of Name/Levels
Protected variable TSharedPtr< FAttributeSetInitter > GlobalAttributeSetInitter Used to initialize attribute sets
Protected variable UProperty TObjectPtr< UCurveTable > GlobalCurveTable  
Protected variable UProperty Config FSoftObjectPath GlobalCurveTableName Name of global curve table to use as the default for scalable floats, etc.
Protected variable UProperty TObjectPtr< UGameplayCueManager > GlobalGameplayCueManager Manager for all gameplay cues
Protected variable UProperty Config FSoftObjectPath GlobalGameplayCueManagerClass Class reference to gameplay cue manager.
Protected variable UProperty Config FSoftObjectPath GlobalGameplayCueManagerName Object reference to gameplay cue manager (E.g., reference to a specific blueprint of your GameplayCueManager class. This is not necessary unless you want to have data or blueprints in your gameplay cue manager.
Public variable UProperty Config int32 MinimalReplicationTagCountBits How many bits to use for "number of tags" in FMinimalReplicationTagCountMap::NetSerialize.
Public variable FOnClientServerDebugAvailable OnClientServerDebugAvailable  
Protected variable UProperty Config bool PredictTargetGameplayEffects Set to true if you want clients to try to predict gameplay effects done to targets.
Protected variable bool RegisteredReimportCallback  
Protected variable UProperty Config bool ReplicateActivationOwnedTags Set to true if you want tags granted to owners from ability activations to be replicated.
Public variable UProperty FNetSerializeScriptStructCache TargetDataStructCache  

Constructors

  Type Name Description
Public function  

UAbilitySystemGlobals ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AddAttributeDefaultTables ( const TArray< FSoftObjectPath >& AttribDefaultTableNames
)

  
Public function Virtual void

AddGameplayCueNotifyPath ( const FString& InPath
)

 Add a path to the GameplayCueNotifyPaths array.
Public function Virtual Const FGameplayAbilityActorInfo * Should allocate a project specific AbilityActorInfo struct. Caller is responsible for deallocation
Protected function Virtual void Initialize FAttributeSetInitter.
Public function Virtual Const FGameplayEffectContext * Should allocate a project specific GameplayEffectContext struct.
Public function void  
Public function Static bool

DeriveGameplayCueTagFromAssetName ( FString AssetName,
FGameplayTag& GameplayCueTag,
FName& GameplayCueName
)

 Sets a default gameplay cue tag using the asset's name. Returns true if it changed the tag.
Public function Static void Sets a default gameplay cue tag using the asset's class
Public function Virtual void Allows projects to override PostEditChangeProeprty on GEs without having to subclass Gameplayeffect. Intended for validation/auto populating based on changed data.
Public function Static UAbilitySystemGlobals &

Get ()

 Gets the single instance of the globals object, will create it as necessary
Public function Static UAbilitySystemComponent *

GetAbilitySystemComponentFromActor ( const AActor* Actor,
bool LookForComponent
)

 Searches the passed in actor for an ability system component, will use IAbilitySystemInterface or fall back to a component search
Public function Const FAttributeSetInitter * Returns data used to initialize attributes to their default values
Public function UFunction *

GetGameplayCueFunction ( const FGameplayTag& Tag,
UClass* Class,
FName& MatchedTag
)

 Searches the passed in class to look for a UFunction implementing the gameplay cue tag, sets MatchedTag to the exact tag found
Public function Virtual UGameplayCueManager * Returns the gameplay cue manager singleton object, creating if necessary
Public function Virtual TArray< FString > Path where the engine will load gameplay cue notifies from
Public function Const const FName & Simple index-based accessor to the alias name for the specified gameplay mod evaluation channel, if any
Public function Const const FName & Simple channel-based accessor to the alias name for the specified gameplay mod evaluation channel, if any
Public function UGameplayTagReponseTable * Returns the gameplay tag response object, creating if necessary
Public function UDataTable * Returns the data table defining attribute metadata (NOTE: Currently not in use)
Public function UCurveTable * Returns the globally registered curve table
Public function Virtual void Global callback that can handle game-specific code that needs to run before applying a gameplay effect spec
Protected function void

HandlePreLoadMap ( const FWorldContext& WorldContext,
const FString& MapName
)

  
Protected function Virtual void  
Public function Virtual void Initialize GameplayCue Parameters
Public function Virtual void Initialize GameplayCue Parameters
Public function Virtual void Initialize GameplayCue Parameters
Public function Virtual void Will be called once on first use to load global data tables and tags (see FGameplayAbilitiesModule::GetAbilitySystemGlobals)
Public function Virtual void Initialize global tags by reading from config using the names and creating tags for use at runtime
Public function void  
Protected function T *

InternalGetLoadTable ( T*& Table,
FString TableName
)

  
Public function Const bool Returns true if InitGlobalData has been called
Public function Const bool Returns whether the specified gameplay mod evaluation channel is valid for use or not.
Public function Static void  
Public function Static void Helper functions for applying global scaling to various ability system tasks.
Public function void

Notify_FindAssetInEditor ( FString AssetName,
int AssetType
)

  
Public function void

Notify_OpenAssetInEditor ( FString AssetName,
int AssetType
)

 To add functionality for opening assets directly from the game.
Protected function void

OnPreBeginPIE ( const bool bIsSimulatingInEditor
)

  
Protected function void

OnTableReimported ( UObject* InObject
)

  
Public function Virtual void  
Public function Virtual void

PushCurrentAppliedGE ( const FGameplayEffectSpec* Spec,
UAbilitySystemComponent* AbilitySystemComponent
)

 Override to handle global state when gameplay effects are being applied
Protected function Virtual void  
Public function Virtual int32 Remove the given gameplay cue notify path from the GameplayCueNotifyPaths array.
Protected function void  
Public function Virtual void  
Public function Const bool Simple accessor to whether gameplay modifier evaluation channels should be allowed or not
Public function Const bool Returns true if ability cooldowns are ignored, returns false otherwise.
Public function Const bool Returns true if ability costs are ignored, returns false otherwise.
Public function Const bool Returns true if the ability system should try to predict gameplay effects applied to non local targets
Public function Const bool Returns true if tags granted to owners from ability activations should be replicated
Public function Virtual void Trigger async loading of the gameplay cue object libraries.

Typedefs

Name Description
FOnClientServerDebugAvailable Called when debug strings are available, to write them to the display

Deprecated Variables

  Type Name Description
Protected variable bool bIgnoreAbilitySystemCooldowns Use bIgnoreAbilitySystemCooldowns in the AbilitySystemGlobals namespace, controlled by new CVarAbilitySystemIgnoreCooldowns
Protected variable bool bIgnoreAbilitySystemCosts Use bIgnoreAbilitySystemCosts in the AbilitySystemGlobals namespace, controlled by new CVarAbilitySystemIgnoreCosts

Deprecated Functions

  Type Name Description
Public function void Use DebugAbilitySystemAbilityListGrantedCommand
Public function void

ServerActivatePlayerAbility ( FString AbilityNameMatch
)

 Use DebugAbilitySystemAbilityActivateCommand
Public function void

ServerCancelPlayerAbility ( FString AbilityNameMatch
)

 Use DebugAbilitySystemAbilityCancelCommand
Public function void

ServerEndPlayerAbility ( FString AbilityNameMatch
)

 Use DebugAbilitySystemAbilityCancelCommand (EndAbility is only for internal usage)
Public function Virtual void Use CVarAbilitySystemIgnoreCooldowns
Public function Virtual void Use CVarAbilitySystemIgnoreCosts

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page