eu.wauz.wauzcore.players

Class WauzPlayerMail

java.lang.Object

eu.wauz.wauzcore.players.WauzPlayerMail

public class WauzPlayerMail
extends java.lang.Object

A mail with optional attachment, that can be send to a player.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
private long	coinAttachment The coin attachment of the mail.
private org.bukkit.inventory.ItemStack	itemAttachment The item attachment of the mail.
private static java.lang.String	MAIL_TOKEN_KEY The configuration key for the amount of sent mails.
static int	MAX_MAILS_PER_DAY The maximum amount of mails, a player can send per day.
private org.bukkit.OfflinePlayer	receiver The receiver of the mail.
private java.lang.String	textContent The text content of the mail.

Constructor Summary

Constructors

Constructor and Description
WauzPlayerMail()

Method Summary

Modifier and Type	Method and Description
static boolean	canSendMail(org.bukkit.entity.Player player) Checks if a player can send more mails today.
static int	getMailsSentToday(org.bukkit.entity.Player player) Gets the amount of mails sent for the current date.
void	joinAndSetTextContent(java.lang.String[] textParts, int startingIndex) Joins the given text parts and sets them as text content of the mail.
void	send(org.bukkit.entity.Player player) Sends the configured mail to its receiver.
boolean	tryToSetCoins(org.bukkit.entity.Player player, java.lang.String coinAmount) Tries to set the coin attachment of the mail.
boolean	tryToSetItemStack(org.bukkit.entity.Player player) Tries to set the item attachment of the mail.
boolean	tryToSetReceiver(org.bukkit.entity.Player player, java.lang.String receiverName) Tries to set the receiver of the mail.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_MAILS_PER_DAY

public static final int MAX_MAILS_PER_DAY

The maximum amount of mails, a player can send per day.

See Also:

Constant Field Values

MAIL_TOKEN_KEY

private static final java.lang.String MAIL_TOKEN_KEY

The configuration key for the amount of sent mails.

See Also:

Constant Field Values

receiver

private org.bukkit.OfflinePlayer receiver

The receiver of the mail.

textContent

private java.lang.String textContent

The text content of the mail.

coinAttachment

private long coinAttachment

The coin attachment of the mail.

itemAttachment

private org.bukkit.inventory.ItemStack itemAttachment

The item attachment of the mail.

Constructor Detail

WauzPlayerMail

public WauzPlayerMail()

Method Detail

canSendMail

public static boolean canSendMail(org.bukkit.entity.Player player)

Checks if a player can send more mails today.

Parameters:

player - The player to check for.

Returns:

If the player can send more mails today.

getMailsSentToday

public static int getMailsSentToday(org.bukkit.entity.Player player)

Gets the amount of mails sent for the current date.

Parameters:

player - The player that sent the mails.

Returns:

The amount of mails sent today.

See Also:

WauzDateUtils.getDateLong(), PlayerCollectionConfigurator.getTokenLimitDate(Player, String), PlayerCollectionConfigurator.getTokenLimitAmount(Player, String)

tryToSetReceiver

public boolean tryToSetReceiver(org.bukkit.entity.Player player,
                                java.lang.String receiverName)

Tries to set the receiver of the mail.

Parameters:

player - The player who is sending the mail.

receiverName - The name of the player, receiving the mail.

Returns:

If it was successful.

tryToSetCoins

public boolean tryToSetCoins(org.bukkit.entity.Player player,
                             java.lang.String coinAmount)

Tries to set the coin attachment of the mail.

Parameters:

player - The player who is sending the mail.

coinAmount - The amount of coins to attach.

Returns:

If it was successful.

tryToSetItemStack

public boolean tryToSetItemStack(org.bukkit.entity.Player player)

Tries to set the item attachment of the mail.

Parameters:

player - The player who is sending the mail and holds the item.

Returns:

If it was successful.

joinAndSetTextContent

public void joinAndSetTextContent(java.lang.String[] textParts,
                                  int startingIndex)

Joins the given text parts and sets them as text content of the mail.

Parameters:

textParts - The text part array.

startingIndex - The array index of the first text part to use.

send

public void send(org.bukkit.entity.Player player)

Sends the configured mail to its receiver. Also takes away the attachment from your inventory and updates the daily mail limit.

Parameters:

player - The player who is sending the mail.

See Also:

PlayerMailConfigurator, PlayerCollectionConfigurator.setTokenLimitDate(Player, String, long), PlayerCollectionConfigurator.setTokenLimitAmount(Player, String, int)