Tile Class Reference

#include <Tile.h>

Public Member Functions
float	getWalkModifier () const
	Tile (Tilemap &tilemap, int id, int x, int y, int w, int h, const std::string &newName, int newTypeId, bool newHarvestable, bool newWalkable, float newWalkModifier, int newResources, const std::string &depletedName, int depletedTypeId, bool depletedHarvestable, bool depletedWalkable, float depletedWalkmMdifier, int depletedResources, float lumberYield, float goldYield, float stoneYield)
Position	getPosition () const
bool	isAttackable (Unit &unit)
bool	isWalkable () const
bool	isHarvestable () const
bool	isBuildable () const
int	distance (Tile &sourceTile) const
Unit *	getOccupant ()
int	getOccupantID () const
bool	hasOccupant () const
int	getResources () const
bool	isDepleted () const
int	getTypeId () const
Tilemap &	getTilemap () const
const std::string &	getName () const
int	getDepleteTile () const
void	triggerOnTileChange ()
void	setOccupant (Unit *unit)
void	setOccupantID (int unitID)
void	setDepleted ()
	Sets the tile to deplted. More...
void	setResources (uint16_t resource_count)
void	takeResource (uint8_t n)
void	reset ()
	Reset tile. More...

Public Attributes
const int	id
	The TileID. More...
const int	x
	The x position of the tile. More...
const int	y
	THe y position of the tile. More...
const int	width
	The width of the tile (usually 1) More...
const int	height
	The height of the tile (usually 1) More...
const float	lumberYield
	The number of lumber the tile yields on harvesting. More...
const float	goldYield
	The number of hgold the tile yields on harvesting. More...
const float	stoneYield
	The number of stone the tile yields on harvesting. More...

Detailed Description

The tile class represent a single tile in the Tilemap A unit can occupy a tile Resources can occupy a tile A tile can be swimable, walkable, non-walkable and so on.

Constructor & Destructor Documentation

Tile()

Tile::Tile	(	Tilemap &	tilemap,
		int	id,
		int	x,
		int	y,
		int	w,
		int	h,
		const std::string &	newName,
		int	newTypeId,
		bool	newHarvestable,
		bool	newWalkable,
		float	newWalkModifier,
		int	newResources,
		const std::string &	depletedName,
		int	depletedTypeId,
		bool	depletedHarvestable,
		bool	depletedWalkable,
		float	depletedWalkmMdifier,
		int	depletedResources,
		float	lumberYield,
		float	goldYield,
		float	stoneYield
	)

A horrible Tile constructor which requires all properties of a tile. Usually you dont want to touch this....

Parameters

tilemap
id
x
y
w
h
newName
newTypeId
newHarvestable
newWalkable
newWalkModifier
newResources
depletedName
depletedTypeId
depletedHarvestable
depletedWalkable
depletedWalkmMdifier
depletedResources
lumberYield
goldYield
stoneYield

Member Function Documentation

distance()

int Tile::distance

(

Tile &

sourceTile

)

const

Get distance between this tile and another tile

Parameters

sourceTile

the source tile

Returns

distance in air

getDepleteTile()

int Tile::getDepleteTile

(

)

const

Get the tile ID when this tile is depleted.

Returns

getName()

const std::string & Tile::getName

(

)

const

Get the name of the tile

Returns

name

getOccupant()

Unit * Tile::getOccupant

(

)

Get occupant Unit pointer

Returns

Unit* occupant

getOccupantID()

int Tile::getOccupantID

(

)

const

Get ID for a occupant on this tile

Returns

id of occupant

getPosition()

Position Tile::getPosition

(

)

const

Getters Retrieve the position of the tile

Returns

The position

getResources()

int Tile::getResources

(

)

const

Get resource count

Returns

resource count

getTilemap()

Tilemap & Tile::getTilemap

(

)

const

Get the tilemap reference (tile's parent)

Returns

getTypeId()

int Tile::getTypeId

(

)

const

Get the type if this tile

Returns

TIle ID

getWalkModifier()

float Tile::getWalkModifier

(

)

const

Get the walk modifier of the specified tile

Returns

modifier value

hasOccupant()

bool Tile::hasOccupant

(

)

const

Check if tile has a occupant

Returns

evaluation

isAttackable()

bool Tile::isAttackable

(

Unit &

unit

)

Check if there is a entity occupying the tile which is attackable

Parameters

unit	attacker unit reference

Returns

is there a attackable unit here?

isBuildable()

bool Tile::isBuildable

(

)

const

Check if tile is Buildable

Returns

is it buildable?

isDepleted()

bool Tile::isDepleted

(

)

const

Check if the tile is depleted.

Returns

isDepleted?

isHarvestable()

bool Tile::isHarvestable

(

)

const

Check if tile is Harvestable

Returns

is it harvestable?

isWalkable()

bool Tile::isWalkable

(

)

const

Check if tile is Walkable

Returns

is it walkable?

reset()

void Tile::reset

(

)

Reset tile.

Functions

setDepleted()

void Tile::setDepleted

(

)

Sets the tile to deplted.

setOccupant()

void Tile::setOccupant

(

Unit *

unit

)

Setters SEt the occupant using a Pointer to the unit.

Parameters

unit

setOccupantID()

void Tile::setOccupantID

(

int

unitID

)

Set the occupant id of this tile

Parameters

unitID

setResources()

void Tile::setResources

(

uint16_t

resource_count

)

Set the resouce count of this tile

Parameters

resource_count

takeResource()

void Tile::takeResource

(

uint8_t

n

)

Take a n count of resources from this tile.

Parameters

n

triggerOnTileChange()

void Tile::triggerOnTileChange

(

)

This function is used to trigger a callback which signifies that a tile has changed. Used to render graphics when required.

Member Data Documentation

goldYield

const float Tile::goldYield

The number of hgold the tile yields on harvesting.

height

const int Tile::height

The height of the tile (usually 1)

id

const int Tile::id

The TileID.

lumberYield

const float Tile::lumberYield

The number of lumber the tile yields on harvesting.

stoneYield

const float Tile::stoneYield

The number of stone the tile yields on harvesting.

width

const int Tile::width

The width of the tile (usually 1)

x

const int Tile::x

The x position of the tile.

y

const int Tile::y

THe y position of the tile.

---

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

• /home/per/git/code/deep-rts/include/DeepRTS/Tile.h
• /home/per/git/code/deep-rts/src/Tile.cpp