io.github.nucleuspowered.nucleus.api.module.kit

Interface KitRedeemResult

public interface KitRedeemResult

The result for a successful redemption.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	KitRedeemResult.Status

Method Summary

Modifier and Type	Method and Description
default java.util.Optional<java.time.Duration>	getCooldownDuration() Returns the Duration from getCooldownExpiry() to Instant.now()
java.util.Optional<java.time.Instant>	getCooldownExpiry() Specifies when the next redemption opportunity is.
java.util.Optional<org.spongepowered.api.text.Text>	getMessage() If the redemption was cancelled by an event, gets the associated message.
KitRedeemResult.Status	getStatus() Gets the status of this result.
default boolean	isSuccess() Whether this redemption was a success.
java.util.Collection<org.spongepowered.api.item.inventory.ItemStackSnapshot>	rejectedItems() The items that didn't make it into the inventory if the kit was otherwise successfully redeemed.

Method Detail

isSuccess

default boolean isSuccess()

Whether this redemption was a success.

Returns:

true if so

getStatus

KitRedeemResult.Status getStatus()

Gets the status of this result.

Returns:

The status.

getCooldownExpiry

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

Specifies when the next redemption opportunity is.

• If isSuccess() is true, this returns the next time the Kit can be redeemed by the player.
• Else, if there is still a cooldown attached to this kit and player, the next time this kit may be redeemed.

Returns:

The Instant redemption may next happen, if a cooldown is currently in effect.

getCooldownDuration

default java.util.Optional<java.time.Duration> getCooldownDuration()

Returns the Duration from getCooldownExpiry() to Instant.now()

Returns:

The Duration, if any.

getMessage

java.util.Optional<org.spongepowered.api.text.Text> getMessage()

If the redemption was cancelled by an event, gets the associated message.

Returns:

The associated message, if any.

rejectedItems

java.util.Collection<org.spongepowered.api.item.inventory.ItemStackSnapshot> rejectedItems()

The items that didn't make it into the inventory if the kit was otherwise successfully redeemed.

Returns:

The rejected items.