Loading...
Searching...
No Matches
AdventureCore.AttributeEffect Class Reference

Detailed Description

an effect that modifies an attribute while it is active by adding to it

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

Inheritance diagram for AdventureCore.AttributeEffect:
AdventureCore.GenericEffect AdventureCore.IAttributeModifier AdventureCore.EffectBase AdventureCore.ICharacterAssociator

Public Member Functions

int Modify (AttributeType attribute, 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
 
AttributeType Attribute
 
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< AttributeTypeModifierAttributes [get]
 which attributes 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.IAttributeModifier

Member Function Documentation

◆ Modify()

int AdventureCore.AttributeEffect.Modify ( AttributeType attribute,
int value )

applies the modification

Parameters
attributethe attribute that will be modified
valuethe value before modification
Returns
the modified value

Implements AdventureCore.IAttributeModifier.

◆ OnDestroy()

override void AdventureCore.AttributeEffect.OnDestroy ( )
inlineprotectedvirtual

Reimplemented from AdventureCore.GenericEffect.

◆ Start()

override void AdventureCore.AttributeEffect.Start ( )
inlineprotectedvirtual

Reimplemented from AdventureCore.GenericEffect.

Property Documentation

◆ ModifierAttributes

IEnumerable<AttributeType> AdventureCore.AttributeEffect.ModifierAttributes
get

which attributes this modifier applies to

Implements AdventureCore.IAttributeModifier.

◆ ModifierPriority

int AdventureCore.AttributeEffect.ModifierPriority
get

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

Implements AdventureCore.IAttributeModifier.