EffectLib Circle

Source Code

class: Circle

Description:

This effect creates a 2D circle.

Configuration:

Overridden:

Option	Default
type	"repeating"
particle	"villager_happy"
period	2
iterations	50

Other:

Option	Description	Type	Default
orient	Whether or not to orient to the direction of the source location.	Boolean	false
xRotation/yRotation/zRotation	The rotation of the effect along its axis.	Double	0
angularVelocityX	Turns the effect by this angle each iteration around the x-axis.	Double	PI / 200
angularVelocityY	Turns the effect by this angle each iteration around the y-axis.	Double	PI / 170
angularVelocityZ	Turns the effect by this angle each iteration around the z-axis.	Double	PI / 155
radius	The radius of this sphere or circle, in blocks.	Float	0.4
maxAngle	The maximum angle of the circle. Used to make a partial circle.	Double	PI * 2
resetCircle	Start at the same location each step, use this along with maxAngle and wholeCircle to form persistent semicircles.	Boolean	false
xSubtract/ySubtract/zSubtract	Subtracts from the axis location if needed.	Double	0
enableRotation	Defines whether to rotate at all on any axis using angularVelocity_.	Boolean	true
particles	The number of particles that are displayed.	Integer	20
wholeCircle	Whether or not to make a whole circle each iteration.	Boolean	false

Example:

CircleExample:
    spell-class: ".instant.DummySpell"
    effects:
      Effect1:
        position: caster
        effect: effectlib 
        effectlib:
            class: CircleEffect
            particle: FLAME
            particles: 20
            orient: false
            xRotation: 0
            yRotation: 0
            zRotation: 0
            radius: 0.4
            resetCircle: false
            xSubtract: 0
            ySubtract: 0
            zSubtract: 0         
            enableRotation: true
            wholeCircle: false
            type: REPEATING
            period: 2
            iterations: 50