Package ml.karmaconfigs.api.bukkit.region.event.player

Class PlayerActionWithRegionEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
ml.karmaconfigs.api.bukkit.region.event.player.PlayerActionWithRegionEvent
All Implemented Interfaces:
org.bukkit.event.Cancellable
public class PlayerActionWithRegionEvent extends org.bukkit.event.player.PlayerEvent implements org.bukkit.event.Cancellable
Entity interact directly or indirectly with a region

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.bukkit.event.Event

    org.bukkit.event.Event.Result

  • Field Summary

    Fields inherited from class org.bukkit.event.player.PlayerEvent

    player

  • Constructor Summary

    Constructors
    Constructor
    Description
    PlayerActionWithRegionEvent​(org.bukkit.entity.Player ent, org.bukkit.block.Block target, InteractAction trigger, Cuboid rg)
    Initialize the entity interact at region event

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable org.bukkit.block.Block
    getBlock()
    the block that is involved in the event
    static org.bukkit.event.HandlerList
    getHandlerList()
    Get a list of event handlers
    @NotNull org.bukkit.event.HandlerList
    getHandlers()
    Get event handler list
    Cuboid
    getRegion()
    Get the region the entity is entering to
    InteractAction
    getTrigger()
    Get the event trigger
    boolean
    isCancelled()
    Gets the cancellation state of this event.
    void
    setCancelled​(boolean cancel)
    Sets the cancellation state of this event.

    Methods inherited from class org.bukkit.event.player.PlayerEvent

    getPlayer

    Methods inherited from class org.bukkit.event.Event

    getEventName, isAsynchronous

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • PlayerActionWithRegionEvent

      public PlayerActionWithRegionEvent​(org.bukkit.entity.Player ent, org.bukkit.block.Block target, InteractAction trigger, Cuboid rg)
      Initialize the entity interact at region event
      Parameters:
      ent - the entity
      target - the target block ( if exists )
      trigger - the action that triggered the event
      rg - the region the entity has interacted in

  • Method Details

    • isCancelled

      public boolean isCancelled()
      Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins
      Specified by:
      isCancelled in interface org.bukkit.event.Cancellable
      Returns:
      true if this event is cancelled

    • getBlock

      @Nullable public @Nullable org.bukkit.block.Block getBlock()
      the block that is involved in the event
      Returns:
      the block

    • getTrigger

      public InteractAction getTrigger()
      Get the event trigger
      Returns:
      the event trigger

    • getRegion

      public Cuboid getRegion()
      Get the region the entity is entering to
      Returns:
      the event region

    • getHandlers

      @NotNull public @NotNull org.bukkit.event.HandlerList getHandlers()
      Get event handler list
      Specified by:
      getHandlers in class org.bukkit.event.Event
      Returns:
      event handler list

    • setCancelled

      public void setCancelled​(boolean cancel)
      Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
      Specified by:
      setCancelled in interface org.bukkit.event.Cancellable
      Parameters:
      cancel - true if you wish to cancel this event

    • getHandlerList

      public static org.bukkit.event.HandlerList getHandlerList()
      Get a list of event handlers
      Returns:
      a list of event handlers