Package me.deecaad.weaponmechanics.weapon.explode.shapes

Class DefaultExplosion

java.lang.Object
me.deecaad.weaponmechanics.weapon.explode.shapes.DefaultExplosion
All Implemented Interfaces:
me.deecaad.core.file.Serializer<ExplosionShape>, ExplosionShape, net.kyori.adventure.key.Keyed, org.bukkit.Keyed
public class DefaultExplosion extends Object implements ExplosionShape
This explosion uses the minecraft explosion system, instead of using a shape.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DefaultExplosion()
    Default constructor for serializer.
    DefaultExplosion(double yield, int gridSize)
    Constructs a DefaultExplosion object.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getArea()
    Returns the area, measured in meters cubed (blocks cubed), of this shape.
    List<org.bukkit.block.Block>
    getBlocks(org.bukkit.Location origin)
    Returns a list of all effected blocks effected by this shape if an explosion were to trigger at the given origin.
    List<org.bukkit.entity.LivingEntity>
    getEntities(org.bukkit.Location origin)
    Returns a list of all effect entities effected by this shape.
    org.bukkit.NamespacedKey
    getKey()
     
    double
    getMaxDistance()
    Returns the maximum distance from the origin of the explosion that an entity is considered to be contained in the explosion.
    boolean
    isContained(org.bukkit.Location origin, org.bukkit.Location point)
    Returns true if the given point is contained in this shape, assuming the shape's center is located at origin.
    ExplosionShape
    serialize(me.deecaad.core.file.SerializeData data)
     
    String
    toString()
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.bukkit.Keyed

    key

    Methods inherited from interface me.deecaad.core.file.Serializer

    canUsePathTo, getKeyword, getName, getParentKeywords, getWikiLink, letPassThrough, shouldSerialize, tryPathTo, useLater

  • Constructor Details

    • DefaultExplosion

      public DefaultExplosion()
      Default constructor for serializer.

    • DefaultExplosion

      public DefaultExplosion(double yield, int gridSize)
      Constructs a DefaultExplosion object.
      Parameters:
      yield - The yield of the explosion, typically 4.0.
      gridSize - How many grids on the cube, typically 16.

  • Method Details

    • getKey

      @NotNull public org.bukkit.NamespacedKey getKey()
      Specified by:
      getKey in interface org.bukkit.Keyed

    • getBlocks

      @NotNull public List<org.bukkit.block.Block> getBlocks(@NotNull org.bukkit.Location origin)
      Description copied from interface: ExplosionShape
      Returns a list of all effected blocks effected by this shape if an explosion were to trigger at the given origin. This list will not contain any air blocks, but may still contain liquids/bedrock/ otherwise.

      Implementations should not filter blocks out by material (Like IRON_BLOCK, DIRT, STONE). Instead, let BlockDamage handle that. You may still filter out "tough" blocks, like liquids, bedrock, or obsidian.

      Specified by:
      getBlocks in interface ExplosionShape
      Parameters:
      origin - The non-null origin of the explosion (Usually the center).
      Returns:
      The non-null list of blocks contained in the explosion.

    • getEntities

      public List<org.bukkit.entity.LivingEntity> getEntities(@NotNull org.bukkit.Location origin)
      Description copied from interface: ExplosionShape
      Returns a list of all effect entities effected by this shape. An entity is effected if they are contained in the area of the explosion.

      Data returned by this method is usually consumed by an ExplosionExposure.

      Specified by:
      getEntities in interface ExplosionShape
      Parameters:
      origin - The non-null origin of the explosion (Usually the center).
      Returns:
      The non-null list of entities contained in the explosion.

    • getMaxDistance

      public double getMaxDistance()
      Description copied from interface: ExplosionShape
      Returns the maximum distance from the origin of the explosion that an entity is considered to be contained in the explosion. This method should NOT be used to determine whether a point is in an explosion (use ExplosionShape.isContained(Location, Location)). This method is useful for helping to determine an entity's exposure. See DistanceExposure.
      Specified by:
      getMaxDistance in interface ExplosionShape
      Returns:
      The maximum distance away an entity takes damage.

    • isContained

      public boolean isContained(@NotNull org.bukkit.Location origin, @NotNull org.bukkit.Location point)
      Description copied from interface: ExplosionShape
      Returns true if the given point is contained in this shape, assuming the shape's center is located at origin.
      Specified by:
      isContained in interface ExplosionShape
      Parameters:
      origin - The non-null origin of the explosion.
      point - The non-null point to test.
      Returns:
      True if the point is in this shape.

    • getArea

      public double getArea()
      Description copied from interface: ExplosionShape
      Returns the area, measured in meters cubed (blocks cubed), of this shape. Note that the returned value will be inaccurate to an unknown degree, since some shapes (like DefaultExplosion) are based on randomness and ray-tracing.
      Specified by:
      getArea in interface ExplosionShape
      Returns:
      The maximum area effected by this shape.

    • serialize

      @NotNull public ExplosionShape serialize(@NotNull me.deecaad.core.file.SerializeData data) throws me.deecaad.core.file.SerializerException
      Specified by:
      serialize in interface me.deecaad.core.file.Serializer<ExplosionShape>
      Throws:
      me.deecaad.core.file.SerializerException

    • toString

      public String toString()
      Overrides:
      toString in class Object