io.github.nucleuspowered.nucleus.api.module.jail.data

Interface Jailing

All Superinterfaces:

TimedEntry

public interface Jailing
extends TimedEntry

Represents information about a player's jailing.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.time.Instant>	getCreationInstant() Gets the Instant this inmate was jailed, if this information was recorded.
java.util.Optional<java.util.UUID>	getJailer() The UUID of the jailer, or Optional.empty() if it was the console.
java.lang.String	getJailName() The jail the player is jailed in.
java.util.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.
java.lang.String	getReason() The reason a player was jailed.

Methods inherited from interface io.github.nucleuspowered.nucleus.api.util.data.TimedEntry

expired, getRemainingTime, isCurrentlyTicking

Method Detail

getReason

java.lang.String getReason()

The reason a player was jailed.

Returns:

The reason.

getJailName

java.lang.String getJailName()

The jail the player is jailed in.

Returns:

The name of the jail.

getJailer

java.util.Optional<java.util.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

java.util.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

java.util.Optional<java.time.Instant> getCreationInstant()

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

Returns:

The instant, if known.

Since:

0.27