PartyAPI.java 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  1. package com.gmail.nossr50.api;
  2. import java.util.List;
  3. import org.bukkit.entity.Player;
  4. import com.gmail.nossr50.party.PartyManager;
  5. import com.gmail.nossr50.util.Users;
  6. public final class PartyAPI {
  7. private PartyAPI() {}
  8. /**
  9. * Get the name of the party a player is in.
  10. * </br>
  11. * This function is designed for API usage.
  12. *
  13. * @param player The player to check the party name of
  14. * @return the name of the player's party
  15. */
  16. public static String getPartyName(Player player) {
  17. return Users.getProfile(player).getParty().getName();
  18. }
  19. /**
  20. * Checks if a player is in a party.
  21. * </br>
  22. * This function is designed for API usage.
  23. *
  24. * @param player The player to check
  25. * @return true if the player is in a party, false otherwise
  26. */
  27. public static boolean inParty(Player player) {
  28. return Users.getProfile(player).inParty();
  29. }
  30. /**
  31. * Check if two players are in the same party.
  32. * </br>
  33. * This function is designed for API usage.
  34. *
  35. * @param playera The first player to check
  36. * @param playerb The second player to check
  37. * @return true if the two players are in the same party, false otherwise
  38. */
  39. public static boolean inSameParty(Player playera, Player playerb) {
  40. return PartyManager.getInstance().inSameParty(playera, playerb);
  41. }
  42. /**
  43. * Get a list of all current party names.
  44. * </br>
  45. * This function is designed for API usage.
  46. *
  47. * @return the list of parties.
  48. */
  49. public static List<String> getParties() {
  50. return PartyManager.getInstance().getParties();
  51. }
  52. /**
  53. * Add a player to a party.
  54. * </br>
  55. * This function is designed for API usage.
  56. *
  57. * @param player The player to add to the party
  58. * @param partyName The party to add the player to
  59. */
  60. public static void addToParty(Player player, String partyName) {
  61. PartyManager.getInstance().addToParty(player, Users.getProfile(player), partyName, null);
  62. }
  63. /**
  64. * Remove a player from a party.
  65. * </br>
  66. * This function is designed for API usage.
  67. *
  68. * @param player The player to remove
  69. */
  70. public static void removeFromParty(Player player) {
  71. PartyManager.getInstance().removeFromParty(player, Users.getProfile(player));
  72. }
  73. /**
  74. * Get the leader of a party.
  75. * </br>
  76. * This function is designed for API usage.
  77. *
  78. * @param partyName The party name
  79. * @return the leader of the party
  80. */
  81. public static String getPartyLeader(String partyName) {
  82. return PartyManager.getInstance().getPartyLeader(partyName);
  83. }
  84. /**
  85. * Set the leader of a party.
  86. * </br>
  87. * This function is designed for API usage.
  88. *
  89. * @param partyName The name of the party to set the leader of
  90. * @param player The player to set as leader
  91. */
  92. public static void setPartyLeader(String partyName, String player) {
  93. PartyManager.getInstance().setPartyLeader(partyName, player);
  94. }
  95. /**
  96. * Get a list of all players in this player's party.
  97. * </br>
  98. * This function is designed for API usage.
  99. *
  100. * @param player The player to check
  101. * @return all the players in the player's party
  102. */
  103. public static List<String> getAllMembers(Player player) {
  104. return PartyManager.getInstance().getAllMembers(player);
  105. }
  106. /**
  107. * Get a list of all online players in this party.
  108. * </br>
  109. * This function is designed for API usage.
  110. *
  111. * @param partyName The party to check
  112. * @return all online players in this party
  113. */
  114. public static List<Player> getOnlineMembers(String partyName) {
  115. return PartyManager.getInstance().getOnlineMembers(partyName);
  116. }
  117. /**
  118. * Get a list of all online players in this player's party.
  119. * </br>
  120. * This function is designed for API usage.
  121. *
  122. * @param player The player to check
  123. * @return all online players in the player's party
  124. */
  125. public static List<Player> getOnlineMembers(Player player) {
  126. return PartyManager.getInstance().getOnlineMembers(player);
  127. }
  128. }