From 6014a368344b93d8a67207acca5dce642311dd2b Mon Sep 17 00:00:00 2001 From: Aikar Date: Tue, 19 Dec 2017 16:24:42 -0500 Subject: [PATCH] Expand Explosions API Add Entity as a Source capability, and add more API choices, and on Location. diff --git a/src/main/java/org/bukkit/Location.java b/src/main/java/org/bukkit/Location.java index f3ae58ee..b5a6ac16 100644 --- a/src/main/java/org/bukkit/Location.java +++ b/src/main/java/org/bukkit/Location.java @@ -4,6 +4,7 @@ import java.util.HashMap; import java.util.Map; import org.bukkit.block.Block; import org.bukkit.configuration.serialization.ConfigurationSerializable; +import org.bukkit.entity.Entity; // Paper import org.bukkit.util.NumberConversions; import org.bukkit.util.Vector; import org.jetbrains.annotations.NotNull; @@ -540,6 +541,87 @@ public class Location implements Cloneable, ConfigurationSerializable { return centerLoc; } + /** + * Creates explosion at this location with given power + * + * Will break blocks and ignite blocks on fire. + * + * @param power The power of explosion, where 4F is TNT + * @return false if explosion was canceled, otherwise true + */ + public boolean createExplosion(float power) { + return world.createExplosion(this, power); + } + + /** + * Creates explosion at this location with given power and optionally + * setting blocks on fire. + * + * Will break blocks. + * + * @param power The power of explosion, where 4F is TNT + * @param setFire Whether or not to set blocks on fire + * @return false if explosion was canceled, otherwise true + */ + public boolean createExplosion(float power, boolean setFire) { + return world.createExplosion(this, power, setFire); + } + + /** + * Creates explosion at this location with given power and optionally + * setting blocks on fire. + * + * @param power The power of explosion, where 4F is TNT + * @param setFire Whether or not to set blocks on fire + * @param breakBlocks Whether or not to have blocks be destroyed + * @return false if explosion was canceled, otherwise true + */ + public boolean createExplosion(float power, boolean setFire, boolean breakBlocks) { + return world.createExplosion(this, power, setFire, breakBlocks); + } + + /** + * Creates explosion at this location with given power, with the specified entity as the source. + * + * Will break blocks and ignite blocks on fire. + * + * @param source The source entity of the explosion + * @param power The power of explosion, where 4F is TNT + * @return false if explosion was canceled, otherwise true + */ + public boolean createExplosion(@Nullable Entity source, float power) { + return world.createExplosion(source, this, power, true, true); + } + + /** + * Creates explosion at this location with given power and optionally + * setting blocks on fire, with the specified entity as the source. + * + * Will break blocks. + * + * @param source The source entity of the explosion + * @param power The power of explosion, where 4F is TNT + * @param setFire Whether or not to set blocks on fire + * @return false if explosion was canceled, otherwise true + */ + public boolean createExplosion(@Nullable Entity source, float power, boolean setFire) { + return world.createExplosion(source, this, power, setFire, true); + } + + /** + * Creates explosion at this location with given power and optionally + * setting blocks on fire, with the specified entity as the source. + * + * @param source The source entity of the explosion + * @param power The power of explosion, where 4F is TNT + * @param setFire Whether or not to set blocks on fire + * @param breakBlocks Whether or not to have blocks be destroyed + * @return false if explosion was canceled, otherwise true + */ + public boolean createExplosion(@NotNull Entity source, float power, boolean setFire, boolean breakBlocks) { + return world.createExplosion(source, source.getLocation(), power, setFire, breakBlocks); + } + /** * Returns a list of entities within a bounding box centered around a Location. * diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java index a709ac47..9579437b 100644 --- a/src/main/java/org/bukkit/World.java +++ b/src/main/java/org/bukkit/World.java @@ -1188,6 +1188,102 @@ public interface World extends PluginMessageRecipient, Metadatable { */ public boolean createExplosion(@NotNull Location loc, float power, boolean setFire); + // Paper start + /** + * Creates explosion at given location with given power and optionally + * setting blocks on fire, with the specified entity as the source. + * + * @param source The source entity of the explosion + * @param loc Location to blow up + * @param power The power of explosion, where 4F is TNT + * @param setFire Whether or not to set blocks on fire + * @param breakBlocks Whether or not to have blocks be destroyed + * @return false if explosion was canceled, otherwise true + */ + public boolean createExplosion(@Nullable Entity source, @NotNull Location loc, float power, boolean setFire, boolean breakBlocks); + + /** + * Creates explosion at given location with given power and optionally + * setting blocks on fire, with the specified entity as the source. + * + * Will destroy other blocks + * + * @param source The source entity of the explosion + * @param loc Location to blow up + * @param power The power of explosion, where 4F is TNT + * @param setFire Whether or not to set blocks on fire + * @return false if explosion was canceled, otherwise true + */ + public default boolean createExplosion(@Nullable Entity source, @NotNull Location loc, float power, boolean setFire) { + return createExplosion(source, loc, power, setFire, true); + } + /** + * Creates explosion at given location with given power, with the specified entity as the source. + * Will set blocks on fire and destroy blocks. + * + * @param source The source entity of the explosion + * @param loc Location to blow up + * @param power The power of explosion, where 4F is TNT + * @return false if explosion was canceled, otherwise true + */ + public default boolean createExplosion(@Nullable Entity source, @NotNull Location loc, float power) { + return createExplosion(source, loc, power, true, true); + } + /** + * Creates explosion at given entities location with given power and optionally + * setting blocks on fire, with the specified entity as the source. + * + * @param source The source entity of the explosion + * @param power The power of explosion, where 4F is TNT + * @param setFire Whether or not to set blocks on fire + * @param breakBlocks Whether or not to have blocks be destroyed + * @return false if explosion was canceled, otherwise true + */ + public default boolean createExplosion(@NotNull Entity source, float power, boolean setFire, boolean breakBlocks) { + return createExplosion(source, source.getLocation(), power, setFire, breakBlocks); + } + /** + * Creates explosion at given entities location with given power and optionally + * setting blocks on fire, with the specified entity as the source. + * + * Will destroy blocks. + * + * @param source The source entity of the explosion + * @param power The power of explosion, where 4F is TNT + * @param setFire Whether or not to set blocks on fire + * @return false if explosion was canceled, otherwise true + */ + public default boolean createExplosion(@NotNull Entity source, float power, boolean setFire) { + return createExplosion(source, source.getLocation(), power, setFire, true); + } + + /** + * Creates explosion at given entities location with given power and optionally + * setting blocks on fire, with the specified entity as the source. + * + * @param source The source entity of the explosion + * @param power The power of explosion, where 4F is TNT + * @return false if explosion was canceled, otherwise true + */ + public default boolean createExplosion(@NotNull Entity source, float power) { + return createExplosion(source, source.getLocation(), power, true, true); + } + + /** + * Creates explosion at given location with given power and optionally + * setting blocks on fire or breaking blocks. + * + * @param loc Location to blow up + * @param power The power of explosion, where 4F is TNT + * @param setFire Whether or not to set blocks on fire + * @param breakBlocks Whether or not to have blocks be destroyed + * @return false if explosion was canceled, otherwise true + */ + public default boolean createExplosion(@NotNull Location loc, float power, boolean setFire, boolean breakBlocks) { + return createExplosion(loc.getX(), loc.getY(), loc.getZ(), power, setFire, breakBlocks); + } + // Paper end + /** * Gets the {@link Environment} type of this world * -- 2.21.0