Package org.bitbrawl.foodfight.field

Enum Food.Type

java.lang.Object

java.lang.Enum<Food.Type>

org.bitbrawl.foodfight.field.Food.Type

All Implemented Interfaces:

Serializable, Comparable<Food.Type>

Enclosing interface:

Food

@ThreadSafe
public static enum Food.Type
extends Enum<Food.Type>

A type of food. Each food type has slightly different properties. Here is a table representing the various food types:

Name	Radius	Energy	Damage
APPLE	20	20 ± 1	20 ± 1
BANANA	20	20 ± 2	20 ± 1
RASPBERRY	10	10 ± 1	10 ± 2
BROCCOLI	20	50 ± 1	10 ± 1
MILK	20	50 ± 1	20 ± 5
CHOCOLATE	20	50 ± 1	20 ± 1
SANDWICH	20	50 ± 2	20 ± 1
PIE	50	50 ± 1	100 ± 1

For information about what the "±" means, please see the RandomScalar class.

Author:

Finn

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPLE	An apple.
BANANA	A banana.
BROCCOLI	A piece of broccoli.
CHOCOLATE	A bar of chocolate.
MILK	A milk carton.
PIE	A pie, the most powerful weapon.
RASPBERRY	A raspberry, the least powerful piece of food.
SANDWICH	A sandwich.

Method Summary

Modifier and Type	Method	Description
RandomScalar	getDamage()	Returns the damage incurred when a player collides with an airborne food piece of this type.
RandomScalar	getEnergy()	Returns the energy gained by eating food of this type.
double	getRadius()	Returns the radius of food pieces of this type.
String	toString()	Returns a human-readable name for this food type that differs from what will be returned by Enum.name().
static Food.Type	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Food.Type[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

APPLE

@SerializedName("apple")
public static final Food.Type APPLE

An apple.

BANANA

@SerializedName("banana")
public static final Food.Type BANANA

A banana.

RASPBERRY

@SerializedName("raspberry")
public static final Food.Type RASPBERRY

A raspberry, the least powerful piece of food.

BROCCOLI

@SerializedName("broccoli")
public static final Food.Type BROCCOLI

A piece of broccoli.

MILK

@SerializedName("milk")
public static final Food.Type MILK

A milk carton.

CHOCOLATE

@SerializedName("chocolate")
public static final Food.Type CHOCOLATE

A bar of chocolate.

SANDWICH

@SerializedName("sandwich")
public static final Food.Type SANDWICH

A sandwich.

PIE

@SerializedName("pie")
public static final Food.Type PIE

A pie, the most powerful weapon.

Method Detail

values

public static Food.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Food.Type c : Food.Type.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Food.Type valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Returns a human-readable name for this food type that differs from what will be returned by Enum.name(). It will be a bit more readable by human eyes, and is intended primarily for debugging purposes.

Overrides:

toString in class Enum<Food.Type>

Returns:

a human-readable name for this food type

getRadius

public double getRadius()

Returns the radius of food pieces of this type. Larger food pieces may be more likely to collide with their targets.

Returns:

the radius of all food pieces of this type

getEnergy

public RandomScalar getEnergy()

Returns the energy gained by eating food of this type. If a player spends a turn eating food of this type from their inventory, their Player.getEnergy() will increase by this amount.

Returns:

the energy contained in food of this type

getDamage

public RandomScalar getDamage()

Returns the damage incurred when a player collides with an airborne food piece of this type.

Returns:

the damage value of this food type