Class LightningStrikeEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.world.LightningStrikeEvent
All Implemented Interfaces:
Cancellable
public final class LightningStrikeEvent extends Event implements Cancellable
Called when a lightning strikes a target.

  • Method Details

    • getPosition

      public Vector3f getPosition()
      Gets the global world position of the lightning strike.
      Returns:
      the global position, as a Vector3f

    • getTarget

      public Object getTarget()
      Gets the target that was struck by this lightning. Typically this is either of type Player or Npc.
      Returns:
      the target that was struck by this lightning.
      Example: Check if player was struck
      1@EventMethod
      2public void onLightningStrike(LightningStrikeEvent event){
      3 //Check if a player was struck
      4 if (event.getTarget() instanceof Player player) {
      5 System.out.println("Player " + player.getName() + " was struck by lightning!");
      6 }
      7}

    • setDamage

      public void setDamage(short damage)
      Sets the amount of damage this lightning deals. Set to 0 to prevent this lightning from harming players or npcs.
      Parameters:
      damage - the amount of damage.

    • getDamage

      public short getDamage()
      Gets the amount of damage this lightning deals.
      Returns:
      the amount of damage.

    • isCancelled

      public boolean isCancelled()
      /////////////////////////////////////////////////////////////////////////
      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}