Package net.risingworld.api.events.npc

Class NpcAddSaddleBagEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.npc.NpcAddSaddleBagEvent
All Implemented Interfaces:
Cancellable
public final class NpcAddSaddleBagEvent extends Event implements Cancellable
Called when a saddle bag is attached to the saddle of an npc/mount.
Please note: The NpcAddClothesEvent is also called when a saddle bag is added

  • Method Details

    • getNpc

      public Npc getNpc()
      Gets the npc/mount a saddle bag will be attached to.
      Returns:
      the mount.

    • getRelatedPlayer

      public Player getRelatedPlayer()
      Gets the player who wants to put the saddle bag on the mount. May be null (if no player was involved in this action).
      Returns:
      the related player (or null if no player was involved).

    • getSaddleBagID

      public short getSaddleBagID()
      Gets the clothing ID of the saddle bag.
      Returns:
      the saddle bag type ID.

    • getClothingDefinition

      public Clothing.ClothingDefinition getClothingDefinition()
      Gets the definition of the saddle bag that's about to be added to the npc.
      Returns:
      the clothing definition.

    • getStorageID

      public long getStorageID()
      Gets the storage ID that will be assigned to the saddle bag.
      Returns:
      the saddle bag storage ID.

    • setStorageID

      public void setStorageID(long id)
      Overrides the storage ID that will be assigned to the saddle bag.
      Parameters:
      id - the new storage ID.

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