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

Interface NucleusKitService

public interface NucleusKitService

A service for getting and setting kits.

Method Summary

Modifier and Type	Method and Description
Kit	createKit(java.lang.String name) Gets a new kit object for use with the Kit service.
java.util.concurrent.CompletableFuture<java.util.Optional<java.time.Instant>>	getCooldownExpiry(Kit kit, org.spongepowered.api.entity.living.player.User player) If a Player is unable to redeem the given Kit as they have previously redeemed it and that the cooldown has not expired, will return the Instant the User may redeem the kit again.
java.util.Collection<org.spongepowered.api.item.inventory.ItemStack>	getItemsForPlayer(Kit kit, org.spongepowered.api.entity.living.player.Player player) Returns the items for a kit that the target player would redeem (that is, with token replacements if applicable).
java.util.Optional<Kit>	getKit(java.lang.String name) Gets the requested kit if it exists.
java.util.Set<java.lang.String>	getKitNames() Gets the names of all the kits currently in NucleusPlugin.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	hasPreviouslyRedeemed(Kit kit, org.spongepowered.api.entity.living.player.User player) Returns whether the given Kit has previously been redeemed by the Player.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	isRedeemable(Kit kit, org.spongepowered.api.entity.living.player.User player) Gets whether a Player can redeem the given Kit given any cooldown and one-time kit status
KitRedeemResult	redeemKit(Kit kit, org.spongepowered.api.entity.living.player.Player player, boolean performChecks) Redeems a kit on a player.
KitRedeemResult	redeemKit(Kit kit, org.spongepowered.api.entity.living.player.Player player, boolean performChecks, boolean mustRedeemAll) Redeems a kit on a player.
boolean	removeKit(java.lang.String kitName) Removes the requested kit.
void	renameKit(java.lang.String kitName, java.lang.String newKitName) Renames a kit.
void	saveKit(Kit kit) Saves a kit.

Method Detail

getKitNames

java.util.Set<java.lang.String> getKitNames()

Gets the names of all the kits currently in NucleusPlugin.

Returns:

A Set of Strings.

getKit

java.util.Optional<Kit> getKit(java.lang.String name)

Gets the requested kit if it exists.

Parameters:

name - The name of the kit.

Returns:

An Optional that might contain the kit.

getItemsForPlayer

java.util.Collection<org.spongepowered.api.item.inventory.ItemStack> getItemsForPlayer(Kit kit,
                                                                                       org.spongepowered.api.entity.living.player.Player player)

Returns the items for a kit that the target player would redeem (that is, with token replacements if applicable).

Parameters:

kit - The kit to process

player - The player

Returns:

The items.

hasPreviouslyRedeemed

java.util.concurrent.CompletableFuture<java.lang.Boolean> hasPreviouslyRedeemed(Kit kit,
                                                                                org.spongepowered.api.entity.living.player.User player)

Returns whether the given Kit has previously been redeemed by the Player.

No assumptions about whether the kit may be redeemed again is made.

Parameters:

kit - The Kit

player - The User

Returns:

Whether the kit has been redeemed before.

isRedeemable

java.util.concurrent.CompletableFuture<java.lang.Boolean> isRedeemable(Kit kit,
                                                                       org.spongepowered.api.entity.living.player.User player)

Gets whether a Player can redeem the given Kit given any cooldown and one-time kit status

Parameters:

kit - The Kit

player - The User

Returns:

true if so

getCooldownExpiry

java.util.concurrent.CompletableFuture<java.util.Optional<java.time.Instant>> getCooldownExpiry(Kit kit,
                                                                                                org.spongepowered.api.entity.living.player.User player)

If a Player is unable to redeem the given Kit as they have previously redeemed it and that the cooldown has not expired, will return the Instant the User may redeem the kit again.

Parameters:

kit - The Kit

player - The Player

Returns:

The Instant the cooldown expires, if there is a cooldown in effect.

redeemKit

KitRedeemResult redeemKit(Kit kit,
                          org.spongepowered.api.entity.living.player.Player player,
                          boolean performChecks)

Redeems a kit on a player. Whether the player must get all items is controlled by the Nucleus config.

Parameters:

kit - The kit to redeem

player - The player to redeem the kit against

performChecks - Whether to perform standard permission and cooldown checks

Returns:

The KitRedeemResult

redeemKit

KitRedeemResult redeemKit(Kit kit,
                          org.spongepowered.api.entity.living.player.Player player,
                          boolean performChecks,
                          boolean mustRedeemAll)

Redeems a kit on a player.

Parameters:

kit - The kit to redeem

player - The player to redeem the kit against

performChecks - Whether to perform standard permission and cooldown checks

mustRedeemAll - Whether all items must be redeemed to count as a success

Returns:

The KitRedeemResult

removeKit

boolean removeKit(java.lang.String kitName)

Removes the requested kit.

Parameters:

kitName - The name of the kit to remove.

Returns:

true if a kit was removed.

renameKit

void renameKit(java.lang.String kitName,
               java.lang.String newKitName)
        throws java.lang.IllegalArgumentException

Renames a kit.

Parameters:

kitName - The name of the kit to rename

newKitName - The new name of the kit

Throws:

java.lang.IllegalArgumentException - if either the kit or the target name are unavailable

saveKit

void saveKit(Kit kit)

Saves a kit.

Parameters:

kit - The kit.

createKit

Kit createKit(java.lang.String name)
       throws java.lang.IllegalArgumentException

Gets a new kit object for use with the Kit service.

Do not make your own kit type, it will not get saved! Use this instead.

Parameters:

name - The name of the kit to create

Returns:

The Kit

Throws:

java.lang.IllegalArgumentException - if the kit name already exists, or is invalid