Class MemberManager

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

  • Method Details

    • getMember

      public static RegionMember getMember(long id)
      Retrieves a member by its unique ID.
      Parameters:
      id - the member ID
      Returns:
      the RegionMember, or null if not found

    • getAllMembers

      public static List<RegionMember> getAllMembers()
      Returns an immutable view of every loaded member.
      Returns:
      list of all members

    • addMember

      public static RegionMember addMember(org.bukkit.OfflinePlayer player, RegionMember.LinkageType type, long linkageId)
      Add a player as member of a region or a member of a sub-area.
      Parameters:
      player - the player
      type - the linkage type from RegionMember.LinkageType
      linkageId - the linkage ID; region ID or sub-area ID
      Returns:
      instance of the new member

    • addMemberToRegion

      public static RegionMember addMemberToRegion(org.bukkit.OfflinePlayer player, Region region)
      Add a player as a member of a region.
      Parameters:
      player - the player
      region - the region
      Returns:
      instance of the new member

    • addMemberToRegion

      public static RegionMember addMemberToRegion(org.bukkit.OfflinePlayer player, long regionId)
      Add a player as a member of a region.
      Parameters:
      player - the player
      regionId - the region ID
      Returns:
      instance of the new member

    • getMembersOfRegion

      public static List<RegionMember> getMembersOfRegion(Region region)
      Returns list of members of a region.
      Parameters:
      region - the region
      Returns:
      list of members of a region

    • getMembersOfRegion

      public static List<RegionMember> getMembersOfRegion(long regionId)
      Returns list of members of a region.
      Parameters:
      regionId - the region ID
      Returns:
      list of members of a region

    • getMemberCount

      public static int getMemberCount()
      Returns the number of members in the server.
      Returns:
      member count

    • getMemberCount

      public static int getMemberCount(Region region)
      Returns the number of members in a region.
      Parameters:
      region - the region
      Returns:
      member count

    • getMemberCount

      public static int getMemberCount(long regionId)
      Returns the number of members in a region.
      Parameters:
      regionId - the region ID
      Returns:
      member count

    • addMemberToSubArea

      public static RegionMember addMemberToSubArea(org.bukkit.OfflinePlayer player, SubArea subArea)
      Add a player as a member of a sub-area.
      Parameters:
      player - the player
      subArea - the sub-area
      Returns:
      instance of the new member

    • addMemberToSubArea

      public static RegionMember addMemberToSubArea(org.bukkit.OfflinePlayer player, long subAreaId)
      Add a player as a member of a sub-area.
      Parameters:
      player - the player
      subAreaId - the sub-area ID
      Returns:
      instance of the new member

    • getMembersOfSubArea

      public static List<RegionMember> getMembersOfSubArea(SubArea subArea)
      Returns list of members of a sub-area.
      Parameters:
      subArea - the sub-area
      Returns:
      list of members of a sub-area

    • getMembersOfSubArea

      public static List<RegionMember> getMembersOfSubArea(long subAreaId)
      Returns list of members of a sub-area.
      Parameters:
      subAreaId - the sub-area ID
      Returns:
      list of members of a sub-area

    • getSubAreaMemberCount

      public static int getSubAreaMemberCount(SubArea subArea)
      Returns the number of members in a sub-area.
      Parameters:
      subArea - the sub-area
      Returns:
      member count

    • getSubAreaMemberCount

      public static int getSubAreaMemberCount(long subAreaId)
      Returns the number of members in a sub-area.
      Parameters:
      subAreaId - the sub-area ID
      Returns:
      member count

    • getAllMembersOfPlayer

      public static List<RegionMember> getAllMembersOfPlayer(org.bukkit.OfflinePlayer player)
      Returns all memberships for a specific player across regions and sub-areas.
      Parameters:
      player - the player
      Returns:
      list of all member entries

    • getAllMembersOfPlayer

      public static List<RegionMember> getAllMembersOfPlayer(UUID playerId)
      Returns all memberships for a specific player across regions and sub-areas.
      Parameters:
      playerId - the player UUID
      Returns:
      list of all member entries

    • getRegionsOfPlayer

      public static List<Long> getRegionsOfPlayer(org.bukkit.OfflinePlayer player)
      Returns all region IDs that a player is a member of.
      Parameters:
      player - the player
      Returns:
      list of region IDs

    • getSubAreasOfPlayer

      public static List<Long> getSubAreasOfPlayer(org.bukkit.OfflinePlayer player)
      Returns all sub-area IDs that a player is a member of.
      Parameters:
      player - the player
      Returns:
      list of sub-area IDs

    • getOnlineMembers

      public static List<org.bukkit.entity.Player> getOnlineMembers(Region region)
      Returns only online members of a region.
      Parameters:
      region - the region
      Returns:
      list of online players

    • getOnlineMembers

      public static List<org.bukkit.entity.Player> getOnlineMembers(long regionId)
      Returns only online members of a region.
      Parameters:
      regionId - the region ID
      Returns:
      list of online players

    • getMemberNames

      public static List<String> getMemberNames(Region region)
      Returns the display names of all members in a region for GUI usage.
      Parameters:
      region - the region
      Returns:
      list of player names

    • getMemberNames

      public static List<String> getMemberNames(long regionId)
      Returns the display names of all members in a region for GUI usage.
      Parameters:
      regionId - the region ID
      Returns:
      list of player names

    • removeMember

      public static void removeMember(long id)
      Remove a member.
      Parameters:
      id - the member ID

    • removeMemberFromRegion

      public static void removeMemberFromRegion(org.bukkit.OfflinePlayer player, Region region)
      Remove a member from a region.
      Parameters:
      player - the player
      region - the region

    • removeMemberFromRegion

      public static void removeMemberFromRegion(org.bukkit.OfflinePlayer player, long regionId)
      Remove a member from a region.
      Parameters:
      player - the player
      regionId - the region ID

    • removeMemberFromSubArea

      public static void removeMemberFromSubArea(org.bukkit.OfflinePlayer player, SubArea subArea)
      Remove a member from a sub-area.
      Parameters:
      player - the player
      subArea - the sub-area

    • removeMemberFromSubArea

      public static void removeMemberFromSubArea(org.bukkit.OfflinePlayer player, long subAreaId)
      Remove a member from a sub-area.
      Parameters:
      player - the player
      subAreaId - the sub-area ID

    • removeAllMembersOfRegion

      public static int removeAllMembersOfRegion(Region region)
      Removes all members from a region.
      Parameters:
      region - the region
      Returns:
      the number of members removed

    • removeAllMembersOfRegion

      public static int removeAllMembersOfRegion(long regionId)
      Removes all members from a region.
      Parameters:
      regionId - the region ID
      Returns:
      the number of members removed

    • removeAllMembersOfSubArea

      public static int removeAllMembersOfSubArea(SubArea subArea)
      Removes all members from a sub-area.
      Parameters:
      subArea - the sub-area
      Returns:
      the number of members removed

    • removeAllMembersOfSubArea

      public static int removeAllMembersOfSubArea(long subAreaId)
      Removes all members from a sub-area.
      Parameters:
      subAreaId - the sub-area ID
      Returns:
      the number of members removed

    • removeAllMembersOfPlayer

      public static int removeAllMembersOfPlayer(org.bukkit.OfflinePlayer player)
      Removes all memberships for a specific player across all regions and sub-areas. Useful for player quit or ban cleanup.
      Parameters:
      player - the player
      Returns:
      the number of memberships removed

    • isMemberOfRegion

      public static boolean isMemberOfRegion(Region region, RegionMember player)
      Checks if a player is a member of a region.
      Parameters:
      region - the region
      player - the player
      Returns:
      true if the player is member, false otherwise

    • isMemberOfRegion

      public static boolean isMemberOfRegion(Region region, org.bukkit.OfflinePlayer player)
      Checks if a player is a member of a region.
      Parameters:
      region - the region
      player - the player
      Returns:
      true if the player is member, false otherwise

    • isMemberOfRegion

      public static boolean isMemberOfRegion(long regionId, org.bukkit.OfflinePlayer player)
      Checks if a player is a member of a region.
      Parameters:
      regionId - the region ID
      player - the player
      Returns:
      true if the player is member, false otherwise

    • isMemberOfRegion

      public static boolean isMemberOfRegion(long regionId, UUID playerId)
      Checks if a player is a member of a region.
      Parameters:
      regionId - the region ID
      playerId - the player UUID
      Returns:
      true if the player is member, false otherwise

    • isMemberOfAnyRegion

      public static boolean isMemberOfAnyRegion(org.bukkit.OfflinePlayer player)
      Checks if a player is a member of any region.
      Parameters:
      player - the player
      Returns:
      true if the player is a member of at least one region

    • isMemberOfSubArea

      public static boolean isMemberOfSubArea(SubArea subArea, RegionMember player)
      Checks if a player is a member of a sub-area.
      Parameters:
      subArea - the sub-area
      player - the player
      Returns:
      true if the player is member, false otherwise

    • isMemberOfSubArea

      public static boolean isMemberOfSubArea(SubArea subArea, org.bukkit.OfflinePlayer player)
      Checks if a player is a member of a sub-area.
      Parameters:
      subArea - the sub-area
      player - the player
      Returns:
      true if the player is member, false otherwise

    • isMemberOfSubArea

      public static boolean isMemberOfSubArea(long subAreaId, org.bukkit.OfflinePlayer player)
      Checks if a player is a member of a sub-area.
      Parameters:
      subAreaId - the sub-area ID
      player - the player
      Returns:
      true if the player is member, false otherwise

    • isMemberOfAnySubArea

      public static boolean isMemberOfAnySubArea(org.bukkit.OfflinePlayer player)
      Checks if a player is a member of any sub-area.
      Parameters:
      player - the player
      Returns:
      true if the player is a member of at least one sub-area

    • getMemberOfRegion

      public static RegionMember getMemberOfRegion(Region region, org.bukkit.OfflinePlayer player)
      Retrieves the member entry for a specific player in a region.
      Parameters:
      region - the region
      player - the player
      Returns:
      the RegionMember, or null if not found

    • getMemberOfRegion

      public static RegionMember getMemberOfRegion(long regionId, org.bukkit.OfflinePlayer player)
      Retrieves the member entry for a specific player in a region.
      Parameters:
      regionId - the region ID
      player - the player
      Returns:
      the RegionMember, or null if not found

    • getMemberOfSubArea

      public static RegionMember getMemberOfSubArea(SubArea subArea, org.bukkit.OfflinePlayer player)
      Retrieves the member entry for a specific player in a sub-area.
      Parameters:
      subArea - the sub-area
      player - the player
      Returns:
      the RegionMember, or null if not found

    • getMemberOfSubArea

      public static RegionMember getMemberOfSubArea(long subAreaId, org.bukkit.OfflinePlayer player)
      Retrieves the member entry for a specific player in a sub-area.
      Parameters:
      subAreaId - the sub-area ID
      player - the player
      Returns:
      the RegionMember, or null if not found

    • setPlayerFlags

      public static boolean setPlayerFlags(Region region, org.bukkit.OfflinePlayer player, long flags)
      Sets the player flags for a member in a region.
      Parameters:
      region - the region
      player - the player
      flags - the new flag bitmask
      Returns:
      true if the member was found and updated

    • setPlayerFlags

      public static boolean setPlayerFlags(long regionId, org.bukkit.OfflinePlayer player, long flags)
      Sets the player flags for a member in a region.
      Parameters:
      regionId - the region ID
      player - the player
      flags - the new flag bitmask
      Returns:
      true if the member was found and updated

    • setControlFlags

      public static boolean setControlFlags(Region region, org.bukkit.OfflinePlayer player, long flags)
      Sets the control flags for a member in a region.
      Parameters:
      region - the region
      player - the player
      flags - the new flag bitmask
      Returns:
      true if the member was found and updated

    • setControlFlags

      public static boolean setControlFlags(long regionId, org.bukkit.OfflinePlayer player, long flags)
      Sets the control flags for a member in a region.
      Parameters:
      regionId - the region ID
      player - the player
      flags - the new flag bitmask
      Returns:
      true if the member was found and updated

    • hasPlayerFlag

      public static boolean hasPlayerFlag(Region region, org.bukkit.OfflinePlayer player, long flag)
      Checks if a member in a region has a specific player flag set.
      Parameters:
      region - the region
      player - the player
      flag - the flag to check
      Returns:
      true if the flag is set, false if member not found or flag not set

    • hasPlayerFlag

      public static boolean hasPlayerFlag(long regionId, org.bukkit.OfflinePlayer player, long flag)
      Checks if a member in a region has a specific player flag set.
      Parameters:
      regionId - the region ID
      player - the player
      flag - the flag to check
      Returns:
      true if the flag is set, false if member not found or flag not set

    • hasControlFlag

      public static boolean hasControlFlag(Region region, org.bukkit.OfflinePlayer player, long flag)
      Checks if a member in a region has a specific control flag set.
      Parameters:
      region - the region
      player - the player
      flag - the flag to check
      Returns:
      true if the flag is set, false if member not found or flag not set

    • hasControlFlag

      public static boolean hasControlFlag(long regionId, org.bukkit.OfflinePlayer player, long flag)
      Checks if a member in a region has a specific control flag set.
      Parameters:
      regionId - the region ID
      player - the player
      flag - the flag to check
      Returns:
      true if the flag is set, false if member not found or flag not set

    • cleanupInvalidMembers

      public static int cleanupInvalidMembers()
      Removes all member entries with invalid references:
      - Players whose UUID no longer maps to a known player
      - Regions that no longer exist (for REGION linkage)
      - Sub-areas that no longer exist (for SUBAREA linkage)
      Returns:
      number of corrupted members removed