regcom::common::Tile

Tile Class Reference

#include <Tile.h>

List of all members.


Public Member Functions

 Tile ()
 Public constructor.
virtual ~Tile ()
 Virtual destructor.
void Clear ()
 Clears tile.
void SetLevel (int level)
 Sets tile level.
void SetDepth (int depth)
 Sets water depth.
void SetTrees (int trees)
 Sets tree density.
bool IsClear () const
 Checks if tile is clear.
bool IsWater () const
 Checks if tile has water.
bool IsWoods () const
 Check if tile has woods.
bool IsLight () const
 Check if tile has light woods.
bool IsHeavy () const
 Check if tile has heavy woods.
int GetLevel () const
 Gets tile level.
int GetDepth () const
 Gets water depth.
int GetTrees () const
 Gets tree density.
common::ErrorCodeType AddUnit (Unit *unit)
 Adds unit to tile.
common::ErrorCodeType RemoveUnit (Unit *unit)
 Removes unit from tile.

Private Attributes

signed char m_Level
 Tile level.
signed char m_Depth
 Water depth.
signed char m_Trees
 Tree density.

Detailed Description

(*** add brief description here ***)
Full Description
(*** add full description here ***)

Constructor & Destructor Documentation

Tile (  ) 

Public constructor.

Full Description
This method creates a new instance of the class.
Returns:
New instance of the class.

~Tile (  )  [virtual]

Virtual destructor.

Full Description
This method destroys an existing instance of the class.
Returns:
None.

Member Function Documentation

void Clear (  )  [inline]

Clears tile.

void SetLevel ( int  level  )  [inline]

Sets tile level.

void SetDepth ( int  depth  )  [inline]

Sets water depth.

void SetTrees ( int  trees  )  [inline]

Sets tree density.

bool IsClear (  )  const [inline]

Checks if tile is clear.

bool IsWater (  )  const [inline]

Checks if tile has water.

bool IsWoods (  )  const [inline]

Check if tile has woods.

bool IsLight (  )  const [inline]

Check if tile has light woods.

bool IsHeavy (  )  const [inline]

Check if tile has heavy woods.

int GetLevel (  )  const [inline]

Gets tile level.

int GetDepth (  )  const [inline]

Gets water depth.

int GetTrees (  )  const [inline]

Gets tree density.

common::ErrorCodeType AddUnit ( Unit *  unit  ) 

Adds unit to tile.

Full Description
This method adds a unit to the tile.
Returns:
Success of successful.

Failure otherwise.

Todo:
Add unit to the tile.
Parameters:
unit  Pointer to unit.

common::ErrorCodeType RemoveUnit ( Unit *  unit  ) 

Removes unit from tile.

Full Description
This method removes a unit from the tile.
Returns:
Success of successful.

Failure otherwise.

Todo:
Remove unit from the tile.
Parameters:
unit  Pointer to unit.

Member Data Documentation

signed char m_Level [private]

Tile level.

signed char m_Depth [private]

Water depth.

signed char m_Trees [private]

Tree density.

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