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

Class PlayerObjectEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.world.PlayerObjectEvent
All Implemented Interfaces:
Cancellable
Direct Known Subclasses:
PlayerChangeObjectColorEvent, PlayerChangeObjectInfoEvent, PlayerChangeObjectStatusEvent, PlayerCreativeRemoveObjectEvent, PlayerDestroyObjectEvent, PlayerHitObjectEvent, PlayerObjectInteractionEvent, PlayerPlaceObjectEvent, PlayerRemoveObjectEvent, PlayerStorageAccessEvent
public abstract class PlayerObjectEvent extends PlayerEvent implements Cancellable
Base class for any kind of interactions (destroy, pickup, use etc) with objects (like furniture, doors, lamps etc).

  • Constructor Details

    • PlayerObjectEvent

      protected PlayerObjectEvent(long pointer)

  • Method Details

    • getGlobalID

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

    • getTypeID

      public short getTypeID()
      Gets the type ID of the object.
      Returns:
      the object type ID.

    • getChunkPositionX

      public int getChunkPositionX()
      Gets the x offset of the chunk (which contains the object).
      Returns:
      the x chunk offset.

    • getChunkPositionY

      public int getChunkPositionY()
      Gets the y offset of the chunk (which contains the object).
      Returns:
      the y chunk offset.

    • getChunkPositionZ

      public int getChunkPositionZ()
      Gets the z offset of the chunk (which contains the object).
      Returns:
      the z chunk offset.

    • getObject

      protected ObjectElement getObject()
      Gets the object element.
      Returns:
      the object element.

    • getObjectDefinition

      public Objects.ObjectDefinition getObjectDefinition()
      Gets the object definition for this item (this contains meta data about the object type).
      Returns:
      the object definition.
      Example: Prevent player from destroying chests
      1//In our event listener...
      2@EventMethod
      3public void onObjectDestroy(PlayerDestroyObjectEvent event){
      4 //Get object definition for the related object
      5 Definitions.ObjectDefinition def = event.getObjectDefinition();
      6
      7 //Check if object is a chest (you get this info from the definitions)
      8 if(def.type == Objects.Type.Storage){
      9 //Cancel event (so it does not get executed)
      10 event.setCancelled(true);
      11 }
      12}

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