io.github.nucleuspowered.nucleus.api.nucleusdata

Interface Inmate

All Superinterfaces:

TimedEntry

public interface Inmate
extends TimedEntry

Represents information about a player's jailing.

Method Summary

Modifier and Type	Method and Description
Optional<Instant>	getCreationInstant() Gets the Instant this inmate was jailed, if this information was recorded.
Optional<UUID>	getJailer() The UUID of the jailer, or Optional.empty() if it was the console.
String	getJailName() The jail the player is jailed in.
Optional<org.spongepowered.api.world.Location<org.spongepowered.api.world.World>>	getPreviousLocation() The previous location of the player - which is where they will be sent to upon unjailing.
String	getReason() The reason a player was jailed.

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

expired, getRemainingTime, isCurrentlyTicking

Method Detail

getReason

String getReason()

The reason a player was jailed.

Returns:

The reason.

getJailName

String getJailName()

The jail the player is jailed in.

Returns:

The name of the jail.

getJailer

Optional<UUID> getJailer()

The UUID of the jailer, or Optional.empty() if it was the console.

Returns:

The jailing entities UUID, or Optional.empty() if it was the console.

getPreviousLocation

Optional<org.spongepowered.api.world.Location<org.spongepowered.api.world.World>> getPreviousLocation()

The previous location of the player - which is where they will be sent to upon unjailing.

Returns:

The previous location of the player, if known.

getCreationInstant

Optional<Instant> getCreationInstant()

Gets the Instant this inmate was jailed, if this information was recorded.

Returns:

The instant, if known.

Since:

0.27