Package fr.multimc.api.spigot.common.worlds.locations.zones

Class Zone

java.lang.Object
fr.multimc.api.spigot.common.worlds.locations.zones.Zone
All Implemented Interfaces:
org.bukkit.event.Listener
public class Zone extends Object implements org.bukkit.event.Listener

  • Constructor Summary

    Constructors
    Constructor
    Description
    Zone(org.bukkit.Location center, RelativeLocation location1, RelativeLocation location2)
    Constructs a new zone using a center Location and two RelativeLocation representing the two point on the circle
    Zone(org.bukkit.Location center, RelativeLocation location1, RelativeLocation location2, org.bukkit.plugin.Plugin plugin, ZoneListener callback)
    Constructs a new zone using a center Location and two RelativeLocation representing the two point on the circle
    Zone(org.bukkit.Location location1, org.bukkit.Location location2)
    Constructs a new zone using two Location representing the two opposite corners of the zone.
    Zone(org.bukkit.Location location1, org.bukkit.Location location2, org.bukkit.plugin.Plugin plugin, ZoneListener callback)
    Constructs a new zone using two Location representing the two opposite corners of the zone.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<org.bukkit.block.Block>
    getBlocks()
    Get a List<org.bukkit.block.Block> of all the blocks in the zone.
    org.bukkit.World
    getWorld()
    Get the world this zone is in.
    boolean
    isIn(@NotNull org.bukkit.entity.Entity entity)
    Check whether the given Entity is inside the zone
    boolean
    isIn(org.bukkit.entity.Player player)
    Check whether the given Player is inside the zone
    boolean
    isIn(org.bukkit.Location location)
    Check whether the given Location is inside the zone

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Zone

      public Zone(@Nonnull org.bukkit.Location location1, @Nonnull org.bukkit.Location location2, @Nullable org.bukkit.plugin.Plugin plugin, @Nullable ZoneListener callback)
      Constructs a new zone using two Location representing the two opposite corners of the zone.
      Parameters:
      location1 - The first corner of the zone.
      location2 - The second corner of the zone.
      plugin - The plugin registering this zone as a listener
      callback - The ZoneListener callbacks for enter and exit event
      Throws:
      IllegalArgumentException - if the locations are not in the same world

    • Zone

      public Zone(@Nonnull org.bukkit.Location location1, @Nonnull org.bukkit.Location location2)
      Constructs a new zone using two Location representing the two opposite corners of the zone.
      Parameters:
      location1 - The first corner of the zone.
      location2 - The second corner of the zone.

    • Zone

      public Zone(@Nonnull org.bukkit.Location center, @Nonnull RelativeLocation location1, @Nonnull RelativeLocation location2, @Nullable org.bukkit.plugin.Plugin plugin, @Nullable ZoneListener callback)
      Constructs a new zone using a center Location and two RelativeLocation representing the two point on the circle
      Parameters:
      center - center location of the zone
      location1 - the first point on the circle
      location2 - the second point on the circle
      plugin - The plugin registering this zone as a listener
      callback - The ZoneListener callbacks for enter and exit event

    • Zone

      public Zone(@Nonnull org.bukkit.Location center, @Nonnull RelativeLocation location1, @Nonnull RelativeLocation location2)
      Constructs a new zone using a center Location and two RelativeLocation representing the two point on the circle
      Parameters:
      center - center location of the zone
      location1 - the first point on the circle
      location2 - the second point on the circle

  • Method Details

    • isIn

      public boolean isIn(@NotNull @NotNull org.bukkit.entity.Entity entity)
      Check whether the given Entity is inside the zone
      Parameters:
      entity - the given entity
      Returns:
      true if the entity is inside the zone, false otherwise

    • isIn

      public boolean isIn(@Nonnull org.bukkit.entity.Player player)
      Check whether the given Player is inside the zone
      Parameters:
      player - the given player
      Returns:
      true if the player is inside the zone, false otherwise

    • isIn

      public boolean isIn(@Nonnull org.bukkit.Location location)
      Check whether the given Location is inside the zone
      Parameters:
      location - the given location
      Returns:
      true if the location is inside the zone, false otherwise

    • getBlocks

      public List<org.bukkit.block.Block> getBlocks()
      Get a List<org.bukkit.block.Block> of all the blocks in the zone.
      Returns:
      List<org.bukkit.block.Block>

    • getWorld

      public org.bukkit.World getWorld()
      Get the world this zone is in.
      Returns:
      World