Package sawfowl.commandpack.api.data.kits

Interface Kit

All Superinterfaces:

DataSerializable

public interface Kit
extends DataSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Kit.Builder

Method Summary

Modifier and Type	Method	Description
void	addCommand(String command)	Adding a command to the kit.
InventoryMenu	asMenu(org.spongepowered.plugin.PluginContainer container, ServerPlayer carrier, boolean readOnly)	Getting the contents of the kit in the menu with the specified number of lines. All changes made will be automatically saved.
static Kit.Builder	builder()
List<ItemStack>	getContent()	Getting a copy of the items in the kit.
long	getCooldown()	Time until access to the kit is restored.
Optional<List<String>>	getExecuteCommands()	A list of commands to be executed when a kit is giving.
int	getGiveLimit()	How many times a given set can be given to a player.
GiveRule	getGiveRule()	The rule for giving a kit to a player.
Optional<KitPrice>	getKitPrice()	Obtaining kit price data.
List<Component>	getLocalizedLore(Locale locale)	Localized kit lore
Component	getLocalizedName(Locale locale)	Localized kit name
String	id()	kit id
boolean	isFirstTime()	Should the kit be given to the player upon first entry.
boolean	isGiveOnJoin()	Should the kit be given to the player upon entering the game. The time of restoration of access to the kit is taken into account.
boolean	isNeedPerm()	Whether to check if the player has permission to get a set.
default boolean	isUnlimited()
String	permission()	Permission to getting a kit.
void	removeCommand(String command)	Removing a command from the kit.
void	save()

Methods inherited from interface org.spongepowered.api.data.persistence.DataSerializable

contentVersion, toContainer

Method Details

builder

static Kit.Builder builder()

id

String id()

kit id

getLocalizedName

Component getLocalizedName(Locale locale)

Localized kit name

getLocalizedLore

List<Component> getLocalizedLore(Locale locale)

Localized kit lore

getContent

List<ItemStack> getContent()

Getting a copy of the items in the kit.

getGiveRule

GiveRule getGiveRule()

The rule for giving a kit to a player.

getCooldown

long getCooldown()

Time until access to the kit is restored.

getGiveLimit

int getGiveLimit()

How many times a given set can be given to a player.

isFirstTime

boolean isFirstTime()

Should the kit be given to the player upon first entry.

isGiveOnJoin

boolean isGiveOnJoin()

Should the kit be given to the player upon entering the game.
The time of restoration of access to the kit is taken into account.

isNeedPerm

boolean isNeedPerm()

Whether to check if the player has permission to get a set.

permission

String permission()

Permission to getting a kit.

getExecuteCommands

Optional<List<String>> getExecuteCommands()

A list of commands to be executed when a kit is giving.

addCommand

void addCommand(String command)

Adding a command to the kit.

removeCommand

void removeCommand(String command)

Removing a command from the kit.

getKitPrice

Optional<KitPrice> getKitPrice()

Obtaining kit price data.

isUnlimited

default boolean isUnlimited()

asMenu

InventoryMenu asMenu(org.spongepowered.plugin.PluginContainer container,
 ServerPlayer carrier,
 boolean readOnly)

Getting the contents of the kit in the menu with the specified number of lines.
All changes made will be automatically saved.

save

void save()