From 2ee538ec0267c7bf65d2beca5a47af1cbcbd09ab Mon Sep 17 00:00:00 2001 From: Bukkit/Spigot Date: Tue, 15 Feb 2022 09:50:10 +1100 Subject: [PATCH] #726: Add Particle dataTypes to javadocs By: mfnalex <1122571+mfnalex@users.noreply.github.com> --- .../src/main/java/org/bukkit/Particle.java | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/paper-api/src/main/java/org/bukkit/Particle.java b/paper-api/src/main/java/org/bukkit/Particle.java index dc5142460a..8d048a8f14 100644 --- a/paper-api/src/main/java/org/bukkit/Particle.java +++ b/paper-api/src/main/java/org/bukkit/Particle.java @@ -36,13 +36,25 @@ public enum Particle { FLAME, LAVA, CLOUD, + /** + * Uses {@link Particle.DustOptions} as DataType + */ REDSTONE(DustOptions.class), SNOWBALL, SNOW_SHOVEL, SLIME, HEART, + /** + * Uses {@link ItemStack} as DataType + */ ITEM_CRACK(ItemStack.class), + /** + * Uses {@link BlockData} as DataType + */ BLOCK_CRACK(BlockData.class), + /** + * Uses {@link BlockData} as DataType + */ BLOCK_DUST(BlockData.class), WATER_DROP, MOB_APPEARANCE, @@ -50,6 +62,9 @@ public enum Particle { END_ROD, DAMAGE_INDICATOR, SWEEP_ATTACK, + /** + * Uses {@link BlockData} as DataType + */ FALLING_DUST(BlockData.class), TOTEM, SPIT, @@ -81,7 +96,13 @@ public enum Particle { LANDING_OBSIDIAN_TEAR, REVERSE_PORTAL, WHITE_ASH, + /** + * Uses {@link DustTransition} as DataType + */ DUST_COLOR_TRANSITION(DustTransition.class), + /** + * Uses {@link Vibration} as DataType + */ VIBRATION(Vibration.class), FALLING_SPORE_BLOSSOM, SPORE_BLOSSOM_AIR, @@ -97,10 +118,22 @@ public enum Particle { WAX_OFF, ELECTRIC_SPARK, SCRAPE, + /** + * Uses {@link BlockData} as DataType + */ BLOCK_MARKER(BlockData.class), // ----- Legacy Separator ----- + /** + * Uses {@link MaterialData} as DataType + */ LEGACY_BLOCK_CRACK(MaterialData.class), + /** + * Uses {@link MaterialData} as DataType + */ LEGACY_BLOCK_DUST(MaterialData.class), + /** + * Uses {@link MaterialData} as DataType + */ LEGACY_FALLING_DUST(MaterialData.class); private final Class dataType;