wtf.nucker.kitpvpplus.api.objects

Class Kit

java.lang.Object

wtf.nucker.kitpvpplus.api.objects.Kit

public class Kit
extends Object

Author:

Nucker Used for getting information about a kit

Constructor Summary

Constructors

Constructor and Description
Kit() Deprecated. DO NOT USE THIS

Method Summary

Modifier and Type	Method and Description
static Kit	fromInstanceKit(wtf.nucker.kitpvpplus.objects.Kit kit) Used for getting api kit instance from plugin instance kit
int	getCooldown() If there is no cooldown, it will return 0
List<String>	getDescription()
String	getDisplayname()
org.bukkit.Material	getIcon()
String	getId()
String	getPermission() If there is no permission, it will return null
int	getPrice() If it is free it will return 0
boolean	isFree()
void	loadKit(org.bukkit.entity.Player player) Used for loading a kit into a player's inventory This only uses one player in the params.
void	loadKit(org.bukkit.entity.Player receiver, org.bukkit.entity.Player loader) Used for loading the kit into a player's inventory
static wtf.nucker.kitpvpplus.objects.Kit	toInstanceKit(Kit kit) Used for getting a plugin instance of a kit from an api instance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Kit

public Kit()

Deprecated. DO NOT USE THIS

See Also:

fromInstanceKit(wtf.nucker.kitpvpplus.objects.Kit)

Method Detail

getId

public String getId()

Returns:

the id of the kit

getPrice

public int getPrice()

If it is free it will return 0

Returns:

the price of the kit

See Also:

Kit#isFree() which returns weather the kit is free as a boolean object

isFree

public boolean isFree()

Returns:

weather the price of the kit is 0 as a boolean

See Also:

Kit#getPrice() to get the price

getCooldown

public int getCooldown()

If there is no cooldown, it will return 0

Returns:

the kits cooldown

getIcon

public org.bukkit.Material getIcon()

Returns:

the kits icon

getDescription

public List<String> getDescription()

Returns:

the kits description (lore)

getDisplayname

public String getDisplayname()

Returns:

the kits displayname

getPermission

public String getPermission()

If there is no permission, it will return null

Returns:

the permission of the kit

loadKit

public void loadKit(org.bukkit.entity.Player receiver,
                    org.bukkit.entity.Player loader)

Used for loading the kit into a player's inventory

Parameters:

receiver - the person receiving the items in the kit

loader - the person giving the kit

See Also:

Kit#loadKit(Player) to load a kit for a singular player

loadKit

public void loadKit(org.bukkit.entity.Player player)

Used for loading a kit into a player's inventory This only uses one player in the params.

Parameters:

player - the player who is getting the kit

See Also:

Kit#loadKit(Player, Player) is used in this method with the Player param being used as the receiver

fromInstanceKit

public static Kit fromInstanceKit(wtf.nucker.kitpvpplus.objects.Kit kit)

Used for getting api kit instance from plugin instance kit

Parameters:

kit - plugin instance kit

Returns:

api instance kit

toInstanceKit

public static wtf.nucker.kitpvpplus.objects.Kit toInstanceKit(Kit kit)

Used for getting a plugin instance of a kit from an api instance

Parameters:

kit - the api instance of the kit

Returns:

The plugin instance of the kit