Repo-Mirror/HMCCosmetics
9
0
Fork 0
mirror of https://github.com/HibiscusMC/HMCCosmetics.git synced 2025-12-19 15:09:19 +00:00
Code Issues Releases Activity

docs(PlayerEvent): improve Javadocs

Browse Source
This commit is contained in:
Craftinators
2025-01-22 10:55:04 -05:00
parent 1f0f8e5f70
commit f6a1438299
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
common/src/main/java/com/hibiscusmc/hmccosmetics/api/events/PlayerEvent.java
View File

@@ -5,20 +5,22 @@ import org.jetbrains.annotations.NotNull;
import java.util.UUID; import java.util.UUID;
/**
* Represents an event related to a {@link org.bukkit.entity.Player}.
*/
public abstract class PlayerEvent extends Event { public abstract class PlayerEvent extends Event {
protected final UUID player;
protected UUID player; public PlayerEvent(@NotNull UUID uuid) {
public PlayerEvent(@NotNull final UUID uuid) {
this.player = uuid; this.player = uuid;
} }
/** /**
* Returns the UUID of the player involved in this event * Returns the {@link UUID} of the player involved in this event.
* @return User who is involved in this event *
* @return the UUID of the player who is involved in this event
*/ */
@NotNull public final @NotNull UUID getUniqueId() {
public final UUID getUniqueId() {
return player; return player;
} }
} }