SPAM Framework Documentation

General ability settings

img/ability-general-settingspng

These are the topmost and general settings of all abilities.
Different ability types also have various additional settings:

See also: Ability Cooldown, Ability effects, Animations and Timings, SFX Settings, VFX Settings

Name
The name of the ability.

Description
The description of the ability.

Icon
The icon of the ability.

Ability cooldown
The cooldown of the ability.

Cooldown type
Can be set to either automatic or manual.

Automatic
The ability will enable itself and use it's own Update() loop to handle the cooldown.

Manual
You have to explicitly call Tick Cooldown(float timeToTick) to tick the cooldown. This can be useful in a turn-based game where each round ticks the cooldown of abilities.

Cast range
How far the ability can be cast from the caster. If set to 0 it can be cast at indefinite range. This value is used when checking if the given point or target is within casting range of the caster (Ability invoker).

Requires ability target
Check this is the ability requires a target IAbilityTarget to be cast. Checking this means the ability can't be cast on ground.

Telegraph
Determines when the ability should be Telegraphed.
Works out of the box if you use an event-driven Telegraph, else you'll have to code up the logic for hiding/showing the telegraph yourself.

Custom settings
Here you can assign a custom settings object that can hold ability data that's applicable to your game.

Backlinks: