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

Class PlayerInventoryItemEditEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.inventory.PlayerInventoryItemEditEvent
All Implemented Interfaces:
Cancellable
public final class PlayerInventoryItemEditEvent extends PlayerEvent implements Cancellable
Called when an item in inventory gets modified. This happens, for example, if the player changes the shape of a block

  • Constructor Details

    • PlayerInventoryItemEditEvent

      public PlayerInventoryItemEditEvent(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.

    • getNewTypeID

      public short getNewTypeID()
      Gets the new type id. This highly depends on the edit type: For example, when changing the block shape, the new type id describes the id of the new construction element type. In other cases it might be a new item type id instead.
      Returns:
      the new type id.

    • setNewTypeID

      public void setNewTypeID(short id)

    • getNewTexture

      public int getNewTexture()
      Gets the new item texture (if the texture was changed with this action).
      Returns:
      the new texture, otherwise just the old texture of the item.

    • setNewTexture

      public void setNewTexture(int texture)

    • getEditType

      public PlayerInventoryItemEditEvent.EditType getEditType()
      Gets the edit type, i.e what causes the item modification exactly.
      Returns:
      the edit 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}