Package com.electro2560.dev.cluescrolls.events

Class PlayerClueCompletedEvent

java.lang.Object
org.bukkit.event.Event
com.electro2560.dev.cluescrolls.events.PlayerClueCompletedEvent
public class PlayerClueCompletedEvent extends org.bukkit.event.Event
Fired when a player completes a clue on one of their clue scrolls.
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
    PlayerClueCompletedEvent(org.bukkit.entity.Player player, String loreFormat, String clueType, double amount, Map<String,String> clueData)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getAmount()
    Returns how many times the clue needed to be completed as defined in the config
    Map<String,String>
    getClueData()
    Map of data key and data value as defined in config for that clue
    String
    getClueType()
    The type of the clue.
    static org.bukkit.event.HandlerList
    getHandlerList()
     
    org.bukkit.event.HandlerList
    getHandlers()
     
    String
    getLoreFormat()
    Returns lore format of clue as defined in the config
    final org.bukkit.entity.Player
    getPlayer()
    Returns the player involved in this event

    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

    • PlayerClueCompletedEvent

      public PlayerClueCompletedEvent(org.bukkit.entity.Player player, String loreFormat, String clueType, double amount, Map<String,String> clueData)

  • Method Details

    • getPlayer

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

    • getLoreFormat

      public String getLoreFormat()
      Returns lore format of clue as defined in the config

      Example - invalid input: '&f'* Kill %amount% skeleton: %completed%

      Returns:
      Lore format of clue
      Since:
      2.1.0

    • getClueType

      public String getClueType()
      The type of the clue.

      Example - break, place, enchant, fish, etc.

      Returns:
      Type of clue
      Since:
      2.1.0

    • getAmount

      public double getAmount()
      Returns how many times the clue needed to be completed as defined in the config
      Returns:
      How many times the clue needed to be completed
      Since:
      2.1.0

    • getClueData

      public Map<String,String> getClueData()
      Map of data key and data value as defined in config for that clue
      Returns:
      Map of keys and meta values from config that are on this clue
      Since:
      2.3.0

    • getHandlers

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

    • getHandlerList

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