Package com.electro2560.dev.cluescrolls.events

Class PlayerScrollCompletedEvent

java.lang.Object
org.bukkit.event.Event
com.electro2560.dev.cluescrolls.events.ScrollEvent
com.electro2560.dev.cluescrolls.events.PlayerScrollCompletedEvent
public class PlayerScrollCompletedEvent extends ScrollEvent
Fired when all the clues on a scroll have been completed issuing the rewards.
Since:
2.1.0

  • Nested Class Summary

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

    org.bukkit.event.Event.Result

  • Constructor Summary

    Constructors
    Constructor
    Description
    PlayerScrollCompletedEvent(org.bukkit.entity.Player player, String tierType, UUID scrollUUID, int compeltedClues)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final int
    getCompletedClues()
    Get the amount of clues that were on this scroll
    static org.bukkit.event.HandlerList
    getHandlerList()
     
    org.bukkit.event.HandlerList
    getHandlers()
     
    final org.bukkit.entity.Player
    getPlayer()
    Returns the player involved in this event
    boolean
    isCancelRewards()
    Players will not receive rewards if this is true.
    void
    setCancelRewards(boolean cancel)
    Setting to true will not give the player rewards.

    Methods inherited from class com.electro2560.dev.cluescrolls.events.ScrollEvent

    getScrollUUID, getTierType

    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

    • PlayerScrollCompletedEvent

      public PlayerScrollCompletedEvent(org.bukkit.entity.Player player, String tierType, UUID scrollUUID, int compeltedClues)

  • Method Details

    • getPlayer

      public final org.bukkit.entity.Player getPlayer()
      Returns the player involved in this event
      Returns:
      Player who is involved in this event
      Since:
      2.1.0

    • getCompletedClues

      public final int getCompletedClues()
      Get the amount of clues that were on this scroll
      Returns:
      Clues completed
      Since:
      2.1.0

    • isCancelRewards

      public boolean isCancelRewards()
      Players will not receive rewards if this is true. The scroll will be removed from the player as usual.
      Returns:
      true if the rewards have been cancelled
      Since:
      4.8.6

    • setCancelRewards

      public void setCancelRewards(boolean cancel)
      Setting to true will not give the player rewards. The scroll will be removed from the player as usual.
      Parameters:
      cancel - true if you wish to cancel this event
      Since:
      4.8.6

    • getHandlers

      public org.bukkit.event.HandlerList getHandlers()
      Specified by:
      getHandlers in class org.bukkit.event.Event

    • getHandlerList

      public static org.bukkit.event.HandlerList getHandlerList()