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 5.3 Documentation

> Unreal Engine API Reference > Plugins > GameplayAbilities > UAbilitySystemGlobals

Light Theme

Dark Theme

UAbilitySystemGlobals

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UAbilitySystemGlobals

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Game)
class UAbilitySystemGlobals : public UObject

Remarks

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

Variables

	Name	Description
FOnAbilitySyste...	AbilityFindAssetInEditorCallbacks
FOnAbilitySyste...	AbilityOpenAssetInEditorCallbacks
TArray< FString...	AbilitySystemDebugStrings	Global place to accumulate debug strings for ability system component.
FSoftClassPath	AbilitySystemGlobalsClassName	The class to instantiate as the globals object. Defaults to this class but can be overridden
FName	ActivateFailCooldownName
FGameplayTag	ActivateFailCooldownTag	TryActivate failed due to being on cooldown
FName	ActivateFailCostName
FGameplayTag	ActivateFailCostTag	TryActivate failed due to not being able to spend costs
FName	ActivateFailIsDeadName
FGameplayTag	ActivateFailIsDeadTag	TryActivate failed due to being dead
FName	ActivateFailNetworkingName
FGameplayTag	ActivateFailNetworkingTag	Failed to activate due to invalid networking settings, this is designer error
FName	ActivateFailTagsBlockedName
FGameplayTag	ActivateFailTagsBlockedTag	TryActivate failed due to being blocked by other abilities
FName	ActivateFailTagsMissingName
FGameplayTag	ActivateFailTagsMissingTag	TryActivate failed due to missing required tags
bool	bAllowGameplayModEvaluationChannels	Whether the game should allow the usage of gameplay mod evaluation channels or not
bool	bIgnoreAbilitySystemCooldowns	If we should ignore the cooldowns when activating abilities in the ability system.
bool	bIgnoreAbilitySystemCosts	If we should ignore the costs when activating abilities in the ability system.
EGameplayModEva...	DefaultGameplayModEvaluationChannel	The default mod evaluation channel for the game
TArray< FString...	GameplayCueNotifyPaths	Look in these paths for GameplayCueNotifies. These are your "always loaded" set.
FName[static_ca...	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)
UGameplayTagRep...	GameplayTagResponseTable
FSoftObjectPath	GameplayTagResponseTableName	The class to instantiate as the GameplayTagResponseTable.
TArray< UCurveT...	GlobalAttributeDefaultsTables	Curve tables containing default values for attribute sets, keyed off of Name/Levels
UDataTable *...	GlobalAttributeMetaDataTable
FSoftObjectPath	GlobalAttributeMetaDataTableName	Holds information about the valid attributes' min and max values and stacking rules
FSoftObjectPath	GlobalAttributeSetDefaultsTableName	Holds default values for attribute sets, keyed off of Name/Levels.
TArray< FSoftOb...	GlobalAttributeSetDefaultsTableNames	Array of curve table names to use for default values for attribute sets, keyed off of Name/Levels
TSharedPtr< FAt...	GlobalAttributeSetInitter	Used to initialize attribute sets
UCurveTable ...	GlobalCurveTable
FSoftObjectPath	GlobalCurveTableName	Name of global curve table to use as the default for scalable floats, etc.
UGameplayCueMan...	GlobalGameplayCueManager	Manager for all gameplay cues
FSoftObjectPath	GlobalGameplayCueManagerClass	Class reference to gameplay cue manager.
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.
int32	MinimalReplicationTagCountBits	How many bits to use for "number of tags" in FMinimapReplicationTagCountMap::NetSerialize.
FOnClientServer...	OnClientServerDebugAvailable
bool	PredictTargetGameplayEffects	Set to true if you want clients to try to predict gameplay effects done to targets.
bool	RegisteredReimportCallback
FNetSerializeSc...	TargetDataStructCache

Constructors

	Name	Description
	UAbilitySystemGlobals ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
FGameplayAbi...	AllocAbilityActorInfo()	Should allocate a project specific AbilityActorInfo struct. Caller is responsible for deallocation
void	AllocAttributeSetInitter()	Initialize FAttributeSetInitter.
FGameplayEff...	AllocGameplayEffectContext()	Should allocate a project specific GameplayEffectContext struct.
void	AutomationTestOnly_SetGlobalAttributeDataTable ( UDataTable* InTable )
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.
void	DeriveGameplayCueTagFromClass ( T* CDO )	Sets a default gameplay cue tag using the asset's class
void	GameplayEffectPostEditChangeProperty ( UGameplayEffect* GE, FPropertyChangedEvent& PropertyCha... )	Allows projects to override PostEditChangeProeprty on GEs without having to subclass Gameplayeffect. Intended for validation/auto populating based on changed data.
UAbilitySyst...	Get()	Gets the single instance of the globals object, will create it as necessary
UAbilitySyst...	GetAbilitySystemComponentFromActor ( const AActor* Actor, bool LookForComponent )	Searches the passed in actor for an ability system component, will use the AbilitySystemInterface
FAttributeSe...	GetAttributeSetInitter()	Returns data used to initialize attributes to their default values
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
UGameplayCue...	GetGameplayCueManager()	Returns the gameplay cue manager singleton object, creating if necessary
TArray< FStr...	GetGameplayCueNotifyPaths()	Path where the engine will load gameplay cue notifies from
const FName ...	GetGameplayModEvaluationChannelAlias ( int32 Index )	Simple index-based accessor to the alias name for the specified gameplay mod evaluation channel, if any
const FName ...	GetGameplayModEvaluationChannelAlias ( EGameplayModEvaluationChannel Chann... )	Simple channel-based accessor to the alias name for the specified gameplay mod evaluation channel, if any
UGameplayTag...	GetGameplayTagResponseTable()	Returns the gameplay tag response object, creating if necessary
UDataTable &...	GetGlobalAttributeMetaDataTable()	Returns the data table defining attribute metadata ( Currently not in use)
UCurveTable ...	GetGlobalCurveTable()	Returns the globally registered curve table
void	GlobalPreGameplayEffectSpecApply ( FGameplayEffectSpec& Spec, UAbilitySystemComponent* Abili... )	Global callback that can handle game-specific code that needs to run before applying a gameplay effect spec
void	HandlePreLoadMap ( const FString& MapName )
void	InitAttributeDefaults()
void	InitGameplayCueParameters ( FGameplayCueParameters& CueParamet..., const FGameplayEffectSpecForRPC& S... )	Initialize GameplayCue Parameters
void	InitGameplayCueParameters ( FGameplayCueParameters& CueParamet..., const FGameplayEffectContextHandle ... )	Initialize GameplayCue Parameters
void	InitGameplayCueParameters_GESpec ( FGameplayCueParameters& CueParamet..., const FGameplayEffectSpec& Spec )	Initialize GameplayCue Parameters
void	InitGlobalData()	Should be called once as part of project setup to load global data tables and tags
void	InitGlobalTags()	Initialize global tags by reading from config using the names and creating tags for use at runtime
void	InitTargetDataScriptStructCache()
T *	InternalGetLoadTable ( T*& Table, FString TableName )
bool	IsAbilitySystemGlobalsInitialized()	Returns true if InitGlobalData has been called
bool	IsGameplayModEvaluationChannelValid ( EGameplayModEvaluationChannel Chann... )	Returns whether the specified gameplay mod evaluation channel is valid for use or not.
void	ListPlayerAbilities()	Show all abilities currently assigned to the local player
void	NonShipping_ApplyGlobalAbilityScaler_Duration ( float& Duration )
void	NonShipping_ApplyGlobalAbilityScaler_Rate ( float& Rate )	Helper functions for applying global scaling to various ability system tasks.
void	Notify_FindAssetInEditor ( FString AssetName, int AssetType )
void	Notify_OpenAssetInEditor ( FString AssetName, int AssetType )	To add functionality for opening assets directly from the game.
void	OnPreBeginPIE ( const bool bIsSimulatingInEditor )
void	OnTableReimported ( UObject* InObject )
void	PopCurrentAppliedGE()
void	PushCurrentAppliedGE ( const FGameplayEffectSpec* Spe..., UAbilitySystemComponent* Abili... )	Override to handle global state when gameplay effects are being applied
void	ReloadAttributeDefaults()
void	ResetCachedData()
void	ServerActivatePlayerAbility ( FString AbilityNameMatch )	Force server activation of a specific player ability (useful for cheat testing)
void	ServerCancelPlayerAbility ( FString AbilityNameMatch )	Force server cancellation of a specific player ability (useful for cheat testing)
void	ServerEndPlayerAbility ( FString AbilityNameMatch )	Force server deactivation of a specific player ability (useful for cheat testing)
void	SetCurrentAppliedGE ( const FGameplayEffectSpec* Spe... )
bool	ShouldAllowGameplayModEvaluationChannels()	Simple accessor to whether gameplay modifier evaluation channels should be allowed or not
bool	ShouldIgnoreCooldowns()	Returns true if ability cooldowns are ignored, returns false otherwise.
bool	ShouldIgnoreCosts()	Returns true if ability costs are ignored, returns false otherwise.
bool	ShouldPredictTargetGameplayEffects()	Returns true if the ability system should try to predict gameplay effects applied to non local targets
void	StartAsyncLoadingObjectLibraries()	Trigger async loading of the gameplay cue object libraries.
void	ToggleIgnoreAbilitySystemCooldowns()	Toggles whether we should ignore ability cooldowns. Does nothing in shipping builds
void	ToggleIgnoreAbilitySystemCosts()	Toggles whether we should ignore ability costs. Does nothing in shipping builds

Typedefs

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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss