Package net.risingworld.api.events.player.world

Class PlayerConstructionEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.world.PlayerConstructionEvent
All Implemented Interfaces:
Cancellable
Direct Known Subclasses:
PlayerChangeConstructionColorEvent, PlayerCreativeRemoveConstructionEvent, PlayerDestroyConstructionEvent, PlayerEditConstructionEvent, PlayerHitConstructionEvent, PlayerPlaceConstructionEvent, PlayerRemoveConstructionEvent
public abstract class PlayerConstructionEvent extends PlayerEvent implements Cancellable
Base class for any kind of interactions (destroy, pickup, use etc) with construction elements (planks, beams, windows, posters etc).

  • Constructor Details

    • PlayerConstructionEvent

      protected PlayerConstructionEvent(long pointer)

  • Method Details

    • getGlobalID

      public long getGlobalID()
      Gets the unique, global ID of this construction element.
      Returns:
      the global ID of the construction element.

    • getTypeID

      public byte getTypeID()
      Gets the type ID of the construction element.
      Returns:
      the construction element type ID.

    • getTexture

      public int getTexture()
      Gets the texture of the construction element.
      Returns:
      the construction element texture ID.

    • getChunkPositionX

      public int getChunkPositionX()
      Gets the x position of the chunk (which contains the construction element).
      Returns:
      the x chunk position.

    • getChunkPositionY

      public int getChunkPositionY()
      Gets the y position of the chunk (which contains the construction element).
      Returns:
      the y chunk position.

    • getChunkPositionZ

      public int getChunkPositionZ()
      Gets the z position of the chunk (which contains the construction element).
      Returns:
      the z chunk position.

    • getConstructionElement

      protected ConstructionElement getConstructionElement()
      Gets the construction element.
      Returns:
      the construction element.

    • getConstructionDefinition

      public Constructions.ConstructionDefinition getConstructionDefinition()
      Gets the construction definition for this element (this contains meta data about the construction element type).
      Returns:
      the construction element definition.

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