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(PlayerCosmeticEvent): improve Javadocs

Browse Source
This commit is contained in:
Craftinators
2025-01-22 10:54:52 -05:00
parent 216c05ed9b
commit 1f0f8e5f70
1 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
common/src/main/java/com/hibiscusmc/hmccosmetics/api/events/PlayerCosmeticEvent.java
View File

@@ -5,23 +5,22 @@ import org.bukkit.event.Event;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
/** /**
* Represents a cosmetic user related event * Represents an event related to a {@link CosmeticUser}.
*/ */
public abstract class PlayerCosmeticEvent extends PlayerEvent { public abstract class PlayerCosmeticEvent extends PlayerEvent {
protected CosmeticUser user; protected final CosmeticUser user;
public PlayerCosmeticEvent(@NotNull final CosmeticUser who) { public PlayerCosmeticEvent(@NotNull CosmeticUser who) {
super(who.getUniqueId()); super(who.getUniqueId());
user = who; user = who;
} }
/** /**
* Returns the user involved in this event * Returns the user involved in this event.
* *
* @return User who is involved in this event * @return the user who is involved in this event
*/ */
@NotNull public final @NotNull CosmeticUser getUser() {
public final CosmeticUser getUser() {
return user; return user;
} }
} }