Kit (nucleus-api 2.4.0 API)

```
public interface Kit
```
Represents a kit in Nucleus.
Note that this kit requires explicit saving, see save()

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default Kit`	`addCommand(java.lang.String command)` Adds a command to the `Kit`
`java.util.List<java.lang.String>`	`getCommands()` Gets the commands associated with this kit.
`java.util.Optional<java.time.Duration>`	`getCooldown()` Gets the cooldown time for the kit.
`double`	`getCost()` The cost for claiming the kit.
`default java.time.Duration`	`getInterval()` Deprecated. Use `getCooldown()`
`default java.util.Collection<org.spongepowered.api.item.inventory.ItemStack>`	`getItemsForPlayer(org.spongepowered.api.entity.living.player.Player player)` Obtains a collection of items that a player would obtain when redeeming the kit.
`java.lang.String`	`getName()` Gets the name of the kit.
`java.util.List<org.spongepowered.api.item.inventory.ItemStackSnapshot>`	`getStacks()` Gets the stacks that would be given out by this kit.
`boolean`	`ignoresPermission()` Gets whether redeeming this kit will ignore the permission checks.
`boolean`	`isAutoRedeem()` Gets whether the kit is automatically redeemed on login.
`boolean`	`isDisplayMessageOnRedeem()` Gets whether a message is displayed to the player when a kit is redeemed.
`boolean`	`isFirstJoinKit()` Returns whether this kit acts like a First Join Kit.
`boolean`	`isHiddenFromList()` Gets whether this kit is hidden from the `/kits` list (except for those with permission to view it).
`boolean`	`isOneTime()` Gets whether the kit is only allowed to be used one time, ever.
`default KitRedeemResult`	`redeem(org.spongepowered.api.entity.living.player.Player player)` Attempts to redeem this kit, saving it beforehand.
`void`	`redeemKitCommands(org.spongepowered.api.entity.living.player.Player player)` Redeems the commands in the kit, without redeeming the items.
`default void`	`save()` Saves this current kit's state.
`Kit`	`setAutoRedeem(boolean autoRedeem)` Sets whether the kit is automatically redeemed on login.
`Kit`	`setCommands(java.util.List<java.lang.String> commands)` Sets the commands associated with this kit.
`Kit`	`setCooldown(java.time.Duration cooldown)` Sets the cooldown time for the kit.
`Kit`	`setCost(double cost)` Set the cost for this kit.
`Kit`	`setDisplayMessageOnRedeem(boolean displayMessage)` Sets whether a message is displayed to the player when a kit is redeemed.
`Kit`	`setFirstJoinKit(boolean firstJoinKit)` Sets whether this kit will be redeemed on first join.
`Kit`	`setHiddenFromList(boolean hide)` Sets whether this kit is hidden from `/kits`
`Kit`	`setIgnoresPermission(boolean ignoresPermission)` Sets whether redeeming this kit ignores permission checks.
`default Kit`	`setInterval(java.time.Duration interval)` Deprecated. Use `setCooldown(Duration)` instead.
`Kit`	`setOneTime(boolean oneTime)` Sets whether the kit is only allowed to be used one time, ever.
`Kit`	`setStacks(java.util.List<org.spongepowered.api.item.inventory.ItemStackSnapshot> stacks)` Set the stacks that would be given out by this kit.
`Kit`	`updateKitInventory(org.spongepowered.api.item.inventory.Inventory inventory)` Convenience method for updating the kit with the contents of the player's inventory.
`Kit`	`updateKitInventory(org.spongepowered.api.entity.living.player.Player player)` Convenience method for updating the kit with the contents of the player's inventory.

- Method Detail
  - getName
```
java.lang.String getName()
```
    Gets the name of the kit.
    
    Returns:
    
    The name
  - getStacks
```
java.util.List<org.spongepowered.api.item.inventory.ItemStackSnapshot> getStacks()
```
    Gets the stacks that would be given out by this kit.
    
    Returns:
    
    The List of ItemStackSnapshots.
  - setStacks
```
Kit setStacks(java.util.List<org.spongepowered.api.item.inventory.ItemStackSnapshot> stacks)
```
    Set the stacks that would be given out by this kit.
    
    Parameters:
    
    stacks - The List of ItemStackSnapshots.
    
    Returns:
    
    This Kit, for chaining.
  - getInterval
```
@Deprecated
default java.time.Duration getInterval()
```
    Deprecated. Use getCooldown()
    
    Gets the cooldown time for the kit, or Duration.ZERO if there is no cooldown.
    
    Returns:
    
    The Duration
  - getCooldown
```
java.util.Optional<java.time.Duration> getCooldown()
```
    Gets the cooldown time for the kit.
    
    Returns:
    
    The Duration
  - setInterval
```
@Deprecated
default Kit setInterval(java.time.Duration interval)
```
    Deprecated. Use setCooldown(Duration) instead.
    
    Sets the cooldown time for the kit.
    
    Parameters:
    
    interval - The time the user has to wait before claiming the kit again.
    
    Returns:
    
    This Kit, for chaining.
  - setCooldown
```
Kit setCooldown(java.time.Duration cooldown)
```
    Sets the cooldown time for the kit.
    
    Parameters:
    
    cooldown - The time the user has to wait before claiming the kit again.
    
    Returns:
    
    This Kit, for chaining.
  - getCost
```
double getCost()
```
    The cost for claiming the kit.
    
    Returns:
    
    The cost.
  - setCost
```
Kit setCost(double cost)
```
    Set the cost for this kit.
    
    Parameters:
    
    cost - The cost.
    
    Returns:
    
    This Kit, for chaining.
  - isAutoRedeem
```
boolean isAutoRedeem()
```
    Gets whether the kit is automatically redeemed on login.
    
    Returns:
    
    true if so
  - setAutoRedeem
```
Kit setAutoRedeem(boolean autoRedeem)
```
    Sets whether the kit is automatically redeemed on login.
    
    Parameters:
    
    autoRedeem - Set true if the kit should automatically redeemed, false otherwise.
    
    Returns:
    
    this Kit, for chaining.
  - isOneTime
```
boolean isOneTime()
```
    Gets whether the kit is only allowed to be used one time, ever.
    
    Returns:
    
    true if so
  - setOneTime
```
Kit setOneTime(boolean oneTime)
```
    Sets whether the kit is only allowed to be used one time, ever.
    
    Parameters:
    
    oneTime - Set true if the kit should only be used once, false otherwise.
    
    Returns:
    
    this Kit, for chaining.
  - getCommands
```
java.util.List<java.lang.String> getCommands()
```
    Gets the commands associated with this kit.
    
    Returns:
    
    The list of commands.
  - setCommands
```
Kit setCommands(java.util.List<java.lang.String> commands)
```
    Sets the commands associated with this kit.
    
    Parameters:
    
    commands - The list of commands, with {{player}} as the token for the name of the player.
    
    Returns:
    
    This Kit for chaining.
  - addCommand
```
default Kit addCommand(java.lang.String command)
```
    Adds a command to the Kit
    
    Parameters:
    
    command - The command to add.
    
    Returns:
    
    This Kit for chaining.
  - updateKitInventory
```
Kit updateKitInventory(org.spongepowered.api.item.inventory.Inventory inventory)
```
    Convenience method for updating the kit with the contents of the player's inventory.
    
    Parameters:
    
    inventory - The inventory to get the kit from.
    
    Returns:
    
    This Kit for chaining.
  - updateKitInventory
```
Kit updateKitInventory(org.spongepowered.api.entity.living.player.Player player)
```
    Convenience method for updating the kit with the contents of the player's inventory.
    
    Parameters:
    
    player - The player to get the kit from.
    
    Returns:
    
    This Kit for chaining.
  - getItemsForPlayer
```
default java.util.Collection<org.spongepowered.api.item.inventory.ItemStack> getItemsForPlayer(org.spongepowered.api.entity.living.player.Player player)
```
    Obtains a collection of items that a player would obtain when redeeming the kit.
    
    Parameters:
    
    player - The player
    
    Returns:
    
    The items
    
    See Also:
    
    NucleusKitService.getItemsForPlayer(Kit, Player)
  - redeem
```
default KitRedeemResult redeem(org.spongepowered.api.entity.living.player.Player player)
```
    Attempts to redeem this kit, saving it beforehand.
    
    Parameters:
    
    player - The player to redeem the kit for
    
    Returns:
    
    The result
  - redeemKitCommands
```
void redeemKitCommands(org.spongepowered.api.entity.living.player.Player player)
```
    Redeems the commands in the kit, without redeeming the items.
    
    Parameters:
    
    player - The Player that should redeem the commands.
  - isDisplayMessageOnRedeem
```
boolean isDisplayMessageOnRedeem()
```
    Gets whether a message is displayed to the player when a kit is redeemed.
    
    Returns:
    
    true if the player will be notified if a player will be notified.
  - setDisplayMessageOnRedeem
```
Kit setDisplayMessageOnRedeem(boolean displayMessage)
```
    Sets whether a message is displayed to the player when a kit is redeemed.
    
    Parameters:
    
    displayMessage - true to display a message to the player when they redeem a kit.
    
    Returns:
    
    This Kit for chaining.
  - ignoresPermission
```
boolean ignoresPermission()
```
    Gets whether redeeming this kit will ignore the permission checks.
    Specifically, this is for when separate kit permissions are turned on in the Nucleus config, if this is true, this kit will never require a separate permission to redeem.
    
    Returns:
    
    true if this kit does not require a permission to redeem.
  - setIgnoresPermission
```
Kit setIgnoresPermission(boolean ignoresPermission)
```
    Sets whether redeeming this kit ignores permission checks.
    
    Parameters:
    
    ignoresPermission - Whether to ignore separate permission checks
    
    Returns:
    
    This Kit, for chaining.
  - isHiddenFromList
```
boolean isHiddenFromList()
```
    Gets whether this kit is hidden from the /kits list (except for those with permission to view it).
    If hidden, a player won't be able to tab complete to this either, but can still redeem the kit.
    
    Returns:
    
    Whether the kit is hidden from the /kits list and tab complete.
  - setHiddenFromList
```
Kit setHiddenFromList(boolean hide)
```
    Sets whether this kit is hidden from /kits
    
    Parameters:
    
    hide - true if so.
    
    Returns:
    
    This Kit, for chaining.
  - isFirstJoinKit
```
boolean isFirstJoinKit()
```
    Returns whether this kit acts like a First Join Kit.
    
    Returns:
    
    true if so.
  - setFirstJoinKit
```
Kit setFirstJoinKit(boolean firstJoinKit)
```
    Sets whether this kit will be redeemed on first join.
    
    Parameters:
    
    firstJoinKit - true if so.
    
    Returns:
    
    This Kit, for chaining.
  - save
```
default void save()
```
    Saves this current kit's state.
    
    Throws:
    
    java.lang.IllegalStateException - if the kit module isn't active.

Interface Kit

Method Summary

Method Detail

getName

getStacks

setStacks

getInterval

getCooldown

setInterval

setCooldown

getCost

setCost

isAutoRedeem

setAutoRedeem

isOneTime

setOneTime

getCommands

setCommands

addCommand

updateKitInventory

updateKitInventory

getItemsForPlayer

redeem

redeemKitCommands

isDisplayMessageOnRedeem

setDisplayMessageOnRedeem

ignoresPermission

setIgnoresPermission

isHiddenFromList

setHiddenFromList

isFirstJoinKit

setFirstJoinKit

save