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

Class PlayerInventoryMoveItemEvent

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

  • Constructor Details

    • PlayerInventoryMoveItemEvent

      public PlayerInventoryMoveItemEvent(long pointer)

  • Method Details

    • getItem

      public Item getItem()
      Gets the item that is about to be moved.
      Returns:
      the item.

    • getTargetItem

      public Item getTargetItem()
      Gets the item in the target slot in the storage, i.e the item that will be exchanged with the first item. May be null.
      Returns:
      the item in the target slot (in the storage), or null if there is no item in the target slot.

    • getInventorySlot

      public int getInventorySlot()
      Gets the slot of the item that is about to be moved.
      Returns:
      the item slot in the storage.

    • getInventorySlotType

      public Inventory.SlotType getInventorySlotType()
      Gets the slot type (e.g quickslot, equipment etc) of the item that is about to be moved.
      Returns:
      the inventory slot type.

    • getTargetInventorySlot

      public int getTargetInventorySlot()
      Gets the target slot, i.e the slot the item will be moved to.
      Returns:
      the target slot

    • getTargetInventorySlotType

      public Inventory.SlotType getTargetInventorySlotType()
      Gets the target slot type (e.g quickslot, equipment etc) where the item will be moved to.
      Returns:
      the target inventory slot type.

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