org.bukkit.event.player
Class PlayerEggThrowEvent

java.lang.Object
  org.bukkit.event.Event
      org.bukkit.event.player.PlayerEvent
          org.bukkit.event.player.PlayerEggThrowEvent

public class PlayerEggThrowEvent
extends PlayerEvent

Called when a player throws an egg and it might hatch

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Field Summary

Fields inherited from class org.bukkit.event.player.PlayerEvent

player

Constructor Summary

PlayerEggThrowEvent(Player player, Egg egg, boolean hatching, byte numHatches, CreatureType hatchingType)
Deprecated.

PlayerEggThrowEvent(Player player, Egg egg, boolean hatching, byte numHatches, EntityType hatchingType)

Method Summary

Egg	getEgg() Gets the egg involved in this event.
static HandlerList	getHandlerList()
HandlerList	getHandlers()
EntityType	getHatchingType() Get the type of the mob being hatched (EntityType.CHICKEN by default)
CreatureType	getHatchType() Deprecated. In favour of getHatchingType().
byte	getNumHatches() Get the number of mob hatches from the egg.
boolean	isHatching() Gets whether the egg is hatching or not.
void	setHatching(boolean hatching) Sets whether the egg will hatch or not.
void	setHatchingType(EntityType hatchType) Change the type of mob being hatched by the egg
void	setHatchType(CreatureType hatchType) Deprecated. In favour of setHatchingType(EntityType).
void	setNumHatches(byte numHatches) Change the number of mobs coming out of the hatched egg The boolean hatching will override this number.

Methods inherited from class org.bukkit.event.player.PlayerEvent

getPlayer

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerEggThrowEvent

public PlayerEggThrowEvent(Player player,
                           Egg egg,
                           boolean hatching,
                           byte numHatches,
                           EntityType hatchingType)

PlayerEggThrowEvent

@Deprecated
public PlayerEggThrowEvent(Player player,
                                      Egg egg,
                                      boolean hatching,
                                      byte numHatches,
                                      CreatureType hatchingType)

Deprecated.

Method Detail

getEgg

public Egg getEgg()

Gets the egg involved in this event.

Returns:

the egg involved in this event

isHatching

public boolean isHatching()

Gets whether the egg is hatching or not. Will be what the server would've done without interaction.

Returns:

boolean Whether the egg is going to hatch or not

setHatching

public void setHatching(boolean hatching)

Sets whether the egg will hatch or not.

Parameters:

hatching - true if you want the egg to hatch false if you want it not to

getHatchType

@Deprecated
public CreatureType getHatchType()

Deprecated. In favour of getHatchingType().

Get the type of the mob being hatched (EntityType.CHICKEN by default)

Returns:

The type of the mob being hatched by the egg

getHatchingType

public EntityType getHatchingType()

Get the type of the mob being hatched (EntityType.CHICKEN by default)

Returns:

The type of the mob being hatched by the egg

setHatchType

@Deprecated
public void setHatchType(CreatureType hatchType)

Deprecated. In favour of setHatchingType(EntityType).

Change the type of mob being hatched by the egg

Parameters:

hatchType - The type of the mob being hatched by the egg

setHatchingType

public void setHatchingType(EntityType hatchType)

Change the type of mob being hatched by the egg

Parameters:

hatchType - The type of the mob being hatched by the egg

getNumHatches

public byte getNumHatches()

Get the number of mob hatches from the egg. By default the number will be he number the server would've done

7/8 chance of being 0 31/256 ~= 1/8 chance to be 1 1/256 chance to be 4

Returns:

The number of mobs going to be hatched by the egg

setNumHatches

public void setNumHatches(byte numHatches)

Change the number of mobs coming out of the hatched egg

The boolean hatching will override this number. Ie. If hatching = false, this number will not matter

Parameters:

numHatches - The number of mobs coming out of the egg

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()