StatModifier Class Reference

Detailed Description

StatModifiers are a variable type that can be used by abilities to modify player stats (see PlayerStat, StatsAE, and PlayerStatHolder). This class does not inhert from monobehavior, so it does not have access to unity functions such as Start() or Update().

Documentation updated 9/1/2024

Author

Roy Pascual

Public Member Functions
	StatModifier (float modValue)
	Constructor (function the automatically runs when a new StatModifier is created in another script). Initializes mod value to the given value.

Properties
string	TargetStat [get, set]
	Public version of _targetStat that can be used by scripts.
float	ModValue [get, set]
	Public version of _modValue that can be used by scripts.

Private Attributes
string	_targetStat
	Name of the stat that this modifier targets. Can be changed in the Unity Editor.
float	_modValue
	Amount that this stat modifier will change the target stat by. Can be changed in the Unity Editor.

Constructor & Destructor Documentation

StatModifier()

StatModifier.StatModifier

(

float

modValue

)

Constructor (function the automatically runs when a new StatModifier is created in another script). Initializes mod value to the given value.

Member Data Documentation

_modValue

float StatModifier._modValue

private

Amount that this stat modifier will change the target stat by. Can be changed in the Unity Editor.

_targetStat

string StatModifier._targetStat

private

Name of the stat that this modifier targets. Can be changed in the Unity Editor.

Property Documentation

ModValue

float StatModifier.ModValue

getset

Public version of _modValue that can be used by scripts.

TargetStat

string StatModifier.TargetStat

getset

Public version of _targetStat that can be used by scripts.

---

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

• Assets/Scripts/Player/StatModifier.cs