public interface PartiesAPI
Modifier and Type | Method and Description |
---|---|
default Status |
addPlayerIntoParty(PartyPlayer player,
Party party)
Deprecated.
use Party.addMember(PartyPlayer) instead
|
boolean |
areInTheSameParty(UUID player1,
UUID player2)
Check if the given players are in the same party
|
default void |
broadcastPartyMessage(Party party,
PartyPlayer player,
String message)
Deprecated.
use Party.broadcastMessage(String, PartyPlayer) instead
|
boolean |
createParty(@Nullable String party,
@Nullable PartyPlayer leader)
Create a party
|
default Status |
deleteParty(Party party)
Deprecated.
use Party.delete() instead
|
@NotNull Set<PartyColor> |
getColors()
Get the list of available colors
|
@NotNull List<Party> |
getOnlineParties()
Get online parties
|
default Set<PartyPlayer> |
getOnlinePlayers(Party party)
Deprecated.
use Party.getOnlineMembers(boolean) instead
|
PartiesOptions |
getOptions()
Get main plugin options
|
@NotNull LinkedList<Party> |
getPartiesListByExperience(int numberOfParties,
int offset)
Get list of parties ordered by number of experience
|
@NotNull LinkedList<Party> |
getPartiesListByKills(int numberOfParties,
int offset)
Get list of parties ordered by number of kills
|
@NotNull LinkedList<Party> |
getPartiesListByMembers(int numberOfParties,
int offset)
Get list of parties ordered by number of members
|
@NotNull LinkedList<Party> |
getPartiesListByName(int numberOfParties,
int offset)
Get list of parties ordered by name
|
@NotNull LinkedList<Party> |
getPartiesListByOnlineMembers(int numberOfParties,
int offset)
Get list of parties ordered by number of online members
|
@Nullable Party |
getParty(@NotNull String party)
Get the party by its name
|
@Nullable Party |
getParty(@NotNull UUID party)
Get the party by its id
|
@Nullable Party |
getPartyOfPlayer(@NotNull UUID uuid)
Get the party of the player
|
@Nullable PartyPlayer |
getPartyPlayer(@NotNull UUID uuid)
Get the player by his
UUID |
@NotNull Set<PartyRank> |
getRanks()
Get the list of available ranks
|
boolean |
isBungeeCordEnabled()
Check if the plugin have BungeeCord option enabled
|
default boolean |
isPlayerInParty(UUID player)
Is the player in a party?
|
default void |
refreshOnlinePlayers(Party party)
Deprecated.
no longer needed
|
default void |
reloadParties()
Deprecated.
use reloadPlugin() instead
|
void |
reloadPlugin()
Reload Parties configuration files
|
default Status |
removePlayerFromParty(PartyPlayer player)
Deprecated.
use Party.removeMember(PartyPlayer) instead
|
default void |
updateParty(Party party)
Deprecated.
no longer needed
|
default void |
updatePartyPlayer(PartyPlayer player)
Deprecated.
no longer needed
|
PartiesOptions getOptions()
PartiesOptions
void reloadPlugin()
boolean isBungeeCordEnabled()
boolean createParty(@Nullable @Nullable String party, @Nullable @Nullable PartyPlayer leader)
party
- the party nameleader
- the leader of the party as PartyPlayer
, null if the party should be fixed@Nullable @Nullable Party getParty(@NotNull @NotNull String party)
@Nullable @Nullable PartyPlayer getPartyPlayer(@NotNull @NotNull UUID uuid)
UUID
uuid
- the UUID
of the playerPartyPlayer
of the relative player@Nullable @Nullable Party getPartyOfPlayer(@NotNull @NotNull UUID uuid)
@NotNull @NotNull List<Party> getOnlineParties()
Party
@NotNull @NotNull Set<PartyRank> getRanks()
PartyRank
@NotNull @NotNull Set<PartyColor> getColors()
PartyColor
@Deprecated default void reloadParties()
@Deprecated default void updateParty(Party party)
party
- the Party
to save@Deprecated default void updatePartyPlayer(PartyPlayer player)
player
- the PartyPlayer
to save@Deprecated default void broadcastPartyMessage(Party party, PartyPlayer player, String message)
null
player.party
- the Party
that will see the messageplayer
- the PartyPlayer
who sent the messagemessage
- the message to broadcast@Deprecated default Status addPlayerIntoParty(PartyPlayer player, Party party)
player
- the PartyPlayer
to insertparty
- the Party
Status
@Deprecated default Status removePlayerFromParty(PartyPlayer player)
player
- the PartyPlayer
to removeStatus
@Deprecated default Status deleteParty(Party party)
@Deprecated default Set<PartyPlayer> getOnlinePlayers(Party party)
party
- the Party
Set<PartyPlayer>
, if the party
doesn't exist returns null
@Deprecated default void refreshOnlinePlayers(Party party)
party
- the Party
default boolean isPlayerInParty(UUID player)
player
- the player UUID to check@NotNull @NotNull LinkedList<Party> getPartiesListByName(int numberOfParties, int offset)
numberOfParties
- number of parties to getoffset
- offset of parties listParty
@NotNull @NotNull LinkedList<Party> getPartiesListByOnlineMembers(int numberOfParties, int offset)
numberOfParties
- number of parties to getoffset
- offset of parties listParty
@NotNull @NotNull LinkedList<Party> getPartiesListByMembers(int numberOfParties, int offset)
numberOfParties
- number of parties to getoffset
- offset of parties listParty
@NotNull @NotNull LinkedList<Party> getPartiesListByKills(int numberOfParties, int offset)
numberOfParties
- number of parties to getoffset
- offset of parties listParty
@NotNull @NotNull LinkedList<Party> getPartiesListByExperience(int numberOfParties, int offset)
numberOfParties
- number of parties to getoffset
- offset of parties listParty
Copyright © 2023. All rights reserved.