Package net.risingworld.api.events.player

Class PlayerPlayerInteractionEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.PlayerPlayerInteractionEvent
All Implemented Interfaces:
Cancellable
public final class PlayerPlayerInteractionEvent extends PlayerEvent implements Cancellable
Called when a player interacts (i.e presses the interaction key) with another player. Usually this opens a radial menu with various options (invite to group, trade etc), but this can be suppressed by cancelling this event.

  • Method Details

    • getTargetPlayer

      public Player getTargetPlayer()
      Gets the target player (i.e the other player the player interacts with).
      Returns:
      the other player.
      Example: Disable default player radial menu and show a custom context menu instead
      1@EventMethod
      2public void onPlayerPlayerInteraction(PlayerPlayerInteractionEvent e){
      3 //Cancel the event (so the default radial menu doesn't show up)
      4 e.setCancelled(true);
      5
      6 //Set up the entries for the custom context menu
      7 String[] entries = new String[]{"Kick Player", "View Player Stats", "Set Player Group"};
      8
      9 //Enable the mouse cursor
      10 player.setMouseCursorVisible(true);
      11
      12 //Show the context menu and set up a callback to handle the player selection
      13 player.showContextMenu(entries, (String entry) -> {
      14 //Remember to disable the mouse cursor
      15 player.setMouseCursorVisible(false);
      16
      17 //Now check what the player selected
      18 if(entry.equals(entries[0]){
      19 //kick player
      20 }
      21 else if(entry.equals(entries[1]){
      22 //view player stats
      23 }
      24 else if(entry.equals(entries[2]){
      25 //change player group
      26 }
      27 });
      28}

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