Package net.risingworld.api.events.world

Class ProjectileHitEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.world.ProjectileHitEvent
All Implemented Interfaces:
Cancellable
public final class ProjectileHitEvent extends Event implements Cancellable
Called when a projectile hits a target.
See Also:

  • Method Details

    • getHitPosition

      public Vector3f getHitPosition()
      Gets the world position where the projectile hit the target.
      Returns:
      the hit position, as a Vector3f.

    • getHitNormal

      public Vector3f getHitNormal()
      Gets the normal of the surface which was hit by the projectile.
      Returns:
      the hit normal.

    • getHitVelocity

      public Vector3f getHitVelocity()
      Gets the velocity of the projectile when it hit the target.
      Returns:
      the hit normal.

    • getProjectileDefinition

      public Items.ProjectileDefinition getProjectileDefinition()
      Gets the definition of the projectile that was fired.
      Returns:
      the projectile definition.

    • getHitTarget

      public ProjectileHitEvent.Target getHitTarget()
      Gets the hit target type.
      Returns:
      the hit object, or null if the target is not an object (e.g terrain).

    • getHitObject

      public Object getHitObject()
      Gets the object that was hit. This could be an npc, a player, an object element/plant/construction element, a vehicle etc.
      Returns:
      the hit object, or null if the target is not an object (e.g terrain).

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