Package net.risingworld.api.events.player

Class PlayerPickupItemEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.PlayerPickupItemEvent
All Implemented Interfaces:
Cancellable
public final class PlayerPickupItemEvent extends PlayerEvent implements Cancellable
Called when the player picks up a world item.
Note that a PlayerInventoryAddItemEvent will also be called, unless you cancel this event.
See Also:

  • Method Details

    • getItem

      public WorldItem getItem()
      Gets the item the player wants to pick up.
      Returns:
      the item.

    • getTargetInventorySlot

      public int getTargetInventorySlot()
      Gets the destinated slot in the players inventory where the item will be added to.
      Returns:
      the target slot in inventory.

    • getTargetInventorySlotType

      public Inventory.SlotType getTargetInventorySlotType()
      Gets the destinated inventory / slot type in the players inventory where the item will be added to.
      Returns:
      the target slot type in inventory.

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