Package net.risingworld.api.events.player.inventory

Class PlayerInventoryAddItemEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.inventory.PlayerInventoryAddItemEvent
All Implemented Interfaces:
Cancellable
public final class PlayerInventoryAddItemEvent extends PlayerEvent implements Cancellable
Called when an item is added to the players inventory.

  • Constructor Details

    • PlayerInventoryAddItemEvent

      public PlayerInventoryAddItemEvent(long pointer)

  • Method Details

    • getItem

      public Item getItem()
      Gets the item.
      Returns:
      the item.

    • getInventorySlot

      public int getInventorySlot()
      Gets the inventory slot.
      Returns:
      the item slot in the inventory.

    • getInventorySlotType

      public Inventory.SlotType getInventorySlotType()
      Gets the inventory slot type (e.g quickslot, equipment etc).
      Returns:
      the inventory slot type.

    • getOrigin

      public PlayerInventoryAddItemEvent.Origin getOrigin()
      Gets the origin of the item, i.e where the player got this item from (i.e if he picked it up, if he got the item by deconstructing an object or harvesting plants etc).
      Returns:
      the origin.

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