org.codetome.hexameter.core.api

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
<T> void	addCustomData(String key, T data) Adds custom data to this SatelliteData.
<T> Optional<T>	getCustomData(String key) Retrieves custom data stored in this SatelliteData.
double	getMovementCost() Returns the movement cost when moving over the Hexagon.
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	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?

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

addCustomData

<T> void addCustomData(String key,
                       T data)

Adds custom data to this SatelliteData.

Type Parameters:

T - type of the data

Parameters:

key - a key to be used for later retrieval

data - the data itself

getCustomData

<T> Optional<T> getCustomData(String key)

Retrieves custom data stored in this SatelliteData.

Type Parameters:

T - type of the data

Parameters:

key - the key which can be used to fetch the data

Returns:

data itself