Package net.risingworld.api.events.player

Class PlayerWeaponFireEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.PlayerWeaponFireEvent
All Implemented Interfaces:
Cancellable
public final class PlayerWeaponFireEvent extends PlayerEvent implements Cancellable
Called when a player fires a weapon (includes firearms and other ranged weapons like bows, but also spears, grenades etc).

  • Method Details

    • getWeapon

      public Item getWeapon()
      Gets the weapon item.
      Returns:
      the weapon the player fires.

    • getAmmoSlot

      public int getAmmoSlot()
      Gets the slot in inventory which contains a related ammo item that is potentially about the be removed. For example, for bows, this would be an arrow item (shooting the bow reduces the arrow item stack by 1 accordingly). If this weapon does not use any separate ammo (e.g rifles where the ammo is chambered), -1 is returned instead.
      Returns:
      the optional inventory ammo slot, or -1 if no external ammo is used.

    • getAmmoSlotType

      public Inventory.SlotType getAmmoSlotType()
      Gets the inventory type where a related ammo item is located, or null if no separate ammo is used by this weapon.
      Returns:
      the inventory slot type.

    • getFirePosition

      public Vector3f getFirePosition()

    • setFirePosition

      public void setFirePosition(Vector3f position)

    • getFireRotation

      public Quaternion getFireRotation()

    • setFireRotation

      public void setFireRotation(Quaternion rotation)

    • getFirePower

      public float getFirePower()

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