Class RegionManager

java.lang.Object
me.tayebyassine.homestead.managers.RegionManager
public final class RegionManager extends Object
A utility class that manages Region.

  • Method Details

    • createRegion

      public static Region createRegion(String name, org.bukkit.OfflinePlayer player)
      Creates a region, optionally ensuring the name is unique by appending a counter.
      Parameters:
      name - the region name
      player - the owner of the region
      Returns:
      the created region

    • getRegionCount

      public static int getRegionCount()
      Returns the total number of regions in the server.
      Returns:
      region count

    • getAll

      public static List<Region> getAll()
      Returns a list of every loaded region, directly from dynamic cache.
      Returns:
      list of all regions

    • findRegion

      public static Region findRegion(long id)
      Retrieves the region with the exact ID, or null if none exists.
      Parameters:
      id - the region ID
      Returns:
      the region, or null

    • findRegion

      public static Region findRegion(String name)
      Retrieves the region with the exact name (case-insensitive), or null if none exists.
      Parameters:
      name - the region name
      Returns:
      the region, or null

    • getRegionNames

      public static List<String> getRegionNames()
      Returns all region names for tab-completion purposes.
      Returns:
      list of region names

    • getRandomRegion

      public static Region getRandomRegion()
      Returns a random region from the cache.
      Returns:
      a random region, or null if none exist

    • getAllOwners

      public static List<org.bukkit.OfflinePlayer> getAllOwners()
      Returns every unique owner across all regions.
      Returns:
      list of owner players

    • searchRegions

      public static List<Region> searchRegions(String query)
      Searches regions by name containing the given text (case-insensitive).
      Parameters:
      query - the search query
      Returns:
      list of matching regions

    • sortRegionsAlpha

      public static List<Region> sortRegionsAlpha()
      Supplies all regions sorted alphabetically by name.
      Returns:
      sorted list of regions

    • getRegionsSortedByName

      public static List<Region> getRegionsSortedByName()
      Alias for sortRegionsAlpha() with a more descriptive name.
      Returns:
      regions sorted alphabetically

    • sortRegions

      public static List<Region> sortRegions(RegionManager.RegionSorting type)
      Produces a list ordered by the requested metric. Ordering is descending for numeric criteria, ascending for creation date.
      Parameters:
      type - the sorting method
      Returns:
      sorted list of regions

    • deleteRegion

      public static void deleteRegion(long id)
      Permanently deletes the specified region and all related data. If configured, all linked chunks are regenerated via FastAsyncWorldEdit.
      Parameters:
      id - the region ID

    • mergeRegions

      public static void mergeRegions(Region from, Region to)
      Merges all data from one region into another and deletes the source region. Transfers bank balance, chunks, sub-areas, and members.
      Parameters:
      from - the region to merge from (will be deleted)
      to - the region to merge into

    • renameRegion

      public static String renameRegion(Region region, String newName)
      Safely renames a region, ensuring the new name is unique.
      Parameters:
      region - the region to rename
      newName - the desired new name
      Returns:
      the actual name assigned (may have counter appended)

    • sendPrivateChat

      public static void sendPrivateChat(Region region, org.bukkit.entity.Player author, String message)
      Sends a private chat message to all online members and the owner of a region. Optionally logs the message if configured.
      Parameters:
      region - the region to chat in
      author - the player sending the message
      message - the message content

    • isRegionEmpty

      public static boolean isRegionEmpty(Region region)
      Checks if a region has no chunks and no members (essentially empty).
      Parameters:
      region - the region
      Returns:
      true if the region is empty

    • getRegionAge

      public static long getRegionAge(Region region)
      Returns how many milliseconds ago the region was created.
      Parameters:
      region - the region
      Returns:
      age in milliseconds

    • getRegionsOwnedByPlayer

      public static List<Region> getRegionsOwnedByPlayer(org.bukkit.OfflinePlayer player)
      Supplies every region whose owner matches the given player.
      Parameters:
      player - the player
      Returns:
      list of owned regions

    • getRegionsOwnedByPlayer

      public static List<Region> getRegionsOwnedByPlayer(UUID ownerId)
      Supplies every region whose owner matches the given UUID.
      Parameters:
      ownerId - the owner UUID
      Returns:
      list of owned regions

    • getRegionsHasPlayerAsMember

      public static List<Region> getRegionsHasPlayerAsMember(org.bukkit.OfflinePlayer player)
      Supplies every region that lists the given player as a member.
      Parameters:
      player - the player
      Returns:
      list of regions

    • getRegionsHasPlayerAsMember

      public static List<Region> getRegionsHasPlayerAsMember(UUID playerId)
      Supplies every region that lists the given player as a member.
      Parameters:
      playerId - the player UUID
      Returns:
      list of regions

    • getPublicRegions

      public static List<Region> getPublicRegions()
      Supplies regions flagged as public (passthrough + teleport-spawn).
      Returns:
      list of public regions

    • isPlayerInsideRegion

      public static boolean isPlayerInsideRegion(org.bukkit.entity.Player player, Region region)
      Tests whether the player's current chunk is claimed by the supplied region.
      Parameters:
      player - the player
      region - the region
      Returns:
      true if the player is inside the region

    • getRegionsInWorld

      public static List<Region> getRegionsInWorld(org.bukkit.World world)
      Returns all regions in a specific world.
      Parameters:
      world - the world
      Returns:
      list of regions with chunks in that world

    • getRegionsInWorld

      public static List<Region> getRegionsInWorld(UUID worldId)
      Returns all regions in a specific world.
      Parameters:
      worldId - the world UUID
      Returns:
      list of regions with chunks in that world

    • getRegionsNearLocation

      public static List<Region> getRegionsNearLocation(org.bukkit.Location location, int chunkRadius)
      Returns regions within a chunk radius of a location.
      Parameters:
      location - the center location
      chunkRadius - the radius in chunks
      Returns:
      list of nearby regions

    • getRegionAtLocation

      public static Region getRegionAtLocation(org.bukkit.Location location)
      Returns the region that owns the chunk at the given location.
      Parameters:
      location - the location
      Returns:
      the region, or null if unclaimed

    • getRegionAtChunk

      public static Region getRegionAtChunk(org.bukkit.Chunk chunk)
      Returns the region that owns the given chunk.
      Parameters:
      chunk - the chunk
      Returns:
      the region, or null if unclaimed

    • getRegionsByBankRange

      public static List<Region> getRegionsByBankRange(double min, double max)
      Returns regions with bank balance within a range.
      Parameters:
      min - minimum bank balance (inclusive)
      max - maximum bank balance (inclusive)
      Returns:
      list of regions

    • getTotalServerBank

      public static double getTotalServerBank()
      Returns the sum of all region bank balances.
      Returns:
      total server wealth in regions

    • getAverageBank

      public static double getAverageBank()
      Returns the average bank balance across all regions.
      Returns:
      average balance, or 0.0 if no regions

    • getRichestRegion

      public static Region getRichestRegion()
      Returns the richest region.
      Returns:
      the region with the highest bank balance, or null

    • getPoorestRegion

      public static Region getPoorestRegion()
      Returns the poorest region.
      Returns:
      the region with the lowest bank balance, or null

    • getRegionsWithWelcomeSigns

      public static List<Region> getRegionsWithWelcomeSigns()
      Supplies only regions that have a welcome sign configured.
      Returns:
      list of regions with welcome signs

    • getPlayersWithRegionsHasWelcomeSigns

      public static List<org.bukkit.OfflinePlayer> getPlayersWithRegionsHasWelcomeSigns()
      Supplies owners of regions that possess a welcome sign.
      Returns:
      list of players who own regions with welcome signs

    • getRegionsWithSubAreas

      public static List<Region> getRegionsWithSubAreas()
      Returns regions that have at least one sub-area.
      Returns:
      list of regions with sub-areas

    • getRegionsWithMembers

      public static List<Region> getRegionsWithMembers()
      Returns regions that have at least one member.
      Returns:
      list of regions with members

    • getRegionsWithBans

      public static List<Region> getRegionsWithBans()
      Returns regions that have at least one ban.
      Returns:
      list of regions with bans

    • getRegionsWithInvites

      public static List<Region> getRegionsWithInvites()
      Returns regions that have pending invites.
      Returns:
      list of regions with invites

    • getInactiveRegions

      public static List<Region> getInactiveRegions(long since)
      Returns regions with no activity (no logs) since a given timestamp.
      Parameters:
      since - the timestamp threshold
      Returns:
      list of inactive regions

    • getRegionsNeedingUpkeep

      public static List<Region> getRegionsNeedingUpkeep(long bufferMillis)
      Returns regions whose upkeep is due (upkeepAt <= current time + buffer).
      Parameters:
      bufferMillis - buffer time in milliseconds
      Returns:
      list of regions needing upkeep

    • canAffordUpkeep

      public static boolean canAffordUpkeep(Region region, double upkeepCost)
      Checks if a region can afford its upkeep based on current bank balance.
      Parameters:
      region - the region
      upkeepCost - the upkeep cost
      Returns:
      true if bank >= upkeep cost

    • getRank

      public static int getRank(RegionManager.RegionSorting type, long id)
      Computes the 1-based rank of a region within the given sorting; 0 if not found.
      Parameters:
      type - the sorting method
      id - the region ID
      Returns:
      1-based rank, or 0 if not found

    • getGlobalRank

      public static int getGlobalRank(long id)
      Averages the region's ranks across all metrics to give a global standing. Missing regions in a category count as last place.
      Parameters:
      id - the region ID
      Returns:
      average rank across all categories

    • isNameUsed

      public static boolean isNameUsed(String name)
      Checks whether any region already carries the supplied name, ignoring case.
      Parameters:
      name - the name to check
      Returns:
      true if the name is used

    • cleanupInvalidRegions

      public static int cleanupInvalidRegions()
      Removes all regions with invalid references:
      - Owners whose UUID no longer maps to a known player
      - Worlds that no longer exist (for spawn location and welcome sign)

      Also cleans invalid spawn locations and welcome signs.
      Returns:
      number of corrupted regions removed + fixes applied