Package org.bitbrawl.foodfight.field

Enum Event

java.lang.Object

java.lang.Enum<Event>

org.bitbrawl.foodfight.field.Event

All Implemented Interfaces:

Serializable, Comparable<Event>

public enum Event
extends Enum<Event>

An event in the game that is worth some number of points. A team's Score is based on the number of times that each of these events occurs. Each event has a type, either Event.Type.ONE_TIME or Event.Type.ONGOING. One-time events can happen a maximum of once per team in a match, while ongoing events can occur multiple times. Each event has a point value, and a negative point value represents a "bad" event that competitors may wish to avoid.

Here is a list of all of the one-time events:

• FIRST_MOVE: 1 point
• FIRST_PICKUP: 5 points
• FIRST_THROW: 10 points
• FIRST_EAT: 50 points
• FIRST_PLAYER_COLLISION: -2 points
• FIRST_FOOD_COLLISION: -100 points

And here is a list of all of the ongoing events:

• EVERY_EAT: 5 points
• FOOD_ON_TABLE: 1 point
• EVERY_PLAYER_COLLISION: -1 point
• EVERY_FOOD_COLLISION: -500 points
• TIE_BREAK: 1 point

Author:

Finn

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Event.Type	The type of an event, either one-time or ongoing.

Enum Constant Summary

Enum Constants

Enum Constant	Description
EVERY_EAT	Occurs every time a player performs an "eat" action.
EVERY_FOOD_COLLISION	Occurs every time a player collides with a food piece.
EVERY_PLAYER_COLLISION	Occurs every time a player collides with another.
FIRST_EAT	Occurs when a player performs an "eat" action for the first time.
FIRST_FOOD_COLLISION	Occurs when a player collides with a food piece for the first time.
FIRST_MOVE	Occurs when a player performs a "move" action for the first time.
FIRST_PICKUP	Occurs when a player performs a "pickup" action for the first time.
FIRST_PLAYER_COLLISION	Occurs when a player collides with another for the first time.
FIRST_THROW	Occurs when a player performs a "throw" action for the first time.
FOOD_ON_TABLE	Occurs once per turn for every piece of food on a team's table.
TIE_BREAK	Occurs when a tie must be broken by distance to the center.

Method Summary

Modifier and Type	Method	Description
int	getPointValue()	Gets the value of this event to a team's score.
Event.Type	getType()	Returns the type of this action, either one-time or ongoing.
String	toString()	Returns a human-readable name for this event that differs from what will be returned by Enum.name().
static Event	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Event[]	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

FIRST_MOVE

@SerializedName("firstMove")
public static final Event FIRST_MOVE

Occurs when a player performs a "move" action for the first time.

FIRST_PICKUP

@SerializedName("firstPickup")
public static final Event FIRST_PICKUP

Occurs when a player performs a "pickup" action for the first time.

FIRST_THROW

@SerializedName("firstThrow")
public static final Event FIRST_THROW

Occurs when a player performs a "throw" action for the first time.

FIRST_EAT

@SerializedName("firstEat")
public static final Event FIRST_EAT

Occurs when a player performs an "eat" action for the first time.

FIRST_PLAYER_COLLISION

@SerializedName("firstPlayerCollision")
public static final Event FIRST_PLAYER_COLLISION

Occurs when a player collides with another for the first time.

FIRST_FOOD_COLLISION

@SerializedName("firstFoodCollision")
public static final Event FIRST_FOOD_COLLISION

Occurs when a player collides with a food piece for the first time.

EVERY_EAT

@SerializedName("everyEat")
public static final Event EVERY_EAT

Occurs every time a player performs an "eat" action.

FOOD_ON_TABLE

@SerializedName("foodOnTable")
public static final Event FOOD_ON_TABLE

Occurs once per turn for every piece of food on a team's table.

EVERY_PLAYER_COLLISION

@SerializedName("everyPlayerCollision")
public static final Event EVERY_PLAYER_COLLISION

Occurs every time a player collides with another.

EVERY_FOOD_COLLISION

@SerializedName("everyFoodCollision")
public static final Event EVERY_FOOD_COLLISION

Occurs every time a player collides with a food piece.

TIE_BREAK

@SerializedName("tieBreak")
public static final Event TIE_BREAK

Occurs when a tie must be broken by distance to the center.

Method Detail

values

public static Event[] 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 (Event c : Event.values())
    System.out.println(c);

Returns:

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

valueOf

public static Event 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 event 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<Event>

Returns:

a human-readable name for this event

getType

public Event.Type getType()

Returns the type of this action, either one-time or ongoing.

Returns:

this action's type

getPointValue

public int getPointValue()

Gets the value of this event to a team's score. A positive value indicates an increase to a team's score, while a negative value indicates a decrease.

Returns:

this event's point value