org.bukkit.event.entity

Class CreatureSpawnEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.entity.EntityEvent

org.bukkit.event.entity.CreatureSpawnEvent

All Implemented Interfaces:

Cancellable

public class CreatureSpawnEvent
extends EntityEvent
implements Cancellable

Called when a creature is spawned into a world.

If a Creature Spawn event is cancelled, the creature will not spawn.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreatureSpawnEvent.SpawnReason An enum to specify the type of spawning

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

Event.Result

Field Summary

Fields inherited from class org.bukkit.event.entity.EntityEvent

entity

Constructor Summary

Constructors

Constructor and Description
CreatureSpawnEvent(Entity spawnee, CreatureType type, Location loc, CreatureSpawnEvent.SpawnReason reason) Deprecated.
CreatureSpawnEvent(LivingEntity spawnee, CreatureSpawnEvent.SpawnReason spawnReason)

Method Summary

Modifier and Type	Method and Description
CreatureType	getCreatureType() Deprecated. In favour of EntityEvent.getEntityType().
LivingEntity	getEntity() Returns the Entity involved in this event
static HandlerList	getHandlerList()
HandlerList	getHandlers()
Location	getLocation() Gets the location at which the creature is spawning.
CreatureSpawnEvent.SpawnReason	getSpawnReason() Gets the reason for why the creature is being spawned.
boolean	isCancelled() Gets the cancellation state of this event.
void	setCancelled(boolean cancel) Sets the cancellation state of this event.

Methods inherited from class org.bukkit.event.entity.EntityEvent

getEntityType

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

CreatureSpawnEvent

public CreatureSpawnEvent(LivingEntity spawnee,
                          CreatureSpawnEvent.SpawnReason spawnReason)

CreatureSpawnEvent

@Deprecated
public CreatureSpawnEvent(Entity spawnee,
                                       CreatureType type,
                                       Location loc,
                                       CreatureSpawnEvent.SpawnReason reason)

Deprecated.

Method Detail

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

Specified by:

isCancelled in interface Cancellable

Returns:

true if this event is cancelled

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - true if you wish to cancel this event

getEntity

public LivingEntity getEntity()

Description copied from class: EntityEvent

Returns the Entity involved in this event

Overrides:

getEntity in class EntityEvent

Returns:

Entity who is involved in this event

getLocation

public Location getLocation()

Gets the location at which the creature is spawning.

Returns:

The location at which the creature is spawning

getCreatureType

@Deprecated
public CreatureType getCreatureType()

Deprecated. In favour of EntityEvent.getEntityType().

Gets the type of creature being spawned.

Returns:

A CreatureType value detailing the type of creature being spawned

getSpawnReason

public CreatureSpawnEvent.SpawnReason getSpawnReason()

Gets the reason for why the creature is being spawned.

Returns:

A SpawnReason value detailing the reason for the creature being spawned

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()