Package studio.magemonkey.fabled.api.particle

Class ParticleEffect

java.lang.Object

studio.magemonkey.fabled.api.particle.ParticleEffect

All Implemented Interfaces:

IParticleEffect

public class ParticleEffect
extends Object
implements IParticleEffect

A particle effect that can be played

Constructor Summary

Constructors

Constructor	Description
ParticleEffect(String name, PolarSettings shape, PolarSettings animation, ParticleSettings particle, DirectionHandler shapeDir, DirectionHandler animDir, String size, String animSize, int interval, int viewRange, boolean withRotation, double initialRotation)

Method Summary

Modifier and Type	Method	Description
int	getInterval()
String	getName()
void	play(org.bukkit.Location loc, int frame, int level)	Plays the effect

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ParticleEffect

public ParticleEffect(String name,
 PolarSettings shape,
 PolarSettings animation,
 ParticleSettings particle,
 DirectionHandler shapeDir,
 DirectionHandler animDir,
 String size,
 String animSize,
 int interval,
 int viewRange,
 boolean withRotation,
 double initialRotation)

Parameters:

shape - shape formula details

animation - motion animation formula details

particle - settings of the particle to use

shapeDir - shape orientation

animDir - animation orientation

size - formula string for shape size

animSize - formula string for animation size

interval - time between animation frames in ticks

viewRange - range in blocks players can see the effect from

Method Details

play

public void play(org.bukkit.Location loc,
 int frame,
 int level)

Plays the effect

Specified by:

play in interface IParticleEffect

Parameters:

loc - location to play at

frame - frame of the animation to play

level - level of the effect

getName

public String getName()

Specified by:

getName in interface IParticleEffect

Returns:

name of the effect

getInterval

public int getInterval()

Specified by:

getInterval in interface IParticleEffect

Returns:

time between each frame in ticks