Package net.risingworld.api.events.player

Class PlayerEnterSectorEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.PlayerEnterSectorEvent
All Implemented Interfaces:
Cancellable
public final class PlayerEnterSectorEvent extends PlayerEvent implements Cancellable
Called when a player enters a new sector (island sector).
See Also:

  • Method Details

    • getNewSectorCoordinates

      public Vector2i getNewSectorCoordinates()
      Gets the coordinates of the new sector.
      Note: Sectors only have two dimensional x and z coordinates (horizontally).
      Since the coordinates are stored in a Vector2i, the z coordinate will be stored in the y value.
      Returns:
      a Vector2i containing the position of the new sector.

    • getOldSectorCoordinates

      public Vector2i getOldSectorCoordinates()
      Gets the coordinates of the old, previous sector.
      Note: Sectors only have two dimensional x and z coordinates (horizontally).
      Since the coordinates are stored in a Vector2i, the z coordinate will be stored in the y value.
      Returns:
      a Vector2i containing the position of the previous sector.

    • getNewPlayerPosition

      public Vector3f getNewPlayerPosition()
      Gets the new player position (within the new sector).
      Returns:
      the new player position.

    • getOldPlayerPosition

      public Vector3f getOldPlayerPosition()
      Gets the previous player position (within the previous sector).
      Returns:
      the old player position.

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