Create an Effect

Effect Creation

To create an Effect, you can either create a ScriptableObject asset in your project or implement your own custom Effect by inheriting from the appropriate class. Just like action state, effect themselves don't do anything, you need to add Effect Component to make them impact gameplay.

Create an Effect via ScriptableObject

Using ScriptableObjects is preferred for prototyping and designing game logic. You can find many mods, such as Add Effect or Add Effect On Hit, created this way. Attack with hitbox also can use effect directly from scrtipable object.

Once created an effect, you will see this

MainTags: character owning this effect will have those tag as long as this effect stays

InfoTags: for Effect Components to communicate

Applied Time, Source, Target: will automaically been set in the process

To add an Effect Component, you select the type in dropdown first, then click the add button

Current Effect Component we provided

EffectModValue: modify the value of an Attribute in different ways. This can be used for damage, but also used for something like speed control.

EffectLifeControl: how long will the effect stay on a character

EffectKnockBack: the target of this effect will be knocked backed, if that's a character

EffectHitboxInfo: Hitbox will add this to damage effect inorder to pass some extra information

EffectHoldLaw: this effect will contains extra attributelaw, we will talked about attribute law latter.

Create Effect via Factory

Some scripts, like Attack with Hitbox, can get effect from factory:

All subclass of EffectFactory will be in the list

As you selected the Factory, some property of Effect generation will be exposed to you

By this, you don't need to create tons of scriptable object for different attacks. You simply record the data here and an Effect with all thos setting will be created in run time.

How Effect Factory Looks like in code

We encourgae you to use Factory for some script that want to apply effects dynamically. You can also write your own Factory by overriding the orignal abstract class.