Package org.bitbrawl.foodfight.controller

Enum Controller.Action

java.lang.Object

java.lang.Enum<Controller.Action>

org.bitbrawl.foodfight.controller.Controller.Action

All Implemented Interfaces:

Serializable, Comparable<Controller.Action>

Enclosing interface:

Controller

@Immutable
public static enum Controller.Action
extends Enum<Controller.Action>

An action that a controller can choose to play on a turn. Each turn, each controller can select one of these actions based on the current field state.

Author:

Finn

Enum Constant Summary

Enum Constants

Enum Constant	Description
DUCK	A duck, which will decrease a player's height.
EAT_LEFT	The action of eating the food in the player's left hand.
EAT_RIGHT	The action of eating the food in the player's right hand.
MOVE_BACKWARD	A movement in the backward direction.
MOVE_FORWARD	A movement in the direction that a player is facing.
PICKUP_LEFT	A pickup of a piece of food into the player's left hand.
PICKUP_RIGHT	A pickup of a piece of food into the player's right hand.
THROW_LEFT	A throw from the player's left hand.
THROW_RIGHT	A throw from the player's right hand.
TURN_LEFT	A turn in the counter-clockwise direction.
TURN_RIGHT	A turn in the clockwise direction.

Method Summary

Modifier and Type	Method	Description
boolean	isEating()	Determines whether this action is one of the "eat" actions.
boolean	isMoving()	Determines whether this action is one of the "move" actions.
boolean	isPickingUp()	Determines whether this action is one of the "pickup" actions.
boolean	isThrowing()	Determines whether this action is one of the "throw" actions.
boolean	isTurning()	Determines whether this action is one of the "turn" actions.
String	toString()	Returns a human-readable name for this action that differs from what will be returned by Enum.name().
static Controller.Action	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Controller.Action[]	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

MOVE_FORWARD

@SerializedName("moveForward")
public static final Controller.Action MOVE_FORWARD

A movement in the direction that a player is facing.

MOVE_BACKWARD

@SerializedName("moveBackward")
public static final Controller.Action MOVE_BACKWARD

A movement in the backward direction.

TURN_LEFT

@SerializedName("turnLeft")
public static final Controller.Action TURN_LEFT

A turn in the counter-clockwise direction.

TURN_RIGHT

@SerializedName("turnRight")
public static final Controller.Action TURN_RIGHT

A turn in the clockwise direction.

DUCK

@SerializedName("duck")
public static final Controller.Action DUCK

A duck, which will decrease a player's height.

PICKUP_LEFT

@SerializedName("pickupLeft")
public static final Controller.Action PICKUP_LEFT

A pickup of a piece of food into the player's left hand.

PICKUP_RIGHT

@SerializedName("pickupRight")
public static final Controller.Action PICKUP_RIGHT

A pickup of a piece of food into the player's right hand.

THROW_LEFT

@SerializedName("throwLeft")
public static final Controller.Action THROW_LEFT

A throw from the player's left hand.

THROW_RIGHT

@SerializedName("throwRight")
public static final Controller.Action THROW_RIGHT

A throw from the player's right hand.

EAT_LEFT

@SerializedName("eatLeft")
public static final Controller.Action EAT_LEFT

The action of eating the food in the player's left hand.

EAT_RIGHT

@SerializedName("eatRight")
public static final Controller.Action EAT_RIGHT

The action of eating the food in the player's right hand.

Method Detail

values

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

Returns:

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

valueOf

public static Controller.Action 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 action 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<Controller.Action>

Returns:

a human-readable name for this action

isMoving

public boolean isMoving()

Determines whether this action is one of the "move" actions. The two move actions are MOVE_FORWARD and MOVE_BACKWARD.

Returns:

true if this action moves the player, otherwise false

isTurning

public boolean isTurning()

Determines whether this action is one of the "turn" actions. The two turn actions are TURN_LEFT and TURN_RIGHT.

Returns:

true if this action turns the player, otherwise false

isPickingUp

public boolean isPickingUp()

Determines whether this action is one of the "pickup" actions. The two pickup actions are PICKUP_LEFT and PICKUP_RIGHT.

Returns:

true if this action picks up food, otherwise false

isThrowing

public boolean isThrowing()

Determines whether this action is one of the "throw" actions. The two throw actions are THROW_LEFT and THROW_RIGHT.

Returns:

true if this action throws food, otherwise false

isEating

public boolean isEating()

Determines whether this action is one of the "eat" actions. The two eat actions are EAT_LEFT and EAT_RIGHT.

Returns:

true if this action eats food, otherwise false