io.github.nucleuspowered.nucleus.api.service

Interface NucleusKitService

public interface NucleusKitService

A service for getting and setting kits.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NucleusKitService.RedeemResult The result for a successful redemption.

Method Summary

Modifier and Type	Method and Description
Kit	createKit(String name) Gets a new kit object for use with the Kit service.
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).
Optional<Kit>	getKit(String name) Gets the requested kit if it exists.
Set<String>	getKitNames() Gets the names of all the kits currently in NucleusPlugin.
NucleusKitService.RedeemResult	redeemKit(Kit kit, org.spongepowered.api.entity.living.player.Player player, boolean performChecks) Redeems a kit on a player.
NucleusKitService.RedeemResult	redeemKit(Kit kit, org.spongepowered.api.entity.living.player.Player player, boolean performChecks, boolean mustRedeemAll) Redeems a kit on a player.
boolean	removeKit(String kitName) Removes the requested kit.
void	renameKit(String kitName, String newKitName) Renames a kit.
void	saveKit(Kit kit) Saves a kit.
default void	saveKit(String kitName, Kit kit) Deprecated. kitName is now ignored.

Method Detail

getKitNames

Set<String> getKitNames()

Gets the names of all the kits currently in NucleusPlugin.

Returns:

A Set of Strings.

getKit

Optional<Kit> getKit(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

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.

redeemKit

NucleusKitService.RedeemResult redeemKit(Kit kit,
                                         org.spongepowered.api.entity.living.player.Player player,
                                         boolean performChecks)
                                  throws KitRedeemException

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 NucleusKitService.RedeemResult

Throws:

KitRedeemException - thrown if a problem occurs.

redeemKit

NucleusKitService.RedeemResult redeemKit(Kit kit,
                                         org.spongepowered.api.entity.living.player.Player player,
                                         boolean performChecks,
                                         boolean mustRedeemAll)
                                  throws KitRedeemException

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 NucleusKitService.RedeemResult

Throws:

KitRedeemException - thrown if a problem occurs.

removeKit

boolean removeKit(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(String kitName,
               String newKitName)
        throws IllegalArgumentException

Renames a kit.

Parameters:

kitName - The name of the kit to rename

newKitName - The new name of the kit

Throws:

IllegalArgumentException - if either the kit or the target name are unavailable

saveKit

@Deprecated
default void saveKit(String kitName,
                                 Kit kit)

Deprecated. kitName is now ignored.

Saves a kit with the requested name.

Parameters:

kitName - The name of the kit to save.

kit - The kit to save.

saveKit

void saveKit(Kit kit)

Saves a kit.

Parameters:

kit - The kit.

createKit

Kit createKit(String name)
       throws 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:

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