Package hm.zelha.particlesfx.particles

Class ParticleTrail

java.lang.Object

hm.zelha.particlesfx.particles.parents.Particle

hm.zelha.particlesfx.particles.parents.TravellingParticle

hm.zelha.particlesfx.particles.ParticleTrail

All Implemented Interfaces:

ColorableParticle, IParticle

public class ParticleTrail
extends TravellingParticle
implements ColorableParticle

Field Summary

Fields

Modifier and Type	Field	Description
protected Color	color

Fields inherited from class hm.zelha.particlesfx.particles.parents.TravellingParticle

control, inverse, toGo, velocity

Fields inherited from class hm.zelha.particlesfx.particles.parents.Particle

count, fakeOffsetHelper, offsetHelper, offsetX, offsetY, offsetZ, particle, radius, rng, speed, xyzHelper

Constructor Summary

Constructors

Constructor	Description
ParticleTrail()
ParticleTrail(double offsetX, double offsetY, double offsetZ)
ParticleTrail(double offsetX, double offsetY, double offsetZ, int count)
ParticleTrail(int count)
ParticleTrail(Color color)
ParticleTrail(Color color, double offsetX, double offsetY, double offsetZ)
ParticleTrail(Color color, double offsetX, double offsetY, double offsetZ, int count)
ParticleTrail(Color color, org.bukkit.Location toGo)
ParticleTrail(Color color, org.bukkit.Location toGo, double offsetX, double offsetY, double offsetZ)
ParticleTrail(Color color, org.bukkit.Location toGo, double offsetX, double offsetY, double offsetZ, int count)
ParticleTrail(Color color, org.bukkit.util.Vector velocity)
ParticleTrail(Color color, org.bukkit.util.Vector velocity, double offsetX, double offsetY, double offsetZ)
ParticleTrail(Color color, org.bukkit.util.Vector velocity, double offsetX, double offsetY, double offsetZ, int count)
ParticleTrail(org.bukkit.Location toGo)
ParticleTrail(org.bukkit.Location toGo, double offsetX, double offsetY, double offsetZ)
ParticleTrail(org.bukkit.Location toGo, double offsetX, double offsetY, double offsetZ, int count)
ParticleTrail(org.bukkit.util.Vector velocity)
ParticleTrail(org.bukkit.util.Vector velocity, double offsetX, double offsetY, double offsetZ)
ParticleTrail(org.bukkit.util.Vector velocity, double offsetX, double offsetY, double offsetZ, int count)

Method Summary

Modifier and Type	Method	Description
ParticleTrail	clone()
int	getArrivalTime()
Color	getColor()	nullable to allow for randomly colored particles without being complicated
protected org.bukkit.util.Vector	getOffsets(org.bukkit.Location location)	Meant to be overridden by child classes to modify the offset values of the packet sent to the player.
protected int	getPacketCount()	Meant to be overridden by child classes to modify the count value of the packet sent to the player.
protected net.minecraft.network.protocol.Packet	getStrangePacket(org.bukkit.Location location)	Meant to be overridden by child classes when a different packet is needed to display the particle.
protected org.bukkit.util.Vector	getXYZ(org.bukkit.Location location)	Meant to be overridden by child classes to modify the X/Y/Z values of the packet sent to the player.
ParticleTrail	inherit(Particle particle)
ParticleTrail	setArrivalTime(int arrivalTime)
void	setColor(int red, int green, int blue)
void	setColor(Color color)

Methods inherited from class hm.zelha.particlesfx.particles.parents.TravellingParticle

display, display, displayForPlayers, displayForPlayers, getLocationToGo, getPacketSpeed, getVelocity, setLocationToGo, setLocationToGo, setVelocity, setVelocity

Methods inherited from class hm.zelha.particlesfx.particles.parents.Particle

display, display, displayForPlayers, displayForPlayers, generateFakeOffset, getCount, getOffsetX, getOffsetY, getOffsetZ, getRadius, getSpeed, setCount, setOffset, setOffsetX, setOffsetY, setOffsetZ, setRadius, setSpeed

Methods inherited from class java.lang.Object

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

Methods inherited from interface hm.zelha.particlesfx.particles.parents.IParticle

display, displayForPlayers, displayForPlayers, getCount, getOffsetX, getOffsetY, getOffsetZ, getRadius, getSpeed, setCount, setOffset, setOffsetX, setOffsetY, setOffsetZ, setRadius, setSpeed

Field Details

color

protected Color color

Constructor Details

ParticleTrail

public ParticleTrail(Color color,
 org.bukkit.Location toGo,
 double offsetX,
 double offsetY,
 double offsetZ,
 int count)

ParticleTrail

public ParticleTrail(Color color,
 org.bukkit.util.Vector velocity,
 double offsetX,
 double offsetY,
 double offsetZ,
 int count)

ParticleTrail

public ParticleTrail(org.bukkit.Location toGo,
 double offsetX,
 double offsetY,
 double offsetZ,
 int count)

ParticleTrail

public ParticleTrail(org.bukkit.util.Vector velocity,
 double offsetX,
 double offsetY,
 double offsetZ,
 int count)

ParticleTrail

public ParticleTrail(Color color,
 double offsetX,
 double offsetY,
 double offsetZ,
 int count)

ParticleTrail

public ParticleTrail(Color color,
 org.bukkit.Location toGo,
 double offsetX,
 double offsetY,
 double offsetZ)

ParticleTrail

public ParticleTrail(Color color,
 org.bukkit.util.Vector velocity,
 double offsetX,
 double offsetY,
 double offsetZ)

ParticleTrail

public ParticleTrail(org.bukkit.Location toGo,
 double offsetX,
 double offsetY,
 double offsetZ)

ParticleTrail

public ParticleTrail(org.bukkit.util.Vector velocity,
 double offsetX,
 double offsetY,
 double offsetZ)

ParticleTrail

public ParticleTrail(Color color,
 double offsetX,
 double offsetY,
 double offsetZ)

ParticleTrail

public ParticleTrail(double offsetX,
 double offsetY,
 double offsetZ,
 int count)

ParticleTrail

public ParticleTrail(Color color,
 org.bukkit.Location toGo)

ParticleTrail

public ParticleTrail(Color color,
 org.bukkit.util.Vector velocity)

ParticleTrail

public ParticleTrail(org.bukkit.Location toGo)

ParticleTrail

public ParticleTrail(org.bukkit.util.Vector velocity)

ParticleTrail

public ParticleTrail(Color color)

ParticleTrail

public ParticleTrail(double offsetX,
 double offsetY,
 double offsetZ)

ParticleTrail

public ParticleTrail(int count)

ParticleTrail

public ParticleTrail()

Method Details

inherit

public ParticleTrail inherit(Particle particle)

Specified by:

inherit in interface ColorableParticle

Specified by:

inherit in interface IParticle

Overrides:

inherit in class TravellingParticle

Parameters:

particle - particle for this object to copy data from

Returns:

this object

clone

public ParticleTrail clone()

Specified by:

clone in interface ColorableParticle

Specified by:

clone in interface IParticle

Specified by:

clone in class TravellingParticle

getXYZ

protected org.bukkit.util.Vector getXYZ(org.bukkit.Location location)

Description copied from class: Particle

Meant to be overridden by child classes to modify the X/Y/Z values of the packet sent to the player.

Overrides:

getXYZ in class TravellingParticle

Parameters:

location - the location passed into the display method

Returns:

the xyzHelper with the modified X/Y/Z values

getOffsets

protected org.bukkit.util.Vector getOffsets(org.bukkit.Location location)

Description copied from class: Particle

Meant to be overridden by child classes to modify the offset values of the packet sent to the player.

Overrides:

getOffsets in class TravellingParticle

Parameters:

location - the location passed into the display method

Returns:

the offsetHelper with the modified offset values

getPacketCount

protected int getPacketCount()

Description copied from class: Particle

Meant to be overridden by child classes to modify the count value of the packet sent to the player.

Overrides:

getPacketCount in class TravellingParticle

Returns:

the modified count value

getStrangePacket

protected net.minecraft.network.protocol.Packet getStrangePacket(org.bukkit.Location location)

Description copied from class: Particle

Meant to be overridden by child classes when a different packet is needed to display the particle.

Overrides:

getStrangePacket in class Particle

Parameters:

location - the location passed into the display method

Returns:

the different packet

setColor

public void setColor(@Nullable
 Color color)

Specified by:

setColor in interface ColorableParticle

Parameters:

color - color to set, null if you want random coloring

setColor

public void setColor(int red,
 int green,
 int blue)

Specified by:

setColor in interface ColorableParticle

setArrivalTime

public ParticleTrail setArrivalTime(int arrivalTime)

Parameters:

arrivalTime - the amount of ticks it takes this particle to go from its origin to its destination, default 20 ticks or 1 second.

getColor

@Nullable
public Color getColor()

Description copied from interface: ColorableParticle

nullable to allow for randomly colored particles without being complicated

Specified by:

getColor in interface ColorableParticle

Returns:

color this particle is using

getArrivalTime

public int getArrivalTime()

Returns:

the amount of ticks it takes this particle to go from its origin to its destination, default 20 ticks or 1 second.