us.asciiroth.client.terrain
Class Door

java.lang.Object
  us.asciiroth.client.core.AbstractPiece
      us.asciiroth.client.terrain.AbstractTerrain
          us.asciiroth.client.terrain.Door

All Implemented Interfaces:

ColorListener, Piece, Terrain

public class Door
extends AbstractTerrain
implements ColorListener

A door that can be open (unlocked) or closed (locked). In the latter case, it can only be opened by a color event for the color of the door, or by the use of a key of the same color as the door.

Field Summary

static Serializer<Door>

SERIALIZER Type serializer.

Method Summary

boolean	canEnter(Agent agent, Cell cell, Direction direction) Can the (non-player) agent enter this terrain? Without regard to side effects, this method should determine if the agent can actually move into the cell.
boolean	canExit(Agent agent, Cell cell, Direction direction) Can the (non-player) agent exit this terrain? Without regard to side effects, this method should determine if the agent can actually move into the cell.
State	getState() Get state of door
void	onAgentEnter(Event event, Agent agent, Cell cell, Direction dir)
void	onAgentExit(Event event, Agent agent, Cell cell, Direction dir)
void	onColorEvent(Context ctx, Cell cell, Cell origin) Terrain has received a color event, probably related to the firing of a color event on the board.
void	onEnter(Event event, Player player, Cell cell, Direction dir) Agent attempting to leave the from cell, heading toward the to cell.
void	onExit(Event event, Player player, Cell cell, Direction dir) Agent attempting to exit the from cell, heading toward the to cell.
void	onFlyOver(Event event, Cell cell, InFlightItem flier) Terrain has an item flying over it.

Methods inherited from class us.asciiroth.client.terrain.AbstractTerrain

onAdjacentTo, onDrop, onNotAdjacentTo, onPickup

Methods inherited from class us.asciiroth.client.core.AbstractPiece

getColor, getName, getSymbol, is, not

Methods inherited from class java.lang.Object

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

Methods inherited from interface us.asciiroth.client.core.Piece

getColor, getName, getSymbol, is, not

Field Detail

SERIALIZER

public static final Serializer<Door> SERIALIZER

Type serializer.

Method Detail

canEnter

public boolean canEnter(Agent agent,
                        Cell cell,
                        Direction direction)

Description copied from interface: Terrain

Can the (non-player) agent enter this terrain? Without regard to side effects, this method should determine if the agent can actually move into the cell. Error on the side of caution and return false if the answer is ambiguous.

Specified by:

canEnter in interface Terrain

Overrides:

canEnter in class AbstractTerrain

Returns:

true if the agent can enter the terrain moving between the two cells using the indicated direction

See Also:

Cell.canEnter(Cell, Agent, Direction, boolean)

canExit

public boolean canExit(Agent agent,
                       Cell cell,
                       Direction direction)

Description copied from interface: Terrain

Can the (non-player) agent exit this terrain? Without regard to side effects, this method should determine if the agent can actually move into the cell. Error on the side of caution and return false if the answer is ambiguous.

Specified by:

canExit in interface Terrain

Overrides:

canExit in class AbstractTerrain

Returns:

true if the agent can leave this cell going in the indicated direction

See Also:

Cell.canEnter(Cell, Agent, Direction, boolean)

getState

public State getState()

Get state of door

Returns:

state of door (on for open, off for closed)

onAgentEnter

public void onAgentEnter(Event event,
                         Agent agent,
                         Cell cell,
                         Direction dir)

Specified by:

onAgentEnter in interface Terrain

Overrides:

onAgentEnter in class AbstractTerrain

onAgentExit

public void onAgentExit(Event event,
                        Agent agent,
                        Cell cell,
                        Direction dir)

Specified by:

onAgentExit in interface Terrain

Overrides:

onAgentExit in class AbstractTerrain

onColorEvent

public void onColorEvent(Context ctx,
                         Cell cell,
                         Cell origin)

Description copied from interface: ColorListener

Terrain has received a color event, probably related to the firing of a color event on the board. Different terrain behave differently when triggered, most flip between a set of states.

Specified by:

onColorEvent in interface ColorListener

Parameters:

ctx - a context object with references to game state

onEnter

public void onEnter(Event event,
                    Player player,
                    Cell cell,
                    Direction dir)

Description copied from interface: Terrain

Agent attempting to leave the from cell, heading toward the to cell. The terrain being used is the terrain of the to cell. The agent is still in the from

Specified by:

onEnter in interface Terrain

Overrides:

onEnter in class AbstractTerrain

onExit

public void onExit(Event event,
                   Player player,
                   Cell cell,
                   Direction dir)

Description copied from interface: Terrain

Agent attempting to exit the from cell, heading toward the to cell. The terrain being used is the from cell terrain, and the agent is still in the from cell. If the event is canceled at this point, the agent will not be able leave this cell. The move will be canceled. This event is fired for the player as well as all other agents

Specified by:

onExit in interface Terrain

Overrides:

onExit in class AbstractTerrain

onFlyOver

public void onFlyOver(Event event,
                      Cell cell,
                      InFlightItem flier)

Description copied from interface: Terrain

Terrain has an item flying over it. If the event is canceled at this point, the item will fall to the ground on this cell.

Specified by:

onFlyOver in interface Terrain

Overrides:

onFlyOver in class AbstractTerrain