Package me.mrCookieSlime.Slimefun.Objects

Class Research

java.lang.Object

me.mrCookieSlime.Slimefun.Objects.Research

All Implemented Interfaces:

Keyed

public class Research
extends Object
implements Keyed

Represents a research, which is bound to one SlimefunItem or more and requires XP levels to unlock said item(s).

Author:

TheBusyBiscuit

See Also:

ResearchSetup, ResearchUnlockEvent

Constructor Summary

Constructors

Constructor	Description
Research(NamespacedKey key, int id, String name, int defaultCost)	The constructor for a Research.

Method Summary

Modifier and Type	Method	Description
void	addItems(SlimefunItem... items)	Bind the specified Slimefun items to this Research.
boolean	canUnlock(Player p)	Checks if the Player can unlock this Research.
List<SlimefunItem>	getAffectedItems()	Lists every SlimefunItem that is bound to this Research.
static Research	getByID(int id)	Attempts to get a Research with the given ID.
int	getCost()	Gets the cost in XP levels to unlock this Research.
int	getID()	Gets the ID of this Research.
NamespacedKey	getKey()
String	getName(Player p)	This method gives you a localized name for this Research.
boolean	isEnabled()	This method returns whether this Research is enabled.
void	register()	Registers this Research.
void	setCost(int cost)	Sets the cost in XP levels to unlock this Research.
String	toString()
void	unlock(Player p, boolean instant)	Unlocks this Research for the specified Player.

Methods inherited from class java.lang.Object

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

Constructor Detail

Research

public Research(NamespacedKey key,
                int id,
                String name,
                int defaultCost)

The constructor for a Research. Create a new research, then bind this research to the Slimefun items you want by calling addItems(SlimefunItem...). Once you're finished, call register() to register it. To speed up, directly setup the research by calling Slimefun.registerResearch(Research, org.bukkit.inventory.ItemStack...).

Parameters:

key - A unique identifier for this Research

id - old way of identifying researches

name - The displayed name of this Research

defaultCost - The Cost in XP levels to unlock this Research

Method Detail

getKey

public NamespacedKey getKey()

Specified by:

getKey in interface Keyed

isEnabled

public boolean isEnabled()

This method returns whether this Research is enabled. false can mean that this particular Research was disabled or that researches alltogether have been disabled.

Returns:

Whether this Research is enabled or not

getID

public int getID()

Gets the ID of this Research. This is the old way of identifying Researches, use a NamespacedKey in the future.

Returns:

The ID of this Research

getName

public String getName(Player p)

This method gives you a localized name for this Research. The name is automatically taken from the currently selected Language of the specified Player.

Parameters:

p - The Player to translate this name for.

Returns:

The localized Name of this Research.

getCost

public int getCost()

Gets the cost in XP levels to unlock this Research.

Returns:

The cost in XP levels for this Research

setCost

public void setCost(int cost)

Sets the cost in XP levels to unlock this Research.

Parameters:

cost - The cost in XP levels

addItems

public void addItems(SlimefunItem... items)

Bind the specified Slimefun items to this Research.

Parameters:

items - Instances of SlimefunItem to bind to this Research

getAffectedItems

public List<SlimefunItem> getAffectedItems()

Lists every SlimefunItem that is bound to this Research.

Returns:

The Slimefun items bound to this Research.

canUnlock

public boolean canUnlock(Player p)

Checks if the Player can unlock this Research.

Parameters:

p - The Player to check

Returns:

Whether that Player can unlock this Research

unlock

public void unlock(Player p,
                   boolean instant)

Unlocks this Research for the specified Player.

Parameters:

p - The Player for which to unlock this Research

instant - Whether to unlock the research instantly

register

public void register()

Registers this Research.

getByID

public static Research getByID(int id)

Attempts to get a Research with the given ID. We will use NamespacedKey for this in the future.

Parameters:

id - ID of the research to get

Returns:

Research if found, or null

toString

public String toString()

Overrides:

toString in class Object