SPAM Framework Documentation

Ranks

Added in version 3.0.0

Ranks, or upgrades/variants, is a feature that lets you create variations of an ability without needing to create a whole new ability. Theres no set upper limit how many ranks an ability can have, and even though they follow a numerical order (rank 1, rank 2...) you can freely change the rank of an ability at runtime making it possible to use ranks as upgrade-paths instead of levels.

Managing ranks (edit mode)

img/manage-rankspng

Adding ranks

You can add ranks to abilities by clicking the plus icon next to the last rank. This will copy the currently highest rank to the new rank. If you wish to use a specific rank as base for the new rank, you can right-click that rank and select copy to new rank.

Each rank will be displayed in the ability list. To quickly set all tabs to a specific rank, you can click the rank in the ability list.

Removing ranks

Right-click the rank you wish to remove and select "remove rank".

Ranks at runtime (play mode)

Changing rank

Call ability.IncreaseRank() or ability.SetRank(int rank).

Ability rank at start

img/start-at-rankpng
Each ability component has a dropdown where you can choose which rank an ability will start at.
You can also set the starting rank programmatically with ability.SetStartRank(int rank)

Backlinks: