Package dev.drawethree.xprison.api.gangs.model

Interface Gang

public interface Gang
Represents a Gang in the XPrison plugin. Provides methods to access gang data, members, invitations, and gang-related actions.

  • Method Summary

    Modifier and Type
    Method
    Description
    Collection<org.bukkit.OfflinePlayer>
    getAllMembers()
    Retrieves all members of the gang, including offline players.
    long
    getGangValue()
    Gets the current value of the gang.
    String
    getName()
    Gets the name of the gang.
    Collection<org.bukkit.entity.Player>
    getOnlineMembers()
    Retrieves a collection of all online members currently in the gang.
    org.bukkit.OfflinePlayer
    getOwnerOffline()
    Gets the gang leader as an OfflinePlayer.
    Collection<GangInvitation>
    getPendingInvites()
    Retrieves a collection of all pending invitations to this gang.
    GangInvitation
    invitePlayer(org.bukkit.OfflinePlayer player)
    Invites a player to join this gang.
    boolean
    isInGang(org.bukkit.OfflinePlayer player)
    Checks whether the given player is a member of this gang.
    boolean
    isOwner(org.bukkit.OfflinePlayer player)
    Checks whether the given player is the leader of this gang.
    void
    removeInvite(GangInvitation invitation)
    Removes a pending invitation from this gang.

  • Method Details

    • getOwnerOffline

      org.bukkit.OfflinePlayer getOwnerOffline()
      Gets the gang leader as an OfflinePlayer.
      Returns:
      the gang leader

    • getName

      String getName()
      Gets the name of the gang.
      Returns:
      the gang name

    • isOwner

      boolean isOwner(org.bukkit.OfflinePlayer player)
      Checks whether the given player is the leader of this gang.
      Parameters:
      player - the player to check
      Returns:
      true if the player is the gang leader, false otherwise

    • isInGang

      boolean isInGang(org.bukkit.OfflinePlayer player)
      Checks whether the given player is a member of this gang.
      Parameters:
      player - the player to check
      Returns:
      true if the player is in the gang, false otherwise

    • getPendingInvites

      Collection<GangInvitation> getPendingInvites()
      Retrieves a collection of all pending invitations to this gang.
      Returns:
      a collection of pending GangInvitations

    • getGangValue

      long getGangValue()
      Gets the current value of the gang. This could represent a score, worth, or ranking metric.
      Returns:
      the numerical value of the gang

    • getOnlineMembers

      Collection<org.bukkit.entity.Player> getOnlineMembers()
      Retrieves a collection of all online members currently in the gang.
      Returns:
      a collection of online Players in the gang

    • getAllMembers

      Collection<org.bukkit.OfflinePlayer> getAllMembers()
      Retrieves all members of the gang, including offline players.
      Returns:
      a collection of all OfflinePlayers in the gang

    • invitePlayer

      GangInvitation invitePlayer(org.bukkit.OfflinePlayer player)
      Invites a player to join this gang. The invitation must be accepted before the player becomes a member.
      Parameters:
      player - the player to invite
      Returns:
      the created GangInvitation

    • removeInvite

      void removeInvite(GangInvitation invitation)
      Removes a pending invitation from this gang. If the invitation has already been accepted or expired, this may have no effect.
      Parameters:
      invitation - the GangInvitation to remove