StatsAE Class Reference

Detailed Description

Allows an ability to apply a stat change to the player (see PlayerStat, StatModifier, and PlayerStatHolder). Which stat to change and by how much can be changed in the editor. Examples of StatsAE scriptable objects can be found here: Ability Effect.

Documentation updated 8/13/2024

Author

Roy Pascual

Note

This is a scriptable object, meaning you can make an instance of it in the Unity Editor that exists in the file explorer.

Public Member Functions
override void	Apply (AbilityOwner abilityOwner)
	Get player stats holder and add statMod to it. Then invoke the health change.
override void	Disable (AbilityOwner abilityOwner)
	Get player stats holder and remove statMod from it. Then invoke the health change.
Public Member Functions inherited from AbilityEffect
void	Apply (AbilityOwner abilityOwner)
	Run by the ability info object when the ability is activated. Must be filled in to instantiate.

Public Attributes
StatModifier	statMod
	Reference to the stat modifier we want to use.

Private Member Functions
void	Awake ()
	Set AbilityEffectType to Immediate.

Additional Inherited Members
Properties inherited from AbilityEffect
AbilityEffectType	AbilityEffectType [get, set]
	Determines how the effect should be applied.

Member Function Documentation

Apply()

override void StatsAE.Apply

(

AbilityOwner

abilityOwner

)

Get player stats holder and add statMod to it. Then invoke the health change.

Parameters

abilityOwner

Awake()

void StatsAE.Awake ( )

private

Set AbilityEffectType to Immediate.

Disable()

override void StatsAE.Disable ( AbilityOwner abilityOwner )

virtual

Get player stats holder and remove statMod from it. Then invoke the health change.

Parameters

abilityOwner

Reimplemented from AbilityEffect.

Member Data Documentation

statMod

StatModifier StatsAE.statMod

Reference to the stat modifier we want to use.

---

The documentation for this class was generated from the following file:

• Assets/Scripts/Abilities/AbilityEffects/StatsAE.cs