io.github.nucleuspowered.nucleus.api.events

Interface NucleusKitEvent.Redeem

All Superinterfaces:

org.spongepowered.api.event.Event, NucleusKitEvent, org.spongepowered.api.event.entity.TargetEntityEvent, org.spongepowered.api.event.entity.living.humanoid.TargetHumanoidEvent, org.spongepowered.api.event.entity.living.TargetLivingEvent, org.spongepowered.api.event.entity.living.humanoid.player.TargetPlayerEvent

All Known Subinterfaces:

NucleusKitEvent.Redeem.Failed, NucleusKitEvent.Redeem.Post, NucleusKitEvent.Redeem.Pre

Enclosing interface:

NucleusKitEvent

public static interface NucleusKitEvent.Redeem
extends NucleusKitEvent, org.spongepowered.api.event.entity.living.humanoid.player.TargetPlayerEvent

Fired when a kit is redeemed.

• Pre is fired before the kit is redeemed, and the contents of the kit may be altered at this stage for this redemption only.
• Post is fired after a kit is redeemed successfully (defined as a kit would not be redeemable again if it was a one time kit).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NucleusKitEvent.Redeem.Failed Fired when a player's kit could not be updated.
static interface	NucleusKitEvent.Redeem.Post Fired when a player's kit has been updated.
static interface	NucleusKitEvent.Redeem.Pre Fired when a player is redeeming a kit.

Nested classes/interfaces inherited from interface io.github.nucleuspowered.nucleus.api.events.NucleusKitEvent

NucleusKitEvent.Redeem

Method Summary

Modifier and Type	Method and Description
Optional<Collection<String>>	getCommandsToExecute() Gets the commands that the kit will run, if a plugin has set them.
Optional<Instant>	getLastRedeemedTime() Gets the last time the kit was redeemed, if any.
String	getName() Gets the name of the kit.
Collection<String>	getOriginalCommandsToExecute() Gets the commands that the kit will run.
Collection<org.spongepowered.api.item.inventory.ItemStackSnapshot>	getOriginalStacksToRedeem() Gets the ItemStackSnapshots that the kit contains.
Kit	getRedeemedKit() Gets the kit that has been redeemed.
Optional<Collection<org.spongepowered.api.item.inventory.ItemStackSnapshot>>	getStacksToRedeem() Gets the ItemStackSnapshots that will be redeemed, if a plugin has altered it.

Methods inherited from interface org.spongepowered.api.event.entity.living.humanoid.player.TargetPlayerEvent

getTargetEntity

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

getCause, getContext, getSource

Method Detail

getLastRedeemedTime

Optional<Instant> getLastRedeemedTime()

Gets the last time the kit was redeemed, if any.

Returns:

The Instant the kit was last redeemed.

getName

String getName()

Gets the name of the kit.

Returns:

The name of the kit.

getRedeemedKit

Kit getRedeemedKit()

Gets the kit that has been redeemed.

Returns:

The kit that has been redeemed.

getOriginalStacksToRedeem

Collection<org.spongepowered.api.item.inventory.ItemStackSnapshot> getOriginalStacksToRedeem()

Gets the ItemStackSnapshots that the kit contains.

Note that other plugins might alter what is finally redeemed by the kit, see getStacksToRedeem()

If getStacksToRedeem() is null, this is what will be redeemed.

Returns:

The ItemStackSnapshots that would be redeemed.

getStacksToRedeem

Optional<Collection<org.spongepowered.api.item.inventory.ItemStackSnapshot>> getStacksToRedeem()

Gets the ItemStackSnapshots that will be redeemed, if a plugin has altered it.

This might not represent what the kit actually contains, plugins may alter this.

For NucleusKitEvent.Redeem.Post, this is what was actually redeemed.

Returns:

The ItemStackSnapshots that would be redeemed, if altered.

getOriginalCommandsToExecute

Collection<String> getOriginalCommandsToExecute()

Gets the commands that the kit will run.

Note that other plugins might alter what is finally redeemed by the kit, see getCommandsToExecute()

If getCommandsToExecute() ()} is null, this is what will be executed. Note that these are run by the ConsoleSource.

The token that represents the player in commands is {{player}}

Returns:

The commands to run.

getCommandsToExecute

Optional<Collection<String>> getCommandsToExecute()

Gets the commands that the kit will run, if a plugin has set them.

This might not represent what the kit might actually contain. See getOriginalCommandsToExecute() for that.

If this is Optional.empty(), then getOriginalCommandsToExecute() will be used.

The token that represents the player in commands is {{player}}

Note that these are run by the ConsoleSource.

Returns:

The commands to run.