micropolisj.engine.ToolPreview Class Reference

Inheritance diagram for micropolisj.engine.ToolPreview:

Collaboration diagram for micropolisj.engine.ToolPreview:

Classes
class	SoundInfo

Public Member Functions
	ToolPreview (int playerID)
int	getTile (int dx, int dy)
CityRect	getBounds ()
void	makeSound (int dx, int dy, Sound sound)
void	setTile (int dx, int dy, int tileValue)
void	spend (int amount)
void	toolResult (ToolResult tr)
int	getPlayerID ()

Public Attributes
int	offsetX
int	offsetY
short[][]	tiles
int	cost
ToolResult	toolResult
List< SoundInfo >	sounds
int	playerID

Detailed Description

Definition at line 16 of file ToolPreview.java.

Constructor & Destructor Documentation

micropolisj.engine.ToolPreview.ToolPreview

(

int

playerID

)

Definition at line 37 of file ToolPreview.java.

References micropolisj.engine.ToolResult.NONE, micropolisj.engine.ToolPreview.playerID, micropolisj.engine.ToolPreview.sounds, micropolisj.engine.ToolPreview.tiles, and micropolisj.engine.ToolPreview.toolResult.

Member Function Documentation

CityRect micropolisj.engine.ToolPreview.getBounds

(

)

Definition at line 54 of file ToolPreview.java.

References micropolisj.engine.ToolPreview.offsetX, and micropolisj.engine.ToolPreview.offsetY.

int micropolisj.engine.ToolPreview.getPlayerID

(

)

Implements micropolisj.engine.ToolEffectIfc.

Definition at line 150 of file ToolPreview.java.

References micropolisj.engine.ToolPreview.playerID.

int micropolisj.engine.ToolPreview.getTile	(	int	dx,
		int	dy
	)

Gets the tile at a relative location.

Returns

a non-negative tile identifier

Implements micropolisj.engine.ToolEffectIfc.

Definition at line 45 of file ToolPreview.java.

References micropolisj.engine.ToolPreview.offsetX, micropolisj.engine.ToolPreview.offsetY, and micropolisj.engine.ToolPreview.tiles.

void micropolisj.engine.ToolPreview.makeSound	(	int	dx,
		int	dy,
		Sound	sound
	)

Implements micropolisj.engine.ToolEffectIfc.

Definition at line 129 of file ToolPreview.java.

References micropolisj.engine.ToolPreview.sounds.

void micropolisj.engine.ToolPreview.setTile	(	int	dx,
		int	dy,
		int	tileValue
	)

Sets the tile value at a relative location.

Implements micropolisj.engine.ToolEffectIfc.

Definition at line 135 of file ToolPreview.java.

References micropolisj.util.Utilities.codePlayerID(), micropolisj.engine.ToolPreview.offsetX, micropolisj.engine.ToolPreview.offsetY, micropolisj.engine.ToolPreview.playerID, and micropolisj.engine.ToolPreview.tiles.

Here is the call graph for this function:

void micropolisj.engine.ToolPreview.spend

(

int

amount

)

Deduct an amount from the controller's cash funds.

Implements micropolisj.engine.ToolEffectIfc.

Definition at line 141 of file ToolPreview.java.

References micropolisj.engine.ToolPreview.cost.

void micropolisj.engine.ToolPreview.toolResult

(

ToolResult

tr

)

Implements micropolisj.engine.ToolEffectIfc.

Definition at line 146 of file ToolPreview.java.

References micropolisj.engine.ToolPreview.toolResult.

Member Data Documentation

int micropolisj.engine.ToolPreview.cost

Definition at line 20 of file ToolPreview.java.

Referenced by micropolisj.engine.ToolPreview.spend().

int micropolisj.engine.ToolPreview.offsetX

Definition at line 17 of file ToolPreview.java.

Referenced by micropolisj.engine.ToolPreview.getBounds(), micropolisj.engine.ToolPreview.getTile(), and micropolisj.engine.ToolPreview.setTile().

int micropolisj.engine.ToolPreview.offsetY

Definition at line 18 of file ToolPreview.java.

Referenced by micropolisj.engine.ToolPreview.getBounds(), micropolisj.engine.ToolPreview.getTile(), and micropolisj.engine.ToolPreview.setTile().

int micropolisj.engine.ToolPreview.playerID

Definition at line 23 of file ToolPreview.java.

Referenced by micropolisj.engine.ToolPreview.getPlayerID(), micropolisj.engine.ToolPreview.setTile(), and micropolisj.engine.ToolPreview.ToolPreview().

List<SoundInfo> micropolisj.engine.ToolPreview.sounds

Definition at line 22 of file ToolPreview.java.

Referenced by micropolisj.engine.ToolPreview.makeSound(), and micropolisj.engine.ToolPreview.ToolPreview().

short [][] micropolisj.engine.ToolPreview.tiles

Definition at line 19 of file ToolPreview.java.

Referenced by micropolisj.engine.ToolPreview.getTile(), micropolisj.engine.ToolPreview.setTile(), and micropolisj.engine.ToolPreview.ToolPreview().

ToolResult micropolisj.engine.ToolPreview.toolResult

Definition at line 21 of file ToolPreview.java.

Referenced by micropolisj.engine.ToolPreview.ToolPreview(), and micropolisj.engine.ToolPreview.toolResult().

---

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

• src/micropolisj/engine/ToolPreview.java