io.github.nucleuspowered.nucleus.api.nucleusdata

Interface Warning

All Superinterfaces:

TimedEntry

public interface Warning
extends TimedEntry

Information about a player's warning.

Method Summary

Modifier and Type	Method and Description
Instant	getDate() When the warning was issued.
String	getReason() The reason for the warning.
Optional<UUID>	getWarner() The UUID of the player who issued the warning, or Optional.empty() if it was the console.
boolean	isExpired() Whether the warning has expired.

Methods inherited from interface io.github.nucleuspowered.nucleus.api.nucleusdata.TimedEntry

expired, getRemainingTime, isCurrentlyTicking

Method Detail

getWarner

Optional<UUID> getWarner()

The UUID of the player who issued the warning, or Optional.empty() if it was the console.

Returns:

The UUID of the warning player.

getDate

Instant getDate()

When the warning was issued.

Returns:

The Instant the warning was issued.

getReason

String getReason()

The reason for the warning.

Returns:

The reason.

isExpired

boolean isExpired()

Whether the warning has expired.

Returns:

true if so.