fr.unreal852.UnrealAPI.ParticleEffects

Class ParticleEffect.ParticleEffectPacket

java.lang.Object

fr.unreal852.UnrealAPI.ParticleEffects.ParticleEffect.ParticleEffectPacket

Enclosing class:

ParticleEffect

public static final class ParticleEffect.ParticleEffectPacket
extends java.lang.Object

Represents a particle effect packet with all attributes which is used for sending packets to the players

This class is part of the ParticleEffect Library and follows the same usage conditions

Since:

1.5

Author:

DarkBlade12

Constructor Summary

Constructors

Constructor and Description
ParticleEffect.ParticleEffectPacket(java.lang.String name, float offsetX, float offsetY, float offsetZ, float speed, int amount) Construct a new particle effect packet

Method Summary

Methods

Modifier and Type	Method and Description
static void	initialize() Initializes packetConstructor, getHandle, playerConnection and sendPacket and sets initialized to true if it succeeds Note: These fields only have to be initialized once, so it will return if initialized is already set to true
static boolean	isInitialized() Determine if packetConstructor, getHandle, playerConnection and sendPacket are initialized
void	sendTo(org.bukkit.Location center, double range) Sends the packet to all players in a certain range
void	sendTo(org.bukkit.Location center, java.util.List<org.bukkit.entity.Player> players) Sends the packet to all players in the list
void	sendTo(org.bukkit.Location center, org.bukkit.entity.Player player) Sends the packet to a single player and caches it

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticleEffect.ParticleEffectPacket

public ParticleEffect.ParticleEffectPacket(java.lang.String name,
                                   float offsetX,
                                   float offsetY,
                                   float offsetZ,
                                   float speed,
                                   int amount)
                                    throws java.lang.IllegalArgumentException

Construct a new particle effect packet

Parameters:

name - Name of the effect

offsetX - Maximum distance particles can fly away from the center on the x-axis

offsetY - Maximum distance particles can fly away from the center on the y-axis

offsetZ - Maximum distance particles can fly away from the center on the z-axis

speed - Display speed of the particles

amount - Amount of particles

Throws:

java.lang.IllegalArgumentException - If the speed is lower than 0 or the amount is lower than 1

See Also:

initialize()

Method Detail

initialize

public static void initialize()
                       throws fr.unreal852.UnrealAPI.ParticleEffects.ParticleEffect.ParticleEffectPacket.VersionIncompatibleException

Initializes packetConstructor, getHandle, playerConnection and sendPacket and sets initialized to true if it succeeds

Note: These fields only have to be initialized once, so it will return if initialized is already set to true

Throws:

VersionIncompatibleException - if accessed packets, fields or methods differ in your bukkit version

fr.unreal852.UnrealAPI.ParticleEffects.ParticleEffect.ParticleEffectPacket.VersionIncompatibleException

isInitialized

public static boolean isInitialized()

Determine if packetConstructor, getHandle, playerConnection and sendPacket are initialized

Returns:

Whether these fields are initialized or not

See Also:

initialize()

sendTo

public void sendTo(org.bukkit.Location center,
          org.bukkit.entity.Player player)
            throws fr.unreal852.UnrealAPI.ParticleEffects.ParticleEffect.ParticleEffectPacket.PacketInstantiationException,
                   fr.unreal852.UnrealAPI.ParticleEffects.ParticleEffect.ParticleEffectPacket.PacketSendingException

Sends the packet to a single player and caches it

Parameters:

center - Center location of the effect

player - Receiver of the packet

Throws:

PacketInstantiationException - if instantion fails due to an unknown error

PacketSendingException - if sending fails due to an unknown error

fr.unreal852.UnrealAPI.ParticleEffects.ParticleEffect.ParticleEffectPacket.PacketInstantiationException

fr.unreal852.UnrealAPI.ParticleEffects.ParticleEffect.ParticleEffectPacket.PacketSendingException

sendTo

public void sendTo(org.bukkit.Location center,
          java.util.List<org.bukkit.entity.Player> players)
            throws java.lang.IllegalArgumentException

Sends the packet to all players in the list

Parameters:

center - Center location of the effect

players - Receivers of the packet

Throws:

java.lang.IllegalArgumentException - If the player list is empty

See Also:

sendTo(Location center, Player player)

sendTo

public void sendTo(org.bukkit.Location center,
          double range)
            throws java.lang.IllegalArgumentException

Sends the packet to all players in a certain range

Parameters:

center - Center location of the effect

range - Range in which players will receive the packet (Maximum range for particles is usually 16, but it can differ for some types)

Throws:

java.lang.IllegalArgumentException - If the range is lower than 1

See Also:

sendTo(Location center, Player player)