Package hm.zelha.particlesfx.particles

Class ParticleVibration

java.lang.Object

hm.zelha.particlesfx.particles.parents.Particle

hm.zelha.particlesfx.particles.parents.TravellingParticle

hm.zelha.particlesfx.particles.ParticleVibration

All Implemented Interfaces:

IParticle

public class ParticleVibration
extends TravellingParticle

Field Summary

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
ParticleVibration()
ParticleVibration(double offsetX, double offsetY, double offsetZ)
ParticleVibration(double offsetX, double offsetY, double offsetZ, int count)
ParticleVibration(int count)
ParticleVibration(org.bukkit.entity.Entity entity)
ParticleVibration(org.bukkit.entity.Entity entity, double offsetX, double offsetY, double offsetZ)
ParticleVibration(org.bukkit.entity.Entity entity, double offsetX, double offsetY, double offsetZ, int count)
ParticleVibration(org.bukkit.Location toGo)
ParticleVibration(org.bukkit.Location toGo, double offsetX, double offsetY, double offsetZ)
ParticleVibration(org.bukkit.Location toGo, double offsetX, double offsetY, double offsetZ, int count)
ParticleVibration(org.bukkit.util.Vector velocity)
ParticleVibration(org.bukkit.util.Vector velocity, double offsetX, double offsetY, double offsetZ)
ParticleVibration(org.bukkit.util.Vector velocity, double offsetX, double offsetY, double offsetZ, int count)

Method Summary

Modifier and Type	Method	Description
ParticleVibration	clone()
int	getArrivalTime()
org.bukkit.entity.Entity	getEntity()	This particle can track entities client-side, which can make for some really neat effects.
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.
ParticleVibration	inherit(Particle particle)
ParticleVibration	setArrivalTime(int arrivalTime)
ParticleVibration	setEntity(org.bukkit.entity.Entity entity)	This particle can track entities client-side, which can make for some really neat effects.

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

Constructor Details

ParticleVibration

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

ParticleVibration

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

ParticleVibration

public ParticleVibration(org.bukkit.entity.Entity entity,
 double offsetX,
 double offsetY,
 double offsetZ,
 int count)

ParticleVibration

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

ParticleVibration

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

ParticleVibration

public ParticleVibration(org.bukkit.entity.Entity entity,
 double offsetX,
 double offsetY,
 double offsetZ)

ParticleVibration

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

ParticleVibration

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

ParticleVibration

public ParticleVibration(int count)

ParticleVibration

public ParticleVibration(org.bukkit.Location toGo)

ParticleVibration

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

ParticleVibration

public ParticleVibration(org.bukkit.entity.Entity entity)

ParticleVibration

public ParticleVibration()

Method Details

inherit

public ParticleVibration inherit(Particle particle)

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 ParticleVibration clone()

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

setEntity

public ParticleVibration setEntity(org.bukkit.entity.Entity entity)

This particle can track entities client-side, which can make for some really neat effects.

Parameters:

entity - entity for this particle to track

setArrivalTime

public ParticleVibration 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.

getEntity

public org.bukkit.entity.Entity getEntity()

This particle can track entities client-side, which can make for some really neat effects.

Returns:

entity for this particle to track

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.