Package net.risingworld.api.events.player

Class PlayerObjectInteractionEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.world.PlayerObjectEvent
net.risingworld.api.events.player.PlayerObjectInteractionEvent
All Implemented Interfaces:
Cancellable
public final class PlayerObjectInteractionEvent extends PlayerObjectEvent implements Cancellable
Called when a player interacts (i.e presses the interaction key) with a default game object (e.g furniture). Note that this event will also be triggered when the player interacts with an object which isn't selectable by default (e.g a table).
See Also:

  • Method Details

    • isObjectSelectable

      public boolean isObjectSelectable()
      Gets whether or not the object is actually selectable. This event triggers whenever a player interacts with an object (even if it is not selectable by default), so by calling this function you can determine if the object is actually selectable (e.g torches, doors, chairs, chests, beds etc) or not (e.g tables, torch holder, vases, statues etc).
      Returns:
      true if the object is actually selectable, false if not.

    • getObject

      public ObjectElement getObject()
      Description copied from class: PlayerObjectEvent
      Gets the object element.
      Overrides:
      getObject in class PlayerObjectEvent
      Returns:
      the object element.

    • 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
      Overrides:
      isCancelled in class PlayerObjectEvent
      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
      Overrides:
      setCancelled in class PlayerObjectEvent
      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}