Package dev.majek.pc.api

Class PartyChatApi

java.lang.Object

dev.majek.pc.api.PartyChatApi

public class PartyChatApi
extends Object

Handles PartyChat api methods.

Constructor Summary

Constructors

Constructor	Description
PartyChatApi()

Method Summary

Modifier and Type	Method	Description
void	createParty(@NotNull String name, @NotNull User leader)	Create a new party with a party name and user as the leader.
@Nullable Party	getParty(@NotNull User user)	Get a Party from a User in the party.
@Nullable Party	getParty(@NotNull UUID party)	Get a Party from the party's unique id.
void	reloadPlugin()	Reloads the PartyChat plugin.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PartyChatApi

public PartyChatApi()

Method Detail

reloadPlugin

public void reloadPlugin()

Reloads the PartyChat plugin. If changes have been made to config files these will be applied.

createParty

public void createParty(@NotNull
                        @NotNull String name,
                        @NotNull
                        @NotNull User leader)

Create a new party with a party name and user as the leader. This is a manual creation and will not trigger PartyCreateEvent.

Parameters:

name - The name of the party.

leader - The User who will be leader.

getParty

@Nullable
public @Nullable Party getParty(@NotNull
                                @NotNull User user)

Get a Party from a User in the party.

Parameters:

user - The user who must be in the party. Will return null if user is not in a party.

Returns:

The Party the User is in, if in one.

getParty

@Nullable
public @Nullable Party getParty(@NotNull
                                @NotNull UUID party)

Get a Party from the party's unique id.

Parameters:

party - The party's unique id, note this may NOT be a player id. Will return null if no party with the specified id exists.

Returns:

The Party, if it exists.