me.realized.duels.api.kit

Interface Kit

public interface Kit

Represents an Kit loaded on the server.

Method Summary

Modifier and Type	Method and Description
boolean	equip(org.bukkit.entity.Player player) Equips the Player with the contents of this kit.
org.bukkit.inventory.ItemStack	getDisplayed() The item displayed in the kit selector gui.
java.lang.String	getName() The name of this kit.
boolean	isArenaSpecific() Whether or not this kit has arenaSpecific enabled.
boolean	isRemoved() Whether or not this Kit has been removed.
boolean	isUsePermission() Whether or not this kit requires a permission.
void	setArenaSpecific(boolean arenaSpecific) Enables or disables arenaSpecific for this kit.
void	setUsePermission(boolean usePermission) Enables or disables usePermission for this kit.

Method Detail

getName

@NotNull
java.lang.String getName()

The name of this kit. Will not contain a dash character ("-").

Returns:

Never-null String that is the name of this kit.

getDisplayed

@NotNull
org.bukkit.inventory.ItemStack getDisplayed()

The item displayed in the kit selector gui.

Returns:

item displayed in the kit selector gui.

isUsePermission

boolean isUsePermission()

Whether or not this kit requires a permission. If usePermission is enabled, players must have the permission 'duels.kit.[name] (space in name replaced to dash)' to use the kit.

Returns:

True if usePermission is enabled for this kit. False otherwise.

setUsePermission

void setUsePermission(boolean usePermission)

Enables or disables usePermission for this kit.

Parameters:

usePermission - True to enable usePermission. False otherwise.

isArenaSpecific

boolean isArenaSpecific()

Whether or not this kit has arenaSpecific enabled. If arenaSpecific is enabled, only arenas with their name starting with this kit's name appended with an underscore will be available when playing with this kit.

Returns:

True if arenaSpecific is enabled. False otherwise.

setArenaSpecific

void setArenaSpecific(boolean arenaSpecific)

Enables or disables arenaSpecific for this kit.

Parameters:

arenaSpecific - True to enable arenaSpecific. False otherwise.

equip

boolean equip(@NotNull
              org.bukkit.entity.Player player)

Equips the Player with the contents of this kit. Note: Calls KitEquipEvent.

Parameters:

player - Player to equip this kit.

Returns:

True if Player has successfully equipped this kit. False otherwise.

isRemoved

boolean isRemoved()

Whether or not this Kit has been removed.

Returns:

True if this Kit has been removed. False otherwise.

Since:

3.2.0

See Also:

KitManager.remove(CommandSender, String)