net.tridentsdk.event.player

Class PlayerConsumeEvent

java.lang.Object

net.tridentsdk.event.Event

net.tridentsdk.event.player.PlayerEvent

net.tridentsdk.event.player.PlayerHungerEvent

net.tridentsdk.event.player.PlayerConsumeEvent

All Implemented Interfaces:

Cancellable

public class PlayerConsumeEvent
extends PlayerHungerEvent

Called when a player consumes food, or potions

Since:

0.3-alpha-DP

Author:

The TridentSDK Team

Constructor Summary

Constructors

Constructor and Description
PlayerConsumeEvent(Player player, Item item, double feed)

Method Summary

Modifier and Type	Method and Description
void	cancel(boolean cancelled)
boolean	isIgnored()
Item	item()
double	replenishAmount()
void	setReplenishAmount(double feed)

Methods inherited from class net.tridentsdk.event.player.PlayerHungerEvent

feed, setFeed

Methods inherited from class net.tridentsdk.event.player.PlayerEvent

player

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerConsumeEvent

public PlayerConsumeEvent(Player player,
                          Item item,
                          double feed)

Parameters:

player - the player associated with this event

feed - the amount of hunger replenished

item - the item consumed

Method Detail

replenishAmount

public double replenishAmount()

Returns:

return the amount of hunger replenished

setReplenishAmount

public void setReplenishAmount(double feed)

Parameters:

feed - the amount of hunger replenished

item

public Item item()

Returns:

return the item consumed

isIgnored

public boolean isIgnored()

Specified by:

isIgnored in interface Cancellable

Overrides:

isIgnored in class PlayerHungerEvent

Returns:

return true if event is set to cancelled

cancel

public void cancel(boolean cancelled)

Specified by:

cancel in interface Cancellable

Overrides:

cancel in class PlayerHungerEvent

Parameters:

cancelled - set the cancellation state of the event