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

Browse Source
This commit is contained in:
Craftinators
2025-01-22 11:03:40 -05:00
parent 2a0aa1593a
commit c591641754
1 changed files with 12 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
common/src/main/java/com/hibiscusmc/hmccosmetics/api/events/PlayerCosmeticHideEvent.java
View File

@@ -6,25 +6,26 @@ import org.bukkit.event.HandlerList;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
/** /**
* Called when cosmetics are hidden from a player * Called when cosmetics are hidden from a player.
*/ */
public class PlayerCosmeticHideEvent extends PlayerCosmeticEvent implements Cancellable { public class PlayerCosmeticHideEvent extends PlayerCosmeticEvent implements Cancellable {
private static final HandlerList handlers = new HandlerList(); private static final HandlerList HANDLER_LIST = new HandlerList();
private boolean cancel = false;
private final CosmeticUser.HiddenReason reason; private final CosmeticUser.HiddenReason reason;
private boolean cancel = false;
public PlayerCosmeticHideEvent(@NotNull CosmeticUser who, @NotNull CosmeticUser.HiddenReason reason) { public PlayerCosmeticHideEvent(@NotNull CosmeticUser who, @NotNull CosmeticUser.HiddenReason reason) {
super(who); super(who);
this.reason = reason; this.reason = reason;
} }
/** /**
* Gets the {@link CosmeticUser.HiddenReason} as to why cosmetics are being hidden for the player * Gets the {@link CosmeticUser.HiddenReason} as to why cosmetics are being hidden for the player.
* *
* @return The {@link CosmeticUser.HiddenReason} why cosmetics are being hidden for the player * @return the {@link CosmeticUser.HiddenReason} why cosmetics are being hidden for the player
*/ */
@NotNull public @NotNull CosmeticUser.HiddenReason getReason() {
public CosmeticUser.HiddenReason getReason() {
return reason; return reason;
} }
@@ -33,28 +34,17 @@ public class PlayerCosmeticHideEvent extends PlayerCosmeticEvent implements Canc
return cancel; return cancel;
} }
/**
* Sets the cancellation state of this event
*
* <p>
* Canceling this event will prevent the player from hiding cosmetics
* </p>
*
* @param cancel true if you wish to cancel this event
*/
@Override @Override
public void setCancelled(boolean cancel) { public void setCancelled(boolean cancel) {
this.cancel = cancel; this.cancel = cancel;
} }
@Override @Override
@NotNull public @NotNull HandlerList getHandlers() {
public HandlerList getHandlers() { return HANDLER_LIST;
return handlers;
} }
@NotNull public static @NotNull HandlerList getHandlerList() {
public static HandlerList getHandlerList() { return HANDLER_LIST;
return handlers;
} }
} }