Skip to content

EffectLibParameters

Nathan Wolf edited this page Jun 15, 2017 · 6 revisions

EffectLib effects can be used via an "effectlib" block. The only required parameter in this block is "class", referring to an EffectLib class.

You can use the "fxdemo" spell in-game to preview all of the available effects, or just browse through the doxygen documentation.

Each effect has its own set of parameters. There are a few common ones:

Common parameters

Name Values Description
class Effect Class The EffectLib class name to use. The "Effect" portion may be omitted.
duration Milliseconds How long this effect should last
period #Ticks How often this effect should run (1 = every tick)
iterations Count How many times this effect should run. Controlled automatically by duration/period
type repeating, instant, delayed The type of effect - most default to repeating
delay #Ticks How long to delay before playing the effect

Examples

   effects:
      cast:
      - location: target
        effectlib:
          class: AnimatedBall
          duration: 5000

Specific Effect Parameters

You will have to browse the source codeor doxygen docs for now to see individual effect parameters. It is pretty well documented there.

Clone this wiki locally