Skip to content

Latest commit

 

History

History
88 lines (70 loc) · 31.6 KB

README.md

File metadata and controls

88 lines (70 loc) · 31.6 KB
description Ability effects are the components (building blocks) responsible for the behavior or all spells or attacks and can be combined together to create unique and power abilities.

Ability Effects

Properties

All ability effects share a common set of properties, listed in the table below.

Name Description
Target Options Ability effect Target Options.
Chance To Cast The percentage chance that this ability effect will be cast when called.
Effect Material Name The name of a Material Profile containing a material to use to replace the material of the target.
Material Change Duration The number of seconds the target material should be changed for, before changing the material back to the original one.
On Hit Audio Profile Names A list of Audio Profiles containing audio clips to play when the ability effect hits the target.
Random Audio Profiles If true, a random Audio Profile from the On Hit Audio Profile Names list will be played, instead of all of them.
Hit Ability Effect Names A list of other Ability Effects to cast when the current ability effect hits.
Input Multiplier All ability effects pass on information about how much damage or healing they did to the next ability effect they cast. This number will be multiplied by those amounts before adding them to the amounts of the current ability effect.
Threat Multiplier The basic threat any ability effect does will be multiplied by this amount.

Length Effect Properties

Length Effects, which are ability effects that have a duration, have the following additional properties.

Name Description
Ability Prefab Source

An enumeration that defines what sources will be used for holdable objects (visual effects).
Both
Holdable objects defined directly in the ability, and defined in the weapon will be spawned.
Ability
Only holdable objects defined in the ability will be spawned
Weapon
Only holdable objects defined in the weapon will be spawned.

Random Prefabs If true, a random prefab will be selected from the Ability Prefab Source instead of spawning all of them.
Ability Object List

A list of PrefabProfiles that contain links to GameObjects that will be spawned when the ability effect hits.
Holdable Object Name
The name of a PrefabProfile that contains a link to a GameObject.
Use Universal Attachment
If true, attachment points from the PrefabProfile will be ignored, and the universal attachment in the Attachment Name field will be used.
Attachment Name
The Node Name field from one of the Attachment Point Nodes in an Attachment Profile.

Prefab Spawn Location

An enumeration of options that define where the visual effects for this ability effect should spawn.
None
No prefabs should be spawned.
Caster
The prefabs should be spawned with the caster as their parent.
Target
The prefabs should be spawned with the target as their parent.
Ground Target
The prefabs should be spawned at the location of the ground target of the original ability, if one was used.
Original Target
The prefabs should be spawned with the original target of the ability as its parent.
Target Point
The prefab should be spawned at the location of the current target, with no parent.
Caster Point
The prefab should be spawned at the location of the caster, with no parent.

Prefab Destroy Delay The amount of time, in seconds, that visual effect prefabs should persists past the end of the ability effect before being destroyed.
Destroy On End Cast If true, the visual effect prefabs will be destroyed when casting ends, regardless of prefab lifetime.
Tick Rate The number of seconds that should pass between ticks.
Cast Zero Tick If true, a tick will happen immedialy at the start of the ability effect.
Tick Ability Effect Names A list of ability effects to cast on each tick.
On Tick Audio Profile Names a list of Audio Profiles containing audio clips which will be played on each tick.
Random Tick Audio Profiles If true, a random Audio Profile from the On Tick Audio Profile Names list will be played, instead of all of them.
Complete Ability Effect Names A list of ability effects to cast when the duration of the current ability effect is complete.

Fixed Length Effect Properties

In addition to all the properties of its parent class, Length Effect, fixed length effects have the following additional properties.

Name Description
Default Prefab Lifetime The length of time, in seconds, that any visual effect prefab should last before being destroyed.

Amount Effect Properties

In addition to all the properties of its parent class, Instant Effect, amount effects have the following additional properties.

Name Description
Allow Critical Strike If true, the amount of the effect can be increased to a critical amount, determined by the casters critical strike chance.
Resource Amounts

A list of resources to affect, and the amounts of the effects.
Resource Name
The name of a Power Resource to affect.
Input Remap
By default, any inputs that match the Resource Name will be added to the current amount. If this field is not blank, the name of the Power Resource in this field will be used for the input instead.
Add Power
If true, the appropriate power (spell / physical) will be added to this amount.
Min Amount
If the amount is lower than this value, it will be raised to this value.
Base Amount
A base amount of the effect, not scaled by level.
Amount Per Level
An amount that will be multiplied by the caster level.
Max Amount
If the amount is higher than this value, it will be lowered to this value.
Ignore Cast Time
By default, all amounts of the first effect to land are considered to be per second (DPS / HPS) and are multiplied by animation or cast time. If this value is set to true, the amount will not be normalized to the cast time.

Ignore Accuracy If true, the effect will always hit, regardless of current accuracy.

Target Options

Target options control which targets will be considered valid targets for the purpose of determining if the ability can be cast on the target.

Name Description
Require Target If true, the character must have a target selected.
Require Line Of Sight The caster requires a clear line of sight to the target.
Require Live Target The target must be alive.
Require Dead Target The target must be dead.
Can Cast On Self The ability can be cast on the caster.
Can Cast On Others The ability can be cast on targets other than the caster.
Can Cast On Enemy The ability can be cast on targets the caster has a hostile Faction relationship with.
Can Cast On Neutral The ability can be cast on targets the caster has a neutral Faction relationship with.
Can Cast On Friendly The ability can be cast on targets the caster has a friendly Faction relationship with.
Auto Self Cast If true, and the caster does not have a target, the ability effect will automatically choose the caster as the target.
Unit Type Restrictions A list of valid Unit Types the ability effect can be cast on.
Use Melee Range If true, the ability effect can only be cast on a target when that target is in the casters hit box.
Max Range If Use Melee Range is false, the ability effect will have a maximum range of this value.
Line Of Sight Source Location

When calculating line of sight, the following origin location will be used.
Caster
The line of sight will be calculated from the caster, to the current target.
Ground Target
The line of sight will be calculated from the original ground target, to the current target.
Original Target
The line of sight will be calculated from the original target, to the current target.

Target Range Source Location

When calculating the range to the target for the purpose of determining maximum range, the following source location will be used.
Caster
The target range will be calculated from the caster, to the current target.
Ground Target
The target range will be calculated from the original ground target, to the current target.
Original Target
The target range will be calculated from the original target, to the current target.

Next steps

  • Add an ability effect to an Ability.
  • Add an ability effect to another ability effect to chain them together.