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

Class PlayerStorageToInventoryEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.inventory.PlayerStorageToInventoryEvent
All Implemented Interfaces:
Cancellable
public final class PlayerStorageToInventoryEvent extends PlayerEvent implements Cancellable
Called when an item is moved from a storage (e.g a chest) to the player inventory.

  • Constructor Details

    • PlayerStorageToInventoryEvent

      public PlayerStorageToInventoryEvent(long pointer)

  • Method Details

    • getStorageID

      public long getStorageID()
      Gets the ID of the storage.
      Returns:
      the storage ID.

    • getStorage

      public Storage getStorage()
      Gets the storage.
      Returns:
      the storage.

    • getAmount

      public int getAmount()
      Gets the amount of items that will be moved to the inventory. This is only relevant if the player splits a stack and only moves a single item to the inventory, for example.
      Returns:
      the amount of items that will be moved to the inventory.

    • getItem

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

    • getTargetItem

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

    • getStorageSlot

      public int getStorageSlot()
      Gets the item slot in the storage (where the player got the item from).
      Returns:
      the item slot in the storage.

    • getTargetInventorySlot

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

    • getTargetInventorySlotType

      public Inventory.SlotType getTargetInventorySlotType()
      Gets the target inventory slot type (e.g quickslot, equipment etc) where the item will be moved to.
      Returns:
      the target slot type in the 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}