Inheritance diagram for rabbitescape.engine.WaterRegion:

Collaboration diagram for rabbitescape.engine.WaterRegion:

[legend]

Public Member Functions
	WaterRegion (int x, int y, Set< CellularDirection > connections, int capacity)

	WaterRegion (int x, int y, Set< CellularDirection > connections, int capacity, boolean outsideWorld)

	WaterRegion (int x, int y, Set< CellularDirection > connections, int capacity, int contents, boolean outsideWorld)

Position	getPosition ()

int	getContents ()

void	setContents (int contents)

void	addContents (int delta)

boolean	isConnected (CellularDirection direction)

Iterator< CellularDirection >	getConnectionsIterator ()

int	getFlow (CellularDirection direction)

void	calcNewState (World world)

void	step (World world)

Map< String, String >	saveState ()

void	restoreFromState (Map< String, String > state)

int	hashCode ()

boolean	equals (Object obj)

String	toString ()

String	overlayText ()

Public Member Functions inherited from rabbitescape.engine.Thing
	Thing (int x, int y, State state)

abstract void	calcNewState (World world)

abstract void	step (World world)

abstract Map< String, String >	saveState ()

abstract void	restoreFromState (Map< String, String > state)

abstract String	overlayText ()

Public Attributes
int	capacity

final boolean	outsideWorld

Public Attributes inherited from rabbitescape.engine.Thing
State	state

int	x

int	y

Private Attributes
Set< CellularDirection >	connections

int	contents

Map< CellularDirection, Integer >	flow = new HashMap<>()

Constructor & Destructor Documentation

rabbitescape.engine.WaterRegion.WaterRegion	(	int	x,
		int	y,
		Set< CellularDirection >	connections,
		int	capacity
	)

rabbitescape.engine.WaterRegion.WaterRegion	(	int	x,
		int	y,
		Set< CellularDirection >	connections,
		int	capacity,
		boolean	outsideWorld
	)

rabbitescape.engine.WaterRegion.WaterRegion	(	int	x,
		int	y,
		Set< CellularDirection >	connections,
		int	capacity,
		int	contents,
		boolean	outsideWorld
	)

Member Function Documentation

void rabbitescape.engine.WaterRegion.addContents ( int delta )

void rabbitescape.engine.WaterRegion.calcNewState ( World world )

boolean rabbitescape.engine.WaterRegion.equals ( Object obj )

Iterator<CellularDirection> rabbitescape.engine.WaterRegion.getConnectionsIterator ( )

int rabbitescape.engine.WaterRegion.getContents ( )

int rabbitescape.engine.WaterRegion.getFlow ( CellularDirection direction )

Get the amount of water being transferred from here in a given direction this tick.

Parameters

direction The direction of interest.

Returns: The amount of water.

Position rabbitescape.engine.WaterRegion.getPosition ( )

Implements rabbitescape.engine.util.LookupItem2D.

int rabbitescape.engine.WaterRegion.hashCode ( )

boolean rabbitescape.engine.WaterRegion.isConnected ( CellularDirection direction )

Is this region connected in the specified direction? Note that this does not mean that water can necessarily flow that way, because the cell in that direction may have no water region, or it may have a region that is not connected to here (e.g. two adjacent left ramps).

String rabbitescape.engine.WaterRegion.overlayText ( )

Implements rabbitescape.engine.ShownOnOverlay.

void rabbitescape.engine.WaterRegion.restoreFromState ( Map< String, String > state )

Map<String, String> rabbitescape.engine.WaterRegion.saveState ( )

void rabbitescape.engine.WaterRegion.setContents ( int contents )

void rabbitescape.engine.WaterRegion.step ( World world )

String rabbitescape.engine.WaterRegion.toString ( )

Member Data Documentation

int rabbitescape.engine.WaterRegion.capacity

The amount of water that can stay here without being under pressure.

Set<CellularDirection> rabbitescape.engine.WaterRegion.connections

private

The list of directions that this region is connected in. Note that this does not mean that water can necessarily flow that way, because the cell in that direction may have no water region, or it may have a region that is not connected to here (e.g. two adjacent left ramps).

int rabbitescape.engine.WaterRegion.contents

private

The amount of water stored here.

Map<CellularDirection, Integer> rabbitescape.engine.WaterRegion.flow = new HashMap<>()

private

The water being transferred from here this tick.

final boolean rabbitescape.engine.WaterRegion.outsideWorld

Does this region need updating?

The documentation for this class was generated from the following file:

rabbit-escape-engine/src/rabbitescape/engine/WaterRegion.java

Public Member Functions

Public Attributes

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation