UGE_ModMagnitudeCalculation_BaseRecoverBySleeping Class Reference

Base class for "Recover by sleeping" modifier calculations. The attribute capture definitions must be setup in the constructor/default sections of child classes. The recovery gain per application is computed as RecoveryRatePerHour * SleepTimeInHours * MaxAttributeValue. More...

Public Member Functions
Functions
void	InitRecoveryRatePerHourOfSleepAttributeToCapture (FGameplayAttribute attribute)
	Sets the "recovery rate per hour of sleep" attribute to capture. Must be called from the default section of the AS child class.
void	InitMaxValueAttributeToCapture (FGameplayAttribute attribute)
	Sets the "max value" attribute to capture. Must be called from the default section of the AS child class.
Public Member Functions inherited from UGE_ModMagnitudeCalculationBase
FGameplayAttribute	GetAttribute (TSubclassOf< UAttributeSet > AttributeSetClass, FName AttributeName)
	Gets a gameplay attribute.
Public Member Functions inherited from UGameplayModMagnitudeCalculation
const FGameplayTagContainer &	GetSourceSpecTags (FGameplayEffectSpec EffectSpec) const
	Returns the source spec tags from a Gameplay Effect Spec.
float32	GetSetByCallerMagnitudeByName (FGameplayEffectSpec EffectSpec, FName MagnitudeName) const
	Extracts the Set by Caller Magnitude from a Gameplay Effect Spec.
float32	GetSetByCallerMagnitudeByTag (FGameplayEffectSpec EffectSpec, FGameplayTag Tag) const
	Extracts the Set by Caller Magnitude from a Gameplay Effect Spec.
const FGameplayTagContainer &	GetSourceActorTags (FGameplayEffectSpec EffectSpec) const
	Returns the source actor tags from a Gameplay Effect Spec.
FGameplayTagContainer	GetSourceAggregatedTags (FGameplayEffectSpec EffectSpec) const
	Copies and returns the source aggregated tags from a Gameplay Effect Spec.
const FGameplayTagContainer &	GetTargetActorTags (FGameplayEffectSpec EffectSpec) const
	Returns the target actor tags from a Gameplay Effect Spec Useful for Modifier Magnitude Calculations.
FGameplayTagContainer	GetTargetAggregatedTags (FGameplayEffectSpec EffectSpec) const
	Copies and returns the target aggregated tags from a Gameplay Effect Spec.
const FGameplayTagContainer &	GetTargetSpecTags (FGameplayEffectSpec EffectSpec) const
	Returns the target spec tags from a Gameplay Effect Spec Useful for Modifier Magnitude Calculations.
float32	GetCapturedAttributeMagnitude (FGameplayEffectSpec EffectSpec, FGameplayAttribute Attribute, FGameplayTagContainer SourceTags, FGameplayTagContainer TargetTags) const
	Gets the captured magnitude value for the given Attribute For this to work correctly, the Attribute needs to be added to the Relevant Attributes to Capture array.
float32	CalculateBaseMagnitude (FGameplayEffectSpec Spec) const
	Calculate the base magnitude of the gameplay effect modifier, given the specified spec. Note that the owning spec def can still modify this base value with a coeffecient and pre/post multiply adds. see FCustomCalculationBasedFloat::CalculateMagnitude for details.
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const

Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from UGE_ModMagnitudeCalculationBase
static UClass	StaticClass ()
Static Public Member Functions inherited from UGameplayModMagnitudeCalculation
static UClass	StaticClass ()
Static Public Member Functions inherited from UGameplayEffectCalculation
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Additional Inherited Members
Public Attributes inherited from UGameplayModMagnitudeCalculation
bool	bAllowNonNetAuthorityDependencyRegistration
	Whether the calculation allows non-net authorities to register the external dependency multi-cast delegate or not; Effectively whether clients are allowed to perform the custom calculation themselves or not.
Public Attributes inherited from UGameplayEffectCalculation
TArray< FGameplayEffectAttributeCaptureDefinition >	RelevantAttributesToCapture
	Attributes to capture that are relevant to the calculation.
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Detailed Description

Base class for "Recover by sleeping" modifier calculations. The attribute capture definitions must be setup in the constructor/default sections of child classes. The recovery gain per application is computed as RecoveryRatePerHour * SleepTimeInHours * MaxAttributeValue.

Member Function Documentation

InitMaxValueAttributeToCapture()

void InitMaxValueAttributeToCapture

(

FGameplayAttribute

attribute

)

Sets the "max value" attribute to capture. Must be called from the default section of the AS child class.

InitRecoveryRatePerHourOfSleepAttributeToCapture()

void InitRecoveryRatePerHourOfSleepAttributeToCapture

(

FGameplayAttribute

attribute

)

Sets the "recovery rate per hour of sleep" attribute to capture. Must be called from the default section of the AS child class.

StaticClass()

UClass StaticClass ( )

static