eu.wauz.wauzcore.players

Class WauzPlayerFriends

java.lang.Object

eu.wauz.wauzcore.players.WauzPlayerFriends

public class WauzPlayerFriends
extends java.lang.Object

A class to interact with the friend list of a player.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_FRIEND_AMOUNT The maximum amount of friends a player can have at a time.
private static java.util.Map<java.lang.String,java.lang.String>	requestMap A map of sent friend requests as player uuids.

Constructor Summary

Constructors

Constructor and Description
WauzPlayerFriends()

Method Summary

Modifier and Type	Method and Description
static boolean	addFriend(org.bukkit.entity.Player requestingPlayer, java.lang.String requestedPlayerName) Adds a friend to the player's friend list.
static boolean	canAddFriend(org.bukkit.entity.Player requestingPlayer, org.bukkit.OfflinePlayer requestedPlayer) Checks if a player can add another player as friend.
static int	getFriendCount(org.bukkit.OfflinePlayer player) Gets the number of friends from a player.
static java.util.List<java.lang.String>	getFriendsList(org.bukkit.OfflinePlayer player) Gets the list of uuids from the player's friends.
static void	removeFriend(org.bukkit.entity.Player player, org.bukkit.OfflinePlayer friend) Removes a friend from the player's friend list.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_FRIEND_AMOUNT

public static final int MAX_FRIEND_AMOUNT

The maximum amount of friends a player can have at a time.

See Also:

Constant Field Values

requestMap

private static java.util.Map<java.lang.String,java.lang.String> requestMap

A map of sent friend requests as player uuids.

Constructor Detail

WauzPlayerFriends

public WauzPlayerFriends()

Method Detail

canAddFriend

public static boolean canAddFriend(org.bukkit.entity.Player requestingPlayer,
                                   org.bukkit.OfflinePlayer requestedPlayer)

Checks if a player can add another player as friend.

Parameters:

requestingPlayer - The player who wants to send the friend request.

requestedPlayer - The player that is requested.

Returns:

If a friend request is possible.

See Also:

getFriendsList(OfflinePlayer)

addFriend

public static boolean addFriend(org.bukkit.entity.Player requestingPlayer,
                                java.lang.String requestedPlayerName)

Adds a friend to the player's friend list. If no request was sent before, one will be sent and must be confirmed first.

Parameters:

requestingPlayer - The player who wants to add a friend.

requestedPlayerName - The name of the player that is added.

Returns:

If the friend was added or a request was sent.

See Also:

canAddFriend(Player, OfflinePlayer), getFriendsList(OfflinePlayer), UnicodeUtils.sendChatCommand(Player, String, String, boolean), PlayerConfigurator.setFriendsList(OfflinePlayer, List)

removeFriend

public static void removeFriend(org.bukkit.entity.Player player,
                                org.bukkit.OfflinePlayer friend)

Removes a friend from the player's friend list. Also tries to send a notification to the unfriended player.

Parameters:

player - The player who wants to remove a friend.

friend - The friend that is removed.

See Also:

getFriendsList(OfflinePlayer), PlayerConfigurator.setFriendsList(OfflinePlayer, List)

getFriendCount

public static int getFriendCount(org.bukkit.OfflinePlayer player)

Gets the number of friends from a player.

Parameters:

player - The player to get the friends from.

Returns:

The number of friends.

See Also:

getFriendsList(OfflinePlayer)

getFriendsList

public static java.util.List<java.lang.String> getFriendsList(org.bukkit.OfflinePlayer player)

Gets the list of uuids from the player's friends.

Parameters:

player - The player to get the friends from.

Returns:

The list of friend uuids.

See Also:

PlayerConfigurator.getFriendsList(OfflinePlayer)