forked from nisovin/MagicSpells
-
Notifications
You must be signed in to change notification settings - Fork 68
Buff Spell
JasperLorelai edited this page Jul 26, 2023
·
19 revisions
Option | Description | Variable Type | Default |
---|---|---|---|
targeted |
Defines if this spell should become a targeted spell (it will accept Targeted Spell Configuration options). For versions below MS 4.0 this option will not be able to target entities other than players. | Boolean | false |
toggle |
Defines whether the spell can be deactivated while it's still active. It will only apply cooldown when its duration fades. | Boolean | true |
duration |
Buff spell duration specified in seconds before the buff expires. Set to 0 do define an infinite duration. | Float | 0 |
power-affects-duration |
Defines whether Spell Power can affect the duration of the spell. | Boolean | true |
cancel-on-give-damage |
Defines whether the buff spell will cancel if the caster deals damage to another entity. | Boolean | false |
cancel-on-take-damage |
Defines whether the buff spell will cancel if the caster receives damage. | Boolean | false |
cancel-on-death |
Defines whether the buff spell will cancel if the caster dies. | Boolean | false |
cancel-on-teleport |
Defines whether the buff spell will cancel if the server emits a teleport event for the caster. | Boolean | false |
cancel-on-change-world |
Defines whether the buff spell will cancel if the caster switches worlds. | Boolean | false |
cancel-on-spell-cast |
Defines whether the buff spell will cancel if the caster casts a spell. | Boolean | false |
cancel-on-logout |
Defines whether the buff spell will cancel if the caster leaves the game. | Boolean | false |
spell-on-end |
Sub-spell that will be casted whenever the buff spell reaches the end of its duration. | String | null |
spell-on-cost |
Sub-spell that will be casted whenever the buff spell tries to charge cost. | String | null |
Most buff spells have special events which define when a buff Use happened. Some buffs, like DummySpell
, don't. The below options can be used to configure how buff uses behave. You can use Uses, for example, to make the buff last forever (duration: 0
), but end after it depletes its uses.
Option | Description | Variable Type | Default Value |
---|---|---|---|
use-cost |
A string list of reagent costs (check general spell configuration for costs ) required for the buff to remain active. The cost will be charged only when the buff spell's Uses is incremented. |
String List | null |
use-cost-interval |
Interval defines after how many Uses the spell can charge use-cost . |
Integer | 0 |
num-uses |
Number of Uses before the buff spell expires. | Integer | 0 |
spell-on-use-increment |
Sub-spell that will be casted whenever the buff spell Uses have been incremented (depends on the buff spell type). This spell will be casted once even if num-uses is set to 0. |
String | null |