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

Interface NucleusJailEvent.Jailed

All Superinterfaces:

org.spongepowered.api.event.Event, NucleusJailEvent, org.spongepowered.api.event.user.TargetUserEvent

Enclosing interface:

NucleusJailEvent

public static interface NucleusJailEvent.Jailed
extends NucleusJailEvent

Fired when a player is jailed.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.nucleuspowered.nucleus.api.module.jail.event.NucleusJailEvent

NucleusJailEvent.Jailed, NucleusJailEvent.Unjailed

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.time.Duration>	getDuration() How long the player is jailed for.
java.lang.String	getJailName() The name of the jail the player is sent to.
org.spongepowered.api.text.Text	getReason() The reason for the jailing.

Methods inherited from interface org.spongepowered.api.event.user.TargetUserEvent

getTargetUser

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Method Detail

getJailName

java.lang.String getJailName()

The name of the jail the player is sent to.

Returns:

The name.

getDuration

java.util.Optional<java.time.Duration> getDuration()

How long the player is jailed for.

Returns:

The Duration, if applicable.

getReason

org.spongepowered.api.text.Text getReason()

The reason for the jailing.

Returns:

The reason.