Package com.griefdefender.api

Interface Clan

All Superinterfaces:
CatalogType
public interface Clan extends CatalogType

  • Method Details

    • getNameComponent

      net.kyori.adventure.text.Component getNameComponent()
      Get clan name Component.
      Returns:
      The clan name

    • getTagComponent

      net.kyori.adventure.text.Component getTagComponent()
      Get clan tag Component
      Returns:
      The clan tag

    • getTag

      String getTag()
      Get clan tag name.
      Returns:
      The clan tag

    • getDescription

      String getDescription()
      Get clan description
      Returns:
      The clan description

    • getBaseWorldUniqueId

      @Nullable UUID getBaseWorldUniqueId()
      Get clan's base world UUID.
      Returns:
      The clan's base world uuid

    • getBasePos

      @Nullable com.flowpowered.math.vector.Vector3i getBasePos()
      Get clan's base position.
      Returns:
      The clan's base pos

    • getHomes

      List<ClanHome> getHomes()
      A list of ClanHome's.
      Returns:
      An unmodifiable list of clan homes

    • getAllies

      List<Clan> getAllies()
      Get list of clan allies.
      Returns:
      An unmodifiable list of clan allies

    • getRivals

      List<Clan> getRivals()
      Get list of clan rivals.
      Returns:
      An unmodifiable list of clan rivals

    • getMembers

      default List<ClanPlayer> getMembers()
      Get list of clan member ClanPlayer's
      Returns:
      The clan member list

    • getMembers

      List<ClanPlayer> getMembers(boolean onlineOnly)
      Get list of clan member ClanPlayer's
      Parameters:
      onlineOnly - Whether the list should contain online members only
      Returns:
      The clan member list

    • getLeaders

      default List<ClanPlayer> getLeaders()
      Get list of clan leader ClanPlayer's
      Returns:
      The clan leader list

    • getLeaders

      List<ClanPlayer> getLeaders(boolean onlineOnly)
      Get list of clan leader ClanPlayer's
      Parameters:
      onlineOnly - Whether the list should contain online leaders only
      Returns:
      The clan leader list

    • getRanks

      List<Rank> getRanks()
      Get list of available clan ranks.
      Returns:
      The clan rank list

    • getRank

      @Nullable Rank getRank(String rankName)
      Gets Rank with specified name.
      Parameters:
      rank - The rank name
      Returns:
      The rank

    • isAlly

      boolean isAlly(String tag)
      Checks if clan tag is ally.
      Parameters:
      tag - The clan tag to check
      Returns:
      true if ally, false if not

    • isRival

      boolean isRival(String tag)
      Checks if clan tag is rival.
      Parameters:
      tag - The clan tag to check
      Returns:
      true if rival, false if not