net.risingworld.api.events.npc

Class NpcSpawnEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.npc.NpcSpawnEvent

All Implemented Interfaces:

Cancellable

public class NpcSpawnEvent
extends Event
implements Cancellable

Called when an npc is about to spawn. Cancelling this event prevents the npc from spawning.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NpcSpawnEvent.Origin

Constructor Summary

Constructors

Constructor and Description
NpcSpawnEvent(Npc npc, Player player, NpcSpawnEvent.Origin origin)

Method Summary

Modifier and Type	Method and Description
int	getGlobalID() Gets the global ID that will be assigned to the npc once it spawns.
Npc	getNpc() Gets the npc that is about to spawn.
NpcSpawnEvent.Origin	getOrigin() Gets the origin of this npc spawn, i.e. the reason why this npc spawns (e.g. natural spawn, or spawned via command etc).
Vector3f	getPosition()
Player	getRelatedPlayer() Returns the related player.
Quaternion	getRotation()
int	getTypeID() Gets the type ID of the npc.
byte	getVariation()
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.
void	setPosition(float x, float y, float z)
void	setPosition(Vector3f position)
void	setRotation(Quaternion rotation)
void	setTypeID(int newTypeID)
void	setVariation(byte newVariation)

Methods inherited from class java.lang.Object

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

Constructor Detail

NpcSpawnEvent

public NpcSpawnEvent(Npc npc,
                     Player player,
                     NpcSpawnEvent.Origin origin)

Method Detail

getNpc

public Npc getNpc()

Gets the npc that is about to spawn.

Returns:

the npc that is about to spawn (unless the event is cancelled).

getGlobalID

public int getGlobalID()

Gets the global ID that will be assigned to the npc once it spawns.

Returns:

the unique global ID of the npc.

getTypeID

public int getTypeID()

Gets the type ID of the npc.

Returns:

the type ID of the npc (i.e. the internal ID of the npc in the definitions table. For example, pigs have ID 1, cows have ID 2 etc).

setTypeID

public void setTypeID(int newTypeID)

getVariation

public byte getVariation()

setVariation

public void setVariation(byte newVariation)

getPosition

public Vector3f getPosition()

setPosition

public void setPosition(Vector3f position)

setPosition

public void setPosition(float x,
                        float y,
                        float z)

getRotation

public Quaternion getRotation()

setRotation

public void setRotation(Quaternion rotation)

getOrigin

public NpcSpawnEvent.Origin getOrigin()

Gets the origin of this npc spawn, i.e. the reason why this npc spawns (e.g. natural spawn, or spawned via command etc).

Returns:

the npc spawn origin.

getRelatedPlayer

public Player getRelatedPlayer()

Returns the related player. This only works if the npc was spawned via command (then the player who executed the command will be returned), otherwise null will be returned.

Returns:

the player who spawned this npc, or null if this npc spawned naturally.

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Determines if the event is cancelled. If an event is cancelled, it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

isCancelled in interface Cancellable

Returns:

true if the event is cancelled, or false if not.

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - set to true if you want to cancel this event.