com.github.fierioziy.particlenativeapi.api.types

Class ParticleTypeVibration

java.lang.Object

com.github.fierioziy.particlenativeapi.api.types.ParticleTypeVibration

public class ParticleTypeVibration
extends Object

Class used to represent vibration particle type.

It provides a non-reflective packet method overloads to construct particle packet with desired parameters.

All packet methods does not validate parameters in any way.

Constructor Summary

Constructors

Constructor and Description
ParticleTypeVibration()

Method Summary

Modifier and Type	Method and Description
boolean	isValid() Checks if this particle is supported by this Spigot version.
Object	packet(boolean far, double x, double y, double z, double targetX, double targetY, double targetZ, int ticks) Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.
Object	packet(boolean far, org.bukkit.Location loc, org.bukkit.Location target, int ticks) Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.
Object	packet(boolean far, org.bukkit.Location loc, org.bukkit.util.Vector target, int ticks) Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.
Object	packet(boolean far, org.bukkit.util.Vector loc, org.bukkit.Location target, int ticks) Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.
Object	packet(boolean far, org.bukkit.util.Vector loc, org.bukkit.util.Vector target, int ticks) Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticleTypeVibration

public ParticleTypeVibration()

Method Detail

packet

public Object packet(boolean far,
                     org.bukkit.Location loc,
                     org.bukkit.Location target,
                     int ticks)

Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.

Currently, positions are aligned to block centers.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

loc - a Location containing position.

target - a Location containing target position.

ticks - flight duration (in ticks).

Returns:

a valid NMS Packet object.

Throws:

ParticleException - when requested particle type is not supported by this server version.

packet

public Object packet(boolean far,
                     org.bukkit.Location loc,
                     org.bukkit.util.Vector target,
                     int ticks)

Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.

Currently, positions are aligned to block centers.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

loc - a Location containing position.

target - a Vector containing target position.

ticks - flight duration (in ticks).

Returns:

a valid NMS Packet object.

Throws:

ParticleException - when requested particle type is not supported by this server version.

packet

public Object packet(boolean far,
                     org.bukkit.util.Vector loc,
                     org.bukkit.Location target,
                     int ticks)

Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.

Currently, positions are aligned to block centers.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

loc - a Vector containing position.

target - a Location containing target position.

ticks - flight duration (in ticks).

Returns:

a valid NMS Packet object.

Throws:

ParticleException - when requested particle type is not supported by this server version.

packet

public Object packet(boolean far,
                     org.bukkit.util.Vector loc,
                     org.bukkit.util.Vector target,
                     int ticks)

Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.

Currently, positions are aligned to block centers.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

loc - a Vector containing position.

target - a Vector containing target position.

ticks - flight duration (in ticks).

Returns:

a valid NMS Packet object.

Throws:

ParticleException - when requested particle type is not supported by this server version.

packet

public Object packet(boolean far,
                     double x,
                     double y,
                     double z,
                     double targetX,
                     double targetY,
                     double targetZ,
                     int ticks)

Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.

Currently, positions are aligned to block centers.

Parameters are not validated in any way.

This method is overridden by dynamically generated subclasses.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

x - component of a position.

y - component of a position.

z - component of a position.

targetX - component of a target position.

targetY - component of a target position.

targetZ - component of a target position.

ticks - flight duration (in ticks).

Returns:

a valid NMS Packet object.

Throws:

ParticleException - when requested particle type is not supported by this server version.

isValid

public boolean isValid()

Checks if this particle is supported by this Spigot version.

This method is overridden by dynamically generated subclasses.

Returns:

true if this particle is supported by this Spigot version, false otherwise.