Bending Stamina - Simplicitee/BendingStamina GitHub Wiki

Bending Stamina Effects

Bending Stamina has several ways in which abilities can affect a user's stamina. Most of the core abilities have default effects and values that can be modified to do whatever. All abilities (including addons) will be in the config with base values but some have not been set to specific values.

The different effects bending abilities can have on stamina are USE, CONTINUOUS_USE, DECREASE_MAX, DECREASE_RECHARGE, NONE, INCREASE_MAX, and INCREASE_RECHARGE. Each is explained in depth below.

USE Effect

The ability will attempt to use the specified amount of stamina (value in config) to perform the ability. If the user doesn't have enough stamina, the action will be canceled (ability not used). This is a one-time use when the player starts to use the ability.

CONTINUOUS_USE Effect

The ability will attempt to use the specified amount of stamina to perform the ability for every second it runs. If the user runs out of stamina while using the ability, it is ended.

DECREASE_MAX Effect

Decreases the player's maximum amount of stamina while using the ability. Maximum stamina is returned to what it was before using the ability when the ability ends

DECREASE_RECHARGE Effect

Decreases the rate at which the user's stamina is restored. The value for such abilities should be a fraction of the base recharge rate. Otherwise, problems may occur. The recharge rate is returned to what it was before using the ability when the ability ends.

NONE Effect

Denotes that the ability has no effect on stamina. The value for abilities with this effect does not matter, but I would suggest setting it to 0 in keeping with conventions.

INCREASE_MAX Effect

Increases the player's maximum amount of stamina while using the ability. Maximum stamina is returned to what it was before using the ability when the ability ends

INCREASE_RECHARGE Effect

Increases the rate at which the user's stamina is restored. The recharge rate is returned to what it was before using the ability when the ability ends.