- * This library was created by @DarkBlade12 based on content related to particles of @microgeek (names and packet parameters), it allows you to display all Minecraft particle effects on a Bukkit server + * This library was created by @DarkBlade12 and allows you to display all Minecraft particle effects on a Bukkit server *
* You are welcome to use it, modify it and redistribute it under the following conditions: *
+ * Special thanks: + *
* It would be nice if you provide credit to me if you use this class in a published project * * @author DarkBlade12 - * @version 1.5 + * @version 1.6 */ public enum ParticleEffect { - /** - * A particle effect which is displayed by exploding tnt and creepers: - *
false
*
* @param name Name of this particle effect
- * @see #ParticleEffect(String, boolean)
+ * @param id Id of this particle effect
+ * @param requiredVersion Version which is required (1.x)
+ * @param requiresData Indicates whether additional data is required for this particle effect
+ * @see #ParticleEffect(String, int, boolean, boolean)
*/
- private ParticleEffect(String name) {
- this(name, false);
+ private ParticleEffect(String name, int id, int requiredVersion, boolean requiresData) {
+ this(name, id, requiredVersion, requiresData, false);
+ }
+
+ /**
+ * Construct a new particle effect with {@link #requiresData} and {@link #requiresWater} set to false
+ *
+ * @param name Name of this particle effect
+ * @param id Id of this particle effect
+ * @param requiredVersion Version which is required (1.x)
+ * @param requiresData Indicates whether additional data is required for this particle effect
+ * @see #ParticleEffect(String, int, boolean)
+ */
+ private ParticleEffect(String name, int id, int requiredVersion) {
+ this(name, id, requiredVersion, false);
}
/**
@@ -356,6 +445,33 @@ public enum ParticleEffect {
return name;
}
+ /**
+ * Returns the id of this particle effect
+ *
+ * @return The id
+ */
+ public int getId() {
+ return id;
+ }
+
+ /**
+ * Returns the required version for this particle effect (1.x)
+ *
+ * @return The required version
+ */
+ public int getRequiredVersion() {
+ return requiredVersion;
+ }
+
+ /**
+ * Determine if additional data is required for this particle effect
+ *
+ * @return Whether additional data is required or not
+ */
+ public boolean getRequiresData() {
+ return requiresData;
+ }
+
/**
* Determine if water is required for this particle effect to display properly
*
@@ -365,6 +481,18 @@ public enum ParticleEffect {
return requiresWater;
}
+ /**
+ * Determine if this particle effect is supported by your current server version
+ *
+ * @return Whether the particle effect is supported or not
+ */
+ public boolean isSupported() {
+ if (requiredVersion == -1) {
+ return true;
+ }
+ return ParticlePacket.getVersion() >= requiredVersion;
+ }
+
/**
* Returns the particle effect with the given name
*
@@ -381,6 +509,22 @@ public enum ParticleEffect {
return null;
}
+ /**
+ * Returns the particle effect with the given id
+ *
+ * @param id Id of the particle effect
+ * @return The particle effect
+ */
+ public static ParticleEffect fromId(int id) {
+ for (Entry+ * This class is part of the ParticleEffect Library and follows the same usage conditions * - * @param id Id of the block - * @param data Data value - * @param offsetX Maximum distance particles can fly away from the center on the x-axis - * @param offsetY Maximum distance particles can fly away from the center on the y-axis - * @param offsetZ Maximum distance particles can fly away from the center on the z-axis - * @param speed Display speed of the particles - * @param amount Amount of particles - * @param center Center location of the effect - * @param range Range of the visibility (Maximum range for particles is usually 16, but it can differ for some types) - * @throws IllegalArgumentException If the specified id is not a block id - * @see ParticleEffectPacket - * @see ParticleEffectPacket#sendTo(Location, double) + * @author DarkBlade12 + * @since 1.6 */ - public static void displayBlockDust(int id, byte data, float offsetX, float offsetY, float offsetZ, float speed, int amount, Location center, double range) throws IllegalArgumentException { - if (!isBlock(id)) { - throw new IllegalArgumentException("Invalid block id"); + public static abstract class ParticleData { + private final Material material; + private final byte data; + private final int[] packetData; + + /** + * Construct a new particle data + * + * @param material Material of the item/block + * @param data Data value of the item/block + */ + @SuppressWarnings("deprecation") + public ParticleData(Material material, byte data) { + this.material = material; + this.data = data; + this.packetData = new int[] { material.getId(), data }; + } + + /** + * Returns the material of this data + * + * @return The material + */ + public Material getMaterial() { + return material; + } + + /** + * Returns the data value of this data + * + * @return The data value + */ + public byte getData() { + return data; + } + + /** + * Returns the data as an int array for packet construction + * + * @return The data for the packet + */ + public int[] getPacketData() { + return packetData; + } + + /** + * Returns the data as a string for pre 1.8 versions + * + * @return The data string for the packet + */ + public String getPacketDataString() { + return "_" + packetData[0] + "_" + packetData[1]; } - new ParticleEffectPacket("blockdust_" + id + "_" + data, offsetX, offsetY, offsetZ, speed, amount).sendTo(center, range); } /** - * Displays a block dust particle effect which is only visible for the specified players + * Represents the item data for the {@link ParticleEffect#ITEM_CRACK} effect + *
+ * This class is part of the ParticleEffect Library and follows the same usage conditions
*
- * @param id Id of the block
- * @param data Data value
- * @param offsetX Maximum distance particles can fly away from the center on the x-axis
- * @param offsetY Maximum distance particles can fly away from the center on the y-axis
- * @param offsetZ Maximum distance particles can fly away from the center on the z-axis
- * @param speed Display speed of the particles
- * @param amount Amount of particles
- * @param center Center location of the effect
- * @param players Receivers of the effect
- * @throws IllegalArgumentException If the specified id is not a block id
- * @see ParticleEffectPacket
- * @see ParticleEffectPacket#sendTo(Location, List)
+ * @author DarkBlade12
+ * @since 1.6
*/
- public static void displayBlockDust(int id, byte data, float offsetX, float offsetY, float offsetZ, float speed, int amount, Location center, List
+ * This class is part of the ParticleEffect Library and follows the same usage conditions
+ *
+ * @author DarkBlade12
+ * @since 1.6
+ */
+ public static final class BlockData extends ParticleData {
+ /**
+ * Construct a new block data
+ *
+ * @param material Material of the block
+ * @param data Data value of the block
+ * @throws IllegalArgumentException If the material is not a block
+ * @see ParticleData#ParticleData(Material, byte)
+ */
+ public BlockData(Material material, byte data) throws IllegalArgumentException {
+ super(material, data);
+ if (!material.isBlock()) {
+ throw new IllegalArgumentException("The material is not a block");
+ }
+ }
+ }
+
+ /**
+ * Represents a runtime exception that is thrown if the displayed particle effect requires data and has none or vice-versa
+ *
+ * This class is part of the ParticleEffect Library and follows the same usage conditions
+ *
+ * @author DarkBlade12
+ * @since 1.6
+ */
+ private static final class ParticleDataException extends RuntimeException {
+ private static final long serialVersionUID = 3203085387160737484L;
+
+ /**
+ * Construct a new particle data exception
+ *
+ * @param message Message that will be logged
+ * @param cause Cause of the exception
+ */
+ public ParticleDataException(String message) {
+ super(message);
+ }
+ }
+
+ /**
+ * Represents a runtime exception that is thrown if the displayed particle effect requires a newer version
+ *
+ * This class is part of the ParticleEffect Library and follows the same usage conditions
+ *
+ * @author DarkBlade12
+ * @since 1.6
+ */
+ private static final class ParticleVersionException extends RuntimeException {
+ private static final long serialVersionUID = 3203085387160737484L;
+
+ /**
+ * Construct a new particle version exception
+ *
+ * @param message Message that will be logged
+ * @param cause Cause of the exception
+ */
+ public ParticleVersionException(String message) {
+ super(message);
}
- new ParticleEffectPacket("blockdust_" + id + "_" + data, offsetX, offsetY, offsetZ, speed, amount).sendTo(center, players);
}
/**
@@ -582,33 +921,39 @@ public enum ParticleEffect {
* @author DarkBlade12
* @since 1.5
*/
- public static final class ParticleEffectPacket {
+ public static final class ParticlePacket {
+ private static int version;
+ private static Class enumParticle;
private static Constructor packetConstructor;
private static Method getHandle;
private static Field playerConnection;
private static Method sendPacket;
private static boolean initialized;
- private final String name;
+ private final ParticleEffect effect;
private final float offsetX;
private final float offsetY;
private final float offsetZ;
private final float speed;
private final int amount;
+ private final boolean longDistance;
+ private final ParticleData data;
private Object packet;
/**
- * Construct a new particle effect packet
+ * Construct a new particle packet
*
- * @param name Name of the effect
+ * @param effect Particle effect
* @param offsetX Maximum distance particles can fly away from the center on the x-axis
* @param offsetY Maximum distance particles can fly away from the center on the y-axis
* @param offsetZ Maximum distance particles can fly away from the center on the z-axis
* @param speed Display speed of the particles
* @param amount Amount of particles
+ * @param longDistance Indicates whether the maximum distance is increased from 256 to 65536
+ * @param data Data of the effect
* @throws IllegalArgumentException If the speed is lower than 0 or the amount is lower than 1
* @see #initialize()
*/
- public ParticleEffectPacket(String name, float offsetX, float offsetY, float offsetZ, float speed, int amount) throws IllegalArgumentException {
+ public ParticlePacket(ParticleEffect effect, float offsetX, float offsetY, float offsetZ, float speed, int amount, boolean longDistance, ParticleData data) throws IllegalArgumentException {
initialize();
if (speed < 0) {
throw new IllegalArgumentException("The speed is lower than 0");
@@ -616,12 +961,40 @@ public enum ParticleEffect {
if (amount < 1) {
throw new IllegalArgumentException("The amount is lower than 1");
}
- this.name = name;
+ this.effect = effect;
this.offsetX = offsetX;
this.offsetY = offsetY;
this.offsetZ = offsetZ;
this.speed = speed;
this.amount = amount;
+ this.longDistance = longDistance;
+ this.data = data;
+ }
+
+ /**
+ * Construct a new particle packet of a single particle flying into a determined direction
+ *
+ * @param effect Particle effect
+ * @param direction Direction of the particle
+ * @param speed Display speed of the particle
+ * @param longDistance Indicates whether the maximum distance is increased from 256 to 65536
+ * @param data Data of the effect
+ * @throws IllegalArgumentException If the speed is lower than 0
+ * @see #initialize()
+ */
+ public ParticlePacket(ParticleEffect effect, Vector direction, float speed, boolean longDistance, ParticleData data) throws IllegalArgumentException {
+ initialize();
+ if (speed < 0) {
+ throw new IllegalArgumentException("The speed is lower than 0");
+ }
+ this.effect = effect;
+ this.offsetX = (float) direction.getX();
+ this.offsetY = (float) direction.getY();
+ this.offsetZ = (float) direction.getZ();
+ this.speed = speed;
+ this.amount = 0;
+ this.longDistance = longDistance;
+ this.data = data;
}
/**
@@ -629,15 +1002,18 @@ public enum ParticleEffect {
*
* Note: These fields only have to be initialized once, so it will return if {@link #initialized} is already set to
- * If this enumeration is no longer up-to-date, please let me know in my forum post
- *
- * This class is part of the ReflectionUtils and follows the same usage conditions
- *
- * @author DarkBlade12
- * @since 1.0
- */
- public enum PacketType {
- HANDSHAKING_IN_SET_PROTOCOL("PacketHandshakingInSetProtocol"),
- LOGIN_IN_ENCRYPTION_BEGIN("PacketLoginInEncryptionBegin"),
- LOGIN_IN_START("PacketLoginInStart"),
- LOGIN_OUT_DISCONNECT("PacketLoginOutDisconnect"),
- LOGIN_OUT_ENCRYPTION_BEGIN("PacketLoginOutEncryptionBegin"),
- LOGIN_OUT_SUCCESS("PacketLoginOutSuccess"),
- PLAY_IN_ABILITIES("PacketPlayInAbilities"),
- PLAY_IN_ARM_ANIMATION("PacketPlayInArmAnimation"),
- PLAY_IN_BLOCK_DIG("PacketPlayInBlockDig"),
- PLAY_IN_BLOCK_PLACE("PacketPlayInBlockPlace"),
- PLAY_IN_CHAT("PacketPlayInChat"),
- PLAY_IN_CLIENT_COMMAND("PacketPlayInClientCommand"),
- PLAY_IN_CLOSE_WINDOW("PacketPlayInCloseWindow"),
- PLAY_IN_CUSTOM_PAYLOAD("PacketPlayInCustomPayload"),
- PLAY_IN_ENCHANT_ITEM("PacketPlayInEnchantItem"),
- PLAY_IN_ENTITY_ACTION("PacketPlayInEntityAction"),
- PLAY_IN_FLYING("PacketPlayInFlying"),
- PLAY_IN_HELD_ITEM_SLOT("PacketPlayInHeldItemSlot"),
- PLAY_IN_KEEP_ALIVE("PacketPlayInKeepAlive"),
- PLAY_IN_LOOK("PacketPlayInLook"),
- PLAY_IN_POSITION("PacketPlayInPosition"),
- PLAY_IN_POSITION_LOOK("PacketPlayInPositionLook"),
- PLAY_IN_SET_CREATIVE_SLOT("PacketPlayInSetCreativeSlot "),
- PLAY_IN_SETTINGS("PacketPlayInSettings"),
- PLAY_IN_STEER_VEHICLE("PacketPlayInSteerVehicle"),
- PLAY_IN_TAB_COMPLETE("PacketPlayInTabComplete"),
- PLAY_IN_TRANSACTION("PacketPlayInTransaction"),
- PLAY_IN_UPDATE_SIGN("PacketPlayInUpdateSign"),
- PLAY_IN_USE_ENTITY("PacketPlayInUseEntity"),
- PLAY_IN_WINDOW_CLICK("PacketPlayInWindowClick"),
- PLAY_OUT_ABILITIES("PacketPlayOutAbilities"),
- PLAY_OUT_ANIMATION("PacketPlayOutAnimation"),
- PLAY_OUT_ATTACH_ENTITY("PacketPlayOutAttachEntity"),
- PLAY_OUT_BED("PacketPlayOutBed"),
- PLAY_OUT_BLOCK_ACTION("PacketPlayOutBlockAction"),
- PLAY_OUT_BLOCK_BREAK_ANIMATION("PacketPlayOutBlockBreakAnimation"),
- PLAY_OUT_BLOCK_CHANGE("PacketPlayOutBlockChange"),
- PLAY_OUT_CHAT("PacketPlayOutChat"),
- PLAY_OUT_CLOSE_WINDOW("PacketPlayOutCloseWindow"),
- PLAY_OUT_COLLECT("PacketPlayOutCollect"),
- PLAY_OUT_CRAFT_PROGRESS_BAR("PacketPlayOutCraftProgressBar"),
- PLAY_OUT_CUSTOM_PAYLOAD("PacketPlayOutCustomPayload"),
- PLAY_OUT_ENTITY("PacketPlayOutEntity"),
- PLAY_OUT_ENTITY_DESTROY("PacketPlayOutEntityDestroy"),
- PLAY_OUT_ENTITY_EFFECT("PacketPlayOutEntityEffect"),
- PLAY_OUT_ENTITY_EQUIPMENT("PacketPlayOutEntityEquipment"),
- PLAY_OUT_ENTITY_HEAD_ROTATION("PacketPlayOutEntityHeadRotation"),
- PLAY_OUT_ENTITY_LOOK("PacketPlayOutEntityLook"),
- PLAY_OUT_ENTITY_METADATA("PacketPlayOutEntityMetadata"),
- PLAY_OUT_ENTITY_STATUS("PacketPlayOutEntityStatus"),
- PLAY_OUT_ENTITY_TELEPORT("PacketPlayOutEntityTeleport"),
- PLAY_OUT_ENTITY_VELOCITY("PacketPlayOutEntityVelocity"),
- PLAY_OUT_EXPERIENCE("PacketPlayOutExperience"),
- PLAY_OUT_EXPLOSION("PacketPlayOutExplosion"),
- PLAY_OUT_GAME_STATE_CHANGE("PacketPlayOutGameStateChange"),
- PLAY_OUT_HELD_ITEM_SLOT("PacketPlayOutHeldItemSlot"),
- PLAY_OUT_KEEP_ALIVE("PacketPlayOutKeepAlive"),
- PLAY_OUT_KICK_DISCONNECT("PacketPlayOutKickDisconnect"),
- PLAY_OUT_LOGIN("PacketPlayOutLogin"),
- PLAY_OUT_MAP("PacketPlayOutMap"),
- PLAY_OUT_MAP_CHUNK("PacketPlayOutMapChunk"),
- PLAY_OUT_MAP_CHUNK_BULK("PacketPlayOutMapChunkBulk"),
- PLAY_OUT_MULTI_BLOCK_CHANGE("PacketPlayOutMultiBlockChange"),
- PLAY_OUT_NAMED_ENTITY_SPAWN("PacketPlayOutNamedEntitySpawn"),
- PLAY_OUT_NAMED_SOUND_EFFECT("PacketPlayOutNamedSoundEffect"),
- PLAY_OUT_OPEN_SIGN_EDITOR("PacketPlayOutOpenSignEditor"),
- PLAY_OUT_OPEN_WINDOW("PacketPlayOutOpenWindow"),
- PLAY_OUT_PLAYER_INFO("PacketPlayOutPlayerInfo"),
- PLAY_OUT_POSITION("PacketPlayOutPosition"),
- PLAY_OUT_REL_ENTITY_MOVE("PacketPlayOutRelEntityMove"),
- PLAY_OUT_REL_ENTITY_MOVE_LOOK("PacketPlayOutRelEntityMoveLook"),
- PLAY_OUT_REMOVE_ENTITY_EFFECT("PacketPlayOutRemoveEntityEffect"),
- PLAY_OUT_RESPAWN("PacketPlayOutRespawn"),
- PLAY_OUT_SCOREBOARD_DISPLAY_OBJECTIVE("PacketPlayOutScoreboardDisplayObjective"),
- PLAY_OUT_SCOREBOARD_OBJECTIVE("PacketPlayOutScoreboardObjective"),
- PLAY_OUT_SCOREBOARD_SCORE("PacketPlayOutScoreboardScore"),
- PLAY_OUT_SCOREBOARD_TEAM("PacketPlayOutScoreboardTeam"),
- PLAY_OUT_SET_SLOT("PacketPlayOutSetSlot"),
- PLAY_OUT_SPAWN_ENTITY("PacketPlayOutSpawnEntity"),
- PLAY_OUT_SPAWN_ENTITY_EXPERIENCE_ORB("PacketPlayOutSpawnEntityExperienceOrb"),
- PLAY_OUT_SPAWN_ENTITY_LIVING("PacketPlayOutSpawnEntityLiving"),
- PLAY_OUT_SPAWN_ENTITY_PAINTING("PacketPlayOutSpawnEntityPainting"),
- PLAY_OUT_SPAWN_ENTITY_WEATHER("PacketPlayOutSpawnEntityWeather"),
- PLAY_OUT_SPAWN_POSITION("PacketPlayOutSpawnPosition"),
- PLAY_OUT_STATISTIC("PacketPlayOutStatistic"),
- PLAY_OUT_TAB_COMPLETE("PacketPlayOutTabComplete"),
- PLAY_OUT_TILE_ENTITY_DATA("PacketPlayOutTileEntityData"),
- PLAY_OUT_TRANSACTION("PacketPlayOutTransaction"),
- PLAY_OUT_UPDATE_ATTRIBUTES("PacketPlayOutUpdateAttributes"),
- PLAY_OUT_UPDATE_HEALTH("PacketPlayOutUpdateHealth"),
- PLAY_OUT_UPDATE_SIGN("PacketPlayOutUpdateSign"),
- PLAY_OUT_UPDATE_TIME("PacketPlayOutUpdateTime"),
- PLAY_OUT_WINDOW_ITEMS("PacketPlayOutWindowItems"),
- PLAY_OUT_WORLD_EVENT("PacketPlayOutWorldEvent"),
- PLAY_OUT_WORLD_PARTICLES("PacketPlayOutWorldParticles"),
- STATUS_IN_PING("PacketStatusInPing"),
- STATUS_IN_START("PacketStatusInStart"),
- STATUS_OUT_PONG("PacketStatusOutPong"),
- STATUS_OUT_SERVER_INFO("PacketStatusOutServerInfo");
-
- private static final Maptrue
*
- * @throws VersionIncompatibleException if accessed packets, fields or methods differ in your bukkit version
+ * @throws VersionIncompatibleException if your bukkit version is not supported by this library
*/
public static void initialize() throws VersionIncompatibleException {
if (initialized) {
return;
}
try {
- int version = Integer.parseInt(Character.toString(PackageType.getServerVersion().charAt(3)));
- Class packetClass = PackageType.MINECRAFT_SERVER.getClass(version < 7 ? "Packet63WorldParticles" : PacketType.PLAY_OUT_WORLD_PARTICLES.getName());
+ version = Integer.parseInt(Character.toString(PackageType.getServerVersion().charAt(3)));
+ if (version > 7) {
+ enumParticle = PackageType.MINECRAFT_SERVER.getClass("EnumParticle");
+ }
+ Class packetClass = PackageType.MINECRAFT_SERVER.getClass(version < 7 ? "Packet63WorldParticles" : "PacketPlayOutWorldParticles");
packetConstructor = ReflectionUtils.getConstructor(packetClass);
getHandle = ReflectionUtils.getMethod("CraftPlayer", PackageType.CRAFTBUKKIT_ENTITY, "getHandle");
playerConnection = ReflectionUtils.getField("EntityPlayer", PackageType.MINECRAFT_SERVER, false, "playerConnection");
@@ -648,6 +1024,15 @@ public enum ParticleEffect {
initialized = true;
}
+ /**
+ * Returns the version of your server (1.x)
+ *
+ * @return The version number
+ */
+ public static int getVersion() {
+ return version;
+ }
+
/**
* Determine if {@link #packetConstructor}, {@link #getHandle}, {@link #playerConnection} and {@link #sendPacket} are initialized
*
@@ -670,7 +1055,16 @@ public enum ParticleEffect {
if (packet == null) {
try {
packet = packetConstructor.newInstance();
- ReflectionUtils.setValue(packet, true, "a", name);
+ Object id;
+ if (version < 8) {
+ id = effect.getName();
+ if (data != null) {
+ id = (String)id + data.getPacketDataString();
+ }
+ } else {
+ id = enumParticle.getEnumConstants()[effect.getId()];
+ }
+ ReflectionUtils.setValue(packet, true, "a", id);
ReflectionUtils.setValue(packet, true, "b", (float) center.getX());
ReflectionUtils.setValue(packet, true, "c", (float) center.getY());
ReflectionUtils.setValue(packet, true, "d", (float) center.getZ());
@@ -679,6 +1073,10 @@ public enum ParticleEffect {
ReflectionUtils.setValue(packet, true, "g", offsetZ);
ReflectionUtils.setValue(packet, true, "h", speed);
ReflectionUtils.setValue(packet, true, "i", amount);
+ if (version > 7) {
+ ReflectionUtils.setValue(packet, true, "j", longDistance);
+ ReflectionUtils.setValue(packet, true, "k", data == null ? new int[0] : data.getPacketData());
+ }
} catch (Exception exception) {
throw new PacketInstantiationException("Packet instantiation failed", exception);
}
diff --git a/src/main/java/com/massivecraft/massivecore/particleeffect/ReflectionUtils.java b/src/main/java/com/massivecraft/massivecore/particleeffect/ReflectionUtils.java
index 33abc67a..ef48a8a5 100644
--- a/src/main/java/com/massivecraft/massivecore/particleeffect/ReflectionUtils.java
+++ b/src/main/java/com/massivecraft/massivecore/particleeffect/ReflectionUtils.java
@@ -26,7 +26,7 @@ import org.bukkit.Bukkit;
* @version 1.1
*/
public final class ReflectionUtils {
- // Prevent accidential construction
+ // Prevent accidental construction
private ReflectionUtils() {}
/**
@@ -603,156 +603,4 @@ public final class ReflectionUtils {
return true;
}
}
-
- /**
- * Represents an enumeration of all packet types that are featured in Minecraft 1.7.10
- *