us.asciiroth.client.terrain
Class Turnstile

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

All Implemented Interfaces:

Animated, ColorListener, Piece, Terrain

public class Turnstile
extends AbstractTerrain
implements Animated, ColorListener

Creates a one-way passage to either the west or the east. Agent must enter straight on, like a door, but once inside, you must move east or west, and you can't go back the way you came. Pushables can be pushed through a turnstile, but they follow the same rules. Flashes its trigger color.

Field Summary

static Serializer<Turnstile>

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.
Direction	getDirection() Get the direction this turnstile allows an agent to move (east or west), without the ability to return.
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.
void	onFrame(Context ctx, Cell cell, int frame) Animation callback, executed once each frame for each piece animated on the board.
boolean	randomSeed() Should this animation start with a randomly seeded number as its first frame? For some animations, this can prevent all presentations of the piece on the board executing the same animation frame at the same time.

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<Turnstile> 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)

getDirection

public Direction getDirection()

Get the direction this turnstile allows an agent to move (east or west), without the ability to return.

Returns:

the one-way direction of the turnstile.

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

onFrame

public void onFrame(Context ctx,
                    Cell cell,
                    int frame)

Description copied from interface: Animated

Animation callback, executed once each frame for each piece animated on the board.

Specified by:

onFrame in interface Animated

randomSeed

public boolean randomSeed()

Description copied from interface: Animated

Should this animation start with a randomly seeded number as its first frame? For some animations, this can prevent all presentations of the piece on the board executing the same animation frame at the same time.

Specified by:

randomSeed in interface Animated

Returns:

true if a random frame should begin the animated piece's timeline