Package net.risingworld.api.events.npc

Class NpcTransformEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.npc.NpcTransformEvent
All Implemented Interfaces:
Cancellable
public final class NpcTransformEvent extends Event implements Cancellable
Called when an npc transforms, i.e when the npc id changes. This happens, for example, when a baby animal grows up etc.

  • Method Details

    • getNpc

      public Npc getNpc()
      Gets the npc that's about to transform.
      Returns:
      the npc that's about to transform.

    • getNewTypeID

      public short getNewTypeID()
      Gets the new target npc type ID.
      Returns:
      the new type ID.

    • setNewTypeID

      public void setNewTypeID(short newTypeID)

    • getNewVariant

      public int getNewVariant()
      Gets the new target npc variant. By default 0.
      Returns:
      the new variant.

    • setNewVariant

      public void setNewVariant(int newVariant)

    • getTrigger

      public NpcTransformEvent.Trigger getTrigger()
      Gets the trigger of the npc transformation, i.e what caused the npc to transform.
      Returns:
      the trigger of the npc transformation.

    • getRelatedPlayer

      public Player getRelatedPlayer()
      Gets the player who was involved in this transformation. If no player was involved (e.g if npc just grows up), null is returned.
      Returns:
      the related player, or null if no player was responsible for this transformation.

    • 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.

      Specified by:
      setCancelled in interface Cancellable
      Parameters:
      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}