Class PlayerEvent

java.lang.Object
org.bukkit.event.Event
dev.despical.whackme.api.event.WhackMeEvent
dev.despical.whackme.api.event.player.PlayerEvent
Direct Known Subclasses:
PlayerJoinAttemptEvent, PlayerLeaveGameEvent, PlayerStatisticChangeEvent
public abstract class PlayerEvent extends WhackMeEvent
Base class for Whack Me events associated with one Bukkit player.

getPlayer() provides the live Bukkit entity, while getUser() resolves the plugin-owned user model used for statistics and game membership.

API Note: The player may disconnect between event dispatch and delayed work. Do not retain the Bukkit entity for asynchronous or long-lived operations; retain its UUID instead.

  • Nested Class Summary

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

    org.bukkit.event.Event.Result

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    PlayerEvent(@NotNull org.bukkit.entity.Player player)
    Creates a player-scoped Whack Me event.

  • Method Summary

    Modifier and Type
    Method
    Description
    final @NotNull org.bukkit.entity.Player
    getPlayer()
    Returns the Bukkit player associated with this event.
    final @NotNull User
    getUser()
    Resolves the Whack Me user model associated with the event player.
    String
    toString()
    Returns a compact representation suitable for profiler output.

    Methods inherited from class org.bukkit.event.Event

    callEvent, getEventName, getHandlers, isAsynchronous

    Methods inherited from class Object

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

  • Constructor Details

    • PlayerEvent

      protected PlayerEvent(@NotNull @NotNull org.bukkit.entity.Player player)
      Creates a player-scoped Whack Me event.
      Parameters:
      player - Bukkit player associated with the event

  • Method Details

    • getPlayer

      @NotNull public final @NotNull org.bukkit.entity.Player getPlayer()
      Returns the Bukkit player associated with this event.
      Returns:
      event player

    • getUser

      @NotNull public final @NotNull User getUser()
      Resolves the Whack Me user model associated with the event player.
      Returns:
      plugin user model for the player

    • toString

      public String toString()
      Returns a compact representation suitable for profiler output.
      Overrides:
      toString in class Object
      Returns:
      player detail string