org.codetome.hexameter.core.api.contract

Interface SatelliteData

All Known Implementing Classes:

DefaultSatelliteData

public interface SatelliteData

Represents arbitrary data which can be attached to a Hexagon. An implementation should contain a set of fields for advanced grid algorithms like pathfinding.

Method Summary

Modifier and Type	Method and Description
double	getMovementCost() Returns the movement cost when moving over the Hexagon.
boolean	isOpaque()
boolean	isPassable() Tells whether the Hexagon can be passed over when moving around the map or not.
void	setMovementCost(double movementCost) Sets the movement cost.
void	setOpaque(boolean opaque) Set whether the Hexagon can be seen through.
void	setPassable(boolean passable) Sets whether the Hexagon is passable or not.

Method Detail

isPassable

boolean isPassable()

Tells whether the Hexagon can be passed over when moving around the map or not.

Returns:

is passable?

setPassable

void setPassable(boolean passable)

Sets whether the Hexagon is passable or not.

Parameters:

passable - passable?

isOpaque

boolean isOpaque()

Returns:

true if the Hexagon can bee seen through, false otherwise.

setOpaque

void setOpaque(boolean opaque)

Set whether the Hexagon can be seen through.

Parameters:

opaque - is opaque?

getMovementCost

double getMovementCost()

Returns the movement cost when moving over the Hexagon.

Returns:

movement cost

setMovementCost

void setMovementCost(double movementCost)

Sets the movement cost.

Parameters:

movementCost - movement cost