Package net.risingworld.api.events.npc

Klasse NpcSpawnEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.npc.NpcSpawnEvent
Alle implementierten Schnittstellen:
Cancellable
public final class NpcSpawnEvent extends Event implements Cancellable
Called when an npc is about to spawn. Cancelling this event prevents the npc from spawning.

  • Methodendetails

    • getNpc

      public Npc getNpc()
      Gets the npc that is about to spawn.
      Gibt zurück:
      the npc that is about to spawn (unless the event is cancelled).

    • getGlobalID

      public long getGlobalID()
      Gets the global ID that will be assigned to the npc once it spawns.
      Gibt zurück:
      the unique global ID of the npc.

    • getTypeID

      public short getTypeID()
      Gets the type ID of the npc.
      Gibt zurück:
      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(short newTypeID)

    • getVariation

      public int getVariation()

    • setVariation

      public void setVariation(int 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)

    • setRotation

      public void setRotation(float x, float y, float z, float w)

    • 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).
      Gibt zurück:
      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.
      Gibt zurück:
      the player who spawned this npc, or null if this npc spawned naturally.

    • isCancelled

      public boolean isCancelled()
      Beschreibung aus Schnittstelle kopiert: 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.
      Angegeben von:
      isCancelled in Schnittstelle Cancellable
      Gibt zurück:
      true if the event is cancelled, or false if not.

    • setCancelled

      public void setCancelled(boolean cancel)
      Beschreibung aus Schnittstelle kopiert: Cancellable
      Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

      Angegeben von:
      setCancelled in Schnittstelle Cancellable
      Parameter:
      cancel - set to true if you want to cancel this event.
      Example: Cancel "PlayerEnterAreaEvent", i.e prevent player from entering an area
      1//Listener class
      2public class PlayerListener implements Listener{
      3 @EventMethod
      4 public void onEnterArea(PlayerEnterAreaEvent evt){
      5 //Now the player will not be able to enter the area, i.e.
      6 //he will be teleported back to his old position (outside the area)
      7 evt.setCancelled(true);
      8 }
      9}