Package net.tnemc.item.component.impl

Class FoodComponent<I extends AbstractItemStack<T>,T>

java.lang.Object

net.tnemc.item.component.impl.FoodComponent<I,T>

All Implemented Interfaces:

SerialComponent<I,T>, ItemApplicator<I,T>, ItemCheck<T>, Identifiable, ItemSerializer<I,T>

Direct Known Subclasses:

BukkitFoodComponent, PaperOldFoodComponent

public abstract class FoodComponent<I extends AbstractItemStack<T>,T>
extends Object
implements SerialComponent<I,T>

FoodComponent - The food stats for this consumable item. Has no effect unless the item can be consumed (i.e. the item has the consumable component).

Since:

0.0.1.0

Author:

creatorfromhell

Constructor Summary

Constructors

Constructor	Description
FoodComponent()
FoodComponent(boolean canAlwaysEat)
FoodComponent(boolean canAlwaysEat, float saturation)
FoodComponent(boolean canAlwaysEat, float saturation, int nutrition)

Method Summary

Modifier and Type	Method	Description
boolean	canAlwaysEat()
void	canAlwaysEat(boolean canAlwaysEat)
String	identifier()
int	nutrition()
void	nutrition(int nutrition)
void	readJSON(JSONHelper json, ItemPlatform<I,T,?> platform)	Reads JSON data and converts it back to a SerialComponent object.
float	saturation()
void	saturation(float saturation)
boolean	similar(SerialComponent<?,?> component)	Used to determine if some data is equal to this data.
org.json.simple.JSONObject	toJSON()	Converts the SerialComponent to a JSON object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.tnemc.item.platform.applier.ItemApplicator

apply, enabled

Methods inherited from interface net.tnemc.item.platform.check.ItemCheck

enabled, skipRest

Methods inherited from interface net.tnemc.item.platform.serialize.ItemSerializer

enabled, serialize

Methods inherited from interface net.tnemc.item.component.SerialComponent

applies, appliesTo, check

Constructor Details

FoodComponent

public FoodComponent()

FoodComponent

public FoodComponent(boolean canAlwaysEat)

FoodComponent

public FoodComponent(boolean canAlwaysEat,
 float saturation)

FoodComponent

public FoodComponent(boolean canAlwaysEat,
 float saturation,
 int nutrition)

Method Details

identifier

public String identifier()

Specified by:

identifier in interface Identifiable

Returns:

the type of component this is.

Since:

0.2.0.0

toJSON

public org.json.simple.JSONObject toJSON()

Converts the SerialComponent to a JSON object.

Specified by:

toJSON in interface SerialComponent<I extends AbstractItemStack<T>,T>

Returns:

The JSONObject representing this SerialComponent.

Since:

0.2.0.0

readJSON

public void readJSON(JSONHelper json,
 ItemPlatform<I,T,?> platform)

Reads JSON data and converts it back to a SerialComponent object.

Specified by:

readJSON in interface SerialComponent<I extends AbstractItemStack<T>,T>

Parameters:

json - The JSONHelper instance of the json data.

platform - The platform instance.

Since:

0.2.0.0

similar

public boolean similar(SerialComponent<?,?> component)

Used to determine if some data is equal to this data. This means that it has to be an exact copy of this data. For instance, book copies will return false when compared to the original.

Specified by:

similar in interface SerialComponent<I extends AbstractItemStack<T>,T>

Parameters:

component - The component to compare.

Returns:

True if similar, otherwise false.

Since:

0.2.0.0

canAlwaysEat

public boolean canAlwaysEat()

canAlwaysEat

public void canAlwaysEat(boolean canAlwaysEat)

saturation

public float saturation()

saturation

public void saturation(float saturation)

nutrition

public int nutrition()

nutrition

public void nutrition(int nutrition)