Class PlayerCreateAreaEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.PlayerCreateAreaEvent
All Implemented Interfaces:
Cancellable
public final class PlayerCreateAreaEvent extends PlayerEvent implements Cancellable
Called when a player creates a new area (create mode F9 tools).

  • Method Details

    • getPriority

      public int getPriority()
      Gets the area priority. By default it's 0.
      Returns:
      the area priority. The higher the value, the higher the priority.

    • setPriority

      public void setPriority(int priority)
      Sets the area priority.
      Parameters:
      priority - the new priority.

    • getStartPosition

      public Vector3f getStartPosition()
      Gets the selected start position for the area.
      Returns:
      the area start position as Vector3f.

    • setStartPosition

      public void setStartPosition(Vector3f position)
      Sets a new start position for the area.
      Parameters:
      position - the new start position.

    • setStartPosition

      public void setStartPosition(float x, float y, float z)
      Sets a new start position for the area.
      Parameters:
      x - the new start x position.
      y - the new start y position.
      z - the new start z position.

    • getEndPosition

      public Vector3f getEndPosition()
      Gets the selected end position for the area.
      Returns:
      the area end position as Vector3f.

    • setEndPosition

      public void setEndPosition(Vector3f position)
      Sets a new end position for the area.
      Parameters:
      position - the new end position.

    • setEndPosition

      public void setEndPosition(float x, float y, float z)
      Sets a new end position for the area.
      Parameters:
      x - the new end x position.
      y - the new end y position.
      z - the new end z position.

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