eu.wauz.wauzcore.events

Class WauzPlayerEventMailClaim

java.lang.Object

eu.wauz.wauzcore.events.WauzPlayerEventMailClaim

All Implemented Interfaces:

WauzPlayerEvent

public class WauzPlayerEventMailClaim
extends java.lang.Object
implements WauzPlayerEvent

An event to let a player claim their mail from the mailbox.

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 org.bukkit.inventory.ItemStack	mailItemStack The item stack, representing the mail content.
private java.lang.String	mailName The name of the mail.

Fields inherited from interface eu.wauz.wauzcore.events.WauzPlayerEvent

core

Constructor Summary

Constructors

Constructor and Description
WauzPlayerEventMailClaim(org.bukkit.entity.Player player, java.lang.String mailName) Creates an event to claim the given mail.

Method Summary

Modifier and Type	Method and Description
boolean	execute(org.bukkit.entity.Player player) Executes the event for the given player.
org.bukkit.inventory.ItemStack	getMailItemStack()

Methods inherited from class java.lang.Object

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

Field Detail

mailName

private java.lang.String mailName

The name of the mail.

mailItemStack

private org.bukkit.inventory.ItemStack mailItemStack

The item stack, representing the mail content.

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

WauzPlayerEventMailClaim

public WauzPlayerEventMailClaim(org.bukkit.entity.Player player,
                                java.lang.String mailName)

Creates an event to claim the given mail.

Parameters:

player - The player who owns the mail.

mailName - The name of the mail.

Method Detail

execute

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

Executes the event for the given player.

Specified by:

execute in interface WauzPlayerEvent

Parameters:

player - The player for the execution.

Returns:

If the event was executed successfully.

See Also:

PlayerMailConfigurator.deletePlayerMail(Player, String)

getMailItemStack

public org.bukkit.inventory.ItemStack getMailItemStack()

Returns:

The item stack, representing the mail content.