Package dev.drawethree.xprison.api.gangs.events

Class GangJoinEvent

java.lang.Object
org.bukkit.event.Event
dev.drawethree.xprison.api.shared.events.XPrisonEvent
dev.drawethree.xprison.api.shared.events.player.XPrisonPlayerEvent
dev.drawethree.xprison.api.gangs.events.GangJoinEvent
All Implemented Interfaces:
org.bukkit.event.Cancellable
public final class GangJoinEvent extends XPrisonPlayerEvent implements org.bukkit.event.Cancellable
Event that is fired when a player joins a gang.

This event is Cancellable, allowing plugins to prevent the player from joining.

  • Nested Class Summary

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

    org.bukkit.event.Event.Result

  • Constructor Summary

    Constructors
    Constructor
    Description
    GangJoinEvent(org.bukkit.OfflinePlayer player, Gang gang)
    Constructs a new GangJoinEvent.

  • Method Summary

    Modifier and Type
    Method
    Description
    static org.bukkit.event.HandlerList
    getHandlerList()
    Gets the static handler list for this event.
    org.bukkit.event.HandlerList
    getHandlers()
    Gets the list of handlers for this event instance.
    boolean
    isCancelled()
    Checks whether the event has been cancelled.
    void
    setCancelled(boolean cancel)
    Sets whether the event should be cancelled.

    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

    • GangJoinEvent

      public GangJoinEvent(org.bukkit.OfflinePlayer player, Gang gang)
      Constructs a new GangJoinEvent.
      Parameters:
      player - the OfflinePlayer who joined the gang
      gang - the Gang being joined

  • Method Details

    • getHandlerList

      public static org.bukkit.event.HandlerList getHandlerList()
      Gets the static handler list for this event.
      Returns:
      the HandlerList

    • getHandlers

      public org.bukkit.event.HandlerList getHandlers()
      Gets the list of handlers for this event instance.
      Specified by:
      getHandlers in class org.bukkit.event.Event
      Returns:
      the HandlerList

    • isCancelled

      public boolean isCancelled()
      Checks whether the event has been cancelled.
      Specified by:
      isCancelled in interface org.bukkit.event.Cancellable
      Returns:
      true if cancelled, false otherwise

    • setCancelled

      public void setCancelled(boolean cancel)
      Sets whether the event should be cancelled.
      Specified by:
      setCancelled in interface org.bukkit.event.Cancellable
      Parameters:
      cancel - true to cancel the event