BuffAE Class Reference

Detailed Description

Allows an ability to apply a permanent stat increase to the player. Right now, this script only supports increasing the player's max health.

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)
	Instantly heal the player by the buffValue.
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.
virtual void	Disable (AbilityOwner abilityOwner)
	Run by the ability info object when the ability is deactivated. Doesn’t have to be filled in to instantiate.

Public Attributes
int	buffValue
	The amount the player’s health should be buffed by.

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

Private Attributes
PlayerHealth	playerHealth
	Reference to the player’s health.

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

Member Function Documentation

Apply()

override void BuffAE.Apply

(

AbilityOwner

abilityOwner

)

Instantly heal the player by the buffValue.

Parameters

abilityOwner

Awake()

void BuffAE.Awake ( )

private

Set AbilityEffectType to continuous.

Member Data Documentation

buffValue

int BuffAE.buffValue

The amount the player’s health should be buffed by.

playerHealth

PlayerHealth BuffAE.playerHealth

private

Reference to the player’s health.

---

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

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