Package net.risingworld.api.definitions

Class Items.ConsumeInfo

java.lang.Object

net.risingworld.api.definitions.Items.ConsumeInfo

Enclosing class:

Items

public final class Items.ConsumeInfo
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	disease
float	diseasechance
boolean	healbones	Does consuming this item heals bones?
int	healthrestore	How much health is restored?
int	hungerrestore	How much hunger is restored?
short	id	Internal ID of this consume info
String	itemname	Name of the related item
int	messagecolor	If a message is shown, this is the message color (as RGB int value).
boolean	remove	Determines if the item should be removed from inventory after consuming
boolean	sendmessage	If true, a consume message is shown to the player (only if the localized string is found)
Items.FoodState	state
boolean	stopbleeding	Does consuming this item stops bleedings?
int	thirstrestore	How much thirst is restored?
Items.ConsumeType	type	Type of this consumable (i.e is this food, water etc?)
float	valuechange	Optional value change of the item after consuming.

Method Summary

Modifier and Type	Method	Description
void	synchronize()

Methods inherited from class java.lang.Object

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

Field Details

id

public short id

Internal ID of this consume info

itemname

public String itemname

Name of the related item

type

public Items.ConsumeType type

Type of this consumable (i.e is this food, water etc?)

state

public Items.FoodState state

healthrestore

public int healthrestore

How much health is restored?

hungerrestore

public int hungerrestore

How much hunger is restored?

thirstrestore

public int thirstrestore

How much thirst is restored?

healbones

public boolean healbones

Does consuming this item heals bones?

stopbleeding

public boolean stopbleeding

Does consuming this item stops bleedings?

remove

public boolean remove

Determines if the item should be removed from inventory after consuming

valuechange

public float valuechange

Optional value change of the item after consuming. Default: 0

disease

public String disease

diseasechance

public float diseasechance

sendmessage

public boolean sendmessage

If true, a consume message is shown to the player (only if the localized string is found)

messagecolor

public int messagecolor

If a message is shown, this is the message color (as RGB int value). If 0, the default color is used

Method Details

synchronize

public void synchronize()