AdventureCore.StatEffect Class Reference

Detailed Description

an effect that modifies a stat while it is active by adding to it

https://adventure.softleitner.com/manual/effect

Inheritance diagram for AdventureCore.StatEffect:

Public Member Functions
int	Modify (AttributeStat stat, int value)
	applies the modification
Public Member Functions inherited from AdventureCore.EffectBase
void	Terminate ()
virtual void	Add (EffectBase prefab)
virtual string	GetValue ()
virtual void	SetValue (string data)
override string	ToString ()

Public Attributes
int	Priority
AttributeStat	Stat
int	Value
Public Attributes inherited from AdventureCore.GenericEffect
CharacterInstructionBase[]	Instructions
Public Attributes inherited from AdventureCore.EffectBase
EffectType	Type

Protected Member Functions
override void	Start ()
override void	OnDestroy ()

Properties
int	ModifierPriority [get]
	modifiers are applied in the order of their priority this means higher priority modifiers are applied before lower ones
IEnumerable< AttributeStat >	ModifierStats [get]
	which stats this modifier applies to
Properties inherited from AdventureCore.EffectBase
EffectPool	Pool [get, set]
bool	IsExternal [get, set]
CharacterBase	AssociatedCharacter [get]
	character that owns or is otherwise associted with the object
Properties inherited from AdventureCore.ICharacterAssociator
Properties inherited from AdventureCore.IStatModifier

Member Function Documentation

Modify()

int AdventureCore.StatEffect.Modify	(	AttributeStat	stat,
		int	value )

applies the modification

Parameters

attribute	the stat that will be modified
value	the value before modification

Returns

the modified value

Implements AdventureCore.IStatModifier.

OnDestroy()

override void AdventureCore.StatEffect.OnDestroy ( )

inlineprotectedvirtual

Reimplemented from AdventureCore.GenericEffect.

Start()

override void AdventureCore.StatEffect.Start ( )

inlineprotectedvirtual

Reimplemented from AdventureCore.GenericEffect.

Property Documentation

ModifierPriority

int AdventureCore.StatEffect.ModifierPriority

get

modifiers are applied in the order of their priority
this means higher priority modifiers are applied before lower ones

Implements AdventureCore.IStatModifier.

ModifierStats

IEnumerable<AttributeStat> AdventureCore.StatEffect.ModifierStats

get

which stats this modifier applies to

Implements AdventureCore.IStatModifier.