Package net.risingworld.api.events.player

Class PlayerWeaponReloadEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.PlayerWeaponReloadEvent
All Implemented Interfaces:
Cancellable
public final class PlayerWeaponReloadEvent extends PlayerEvent implements Cancellable
Called when a player reloads a weapon.

  • Method Details

    • getWeapon

      public Item getWeapon()
      Gets the related item (the weapon that is reloaded).
      Returns:
      the weapon that is about to be reloaded.

    • getAmmoSlot

      public int getAmmoSlot()
      Gets the slot in inventory which contains the ammo item.
      Returns:
      the inventory ammo slot.

    • getAmmoSlotType

      public Inventory.SlotType getAmmoSlotType()
      Gets the inventory type where the ammo item is located.
      Returns:
      the inventory slot type.

    • setAmmoSlot

      public void setAmmoSlot(int slot, Inventory.SlotType slotType)
      Sets a new slot in inventory for the ammo item. This means that 1 item in that slot will be removed.
      Parameters:
      slot - the new inventory slot.
      slotType - the new slot type. Set null to prevent the game from removing any items.

    • getNewAmmo

      public short getNewAmmo()
      Gets the new amount of ammo/bullets after the reload is done.
      Returns:
      the new amount of bullets in the weapon.

    • setNewAmmo

      public void setNewAmmo(short ammo)
      Changes the amount of bullets in the weapon after the reload is done.
      Parameters:
      ammo - the new amount of bullets.

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