Package net.risingworld.api.events.player

Class PlayerElementInteractionEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.PlayerElementInteractionEvent
All Implemented Interfaces:
Cancellable
@Deprecated(forRemoval=true) public final class PlayerElementInteractionEvent extends PlayerEvent implements Cancellable
Deprecated, for removal: This API element is subject to removal in a future version.
Do not use! Use PlayerGameObjectHitEvent instead!

  • Field Summary

    Fields inherited from class net.risingworld.api.events.Event

    cancelled, pointer

  • Method Summary

    Modifier and Type
    Method
    Description
    GameObject
    getGameObject()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isCancelled()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Determines if the event is cancelled.
    void
    setCancelled(boolean cancel)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Cancels this event.

    Methods inherited from class net.risingworld.api.events.player.PlayerEvent

    getPlayer

    Methods inherited from class net.risingworld.api.events.Event

    equals, hashCode, isValid

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • getGameObject

      public GameObject getGameObject()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • isCancelled

      public boolean isCancelled()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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}