Package org.bitbrawl.foodfight.field

Interface Food

All Superinterfaces:

Locatable

public interface Food
extends Locatable

A piece of food on the field. At any time, if a food piece is not on a table or in a player's inventory, it is either on the ground (in which case getHeight() is zero) or it is in the air. If it is on the ground, it will not move between turns. If it in the air, it will move a distance of SPEED each turn in the direction of getHeading(), and its height will decrease by FALL_SPEED each turn.

For collision purposes, food pieces can be thought of as disks parallel to the ground plane of the field. getHeight() represents the distance between the food piece disk and the ground. The radius of the disk is dependent on the type of food, and can be retrieved with the Food.Type.getRadius() method. The center of the disk can be located with Locatable.getLocation(), which is relative to the lower-left corner of the field when viewed from above.

Note that this class is not used to represent food on tables or in players' inventories, only food on the ground or in the air. Food pieces on tables and in inventories do not have a location, height, or heading, so they are represented only by their Food.Type.

Author:

Finn

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Food.Type	A type of food.

Field Summary

Fields

Modifier and Type	Field	Description
static RandomScalar	FALL_SPEED	The vertical distance traveled by an airborne food piece each turn.
static double	RESPAWN_RATE	The probability of new food spawning on a turn with missing food.
static RandomScalar	SPEED	The horizontal distance traveled by an airborne food piece each turn.

Method Summary

Modifier and Type	Method	Description
Direction	getHeading()	Returns the direction of travel of this food piece.
double	getHeight()	Returns the distance between the ground plane and this piece of food.
Food.Type	getType()	Returns the type of this piece of food.

Methods inherited from interface org.bitbrawl.foodfight.field.Locatable

getLocation

Field Detail

SPEED

static final RandomScalar SPEED

The horizontal distance traveled by an airborne food piece each turn.

FALL_SPEED

static final RandomScalar FALL_SPEED

The vertical distance traveled by an airborne food piece each turn.

RESPAWN_RATE

static final double RESPAWN_RATE

The probability of new food spawning on a turn with missing food.

See Also:

Constant Field Values

Method Detail

getType

Food.Type getType()

Returns the type of this piece of food.

Returns:

this food object's type

getHeight

double getHeight()

Returns the distance between the ground plane and this piece of food.

Returns:

the height of this piece of food

getHeading

Direction getHeading()

Returns the direction of travel of this food piece. This food piece will continue moving in this direction every turn unless it reaches the ground or collides with something.

Returns:

the direction in which this food piece is moving