CorePlugin/com.placeholdername.mcmmo.core.events/PlayerFlagSetEvent

PlayerFlagSetEvent

class PlayerFlagSetEvent : Event

Custom Bukkit event that is fired when a player's flag is set or modified within the McMMO core system.

This event represents a change in a player's flag state, providing both the old and new values for comparison and tracking purposes. Flags are typically used to store player-specific configuration, state information, or temporary data that needs to be tracked across the plugin's lifecycle.

The event can be constructed in two ways:

With a Player object (when the player is online)
With just a UUID (when the player might be offline)

This dual construction approach allows for flag modifications both for online and offline players, providing flexibility in how the plugin manages player data.

Since

1.0.0

Author

McMMO Core Team

Constructors

PlayerFlagSetEvent

constructor(player: Player, flagName: String, oldValue: String?, newValue: String?)

Primary constructor for creating a PlayerFlagSetEvent when the player is online.

constructor(playerUUID: UUID, flagName: String, oldValue: String?, newValue: String?)

Alternative constructor for creating a PlayerFlagSetEvent when only the player's UUID is available.

Types

object Companion

Companion object containing static members for the PlayerFlagSetEvent class.

Properties

val flagName: String

The name/identifier of the flag that is being modified.

val newValue: String?

The new value being assigned to the flag.

val oldValue: String?

The previous value of the flag before this modification occurred.

val player: Player?

The Player object representing the player whose flag is being modified.

val playerUUID: UUID

The unique identifier (UUID) of the player whose flag is being modified.

Functions

open fun callEvent(): Boolean

@NotNull

open fun getEventName(): @NotNull String

open override fun getHandlers(): HandlerList

Returns the HandlerList for this event type.

fun isAsynchronous(): Boolean