Unit.h

00001 //**********************************************************************
00002 //
00003 //  REGCOM: Regimental Command
00004 //  Copyright (C) 2008 Randi J. Relander
00005 //    <rjrelander@users.sourceforge.net>
00006 //
00007 //  This program is free software; you can redistribute it and/or
00008 //  modify it under the terms of the GNU General Public License
00009 //  as published by the Free Software Foundation; either version 3
00010 //  of the License, or (at your option) any later version.
00011 //  
00012 //  This program is distributed in the hope that it will be useful,
00013 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
00014 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015 //  GNU General Public License for more details.
00016 //  
00017 //  You should have received a copy of the GNU General Public
00018 //  License along with this program.  If not, see 
00019 //  <http://www.gnu.org/licenses/>.
00020 //  
00021 //**********************************************************************
00022 
00023 #ifndef REGCOM_COMMON_UNIT_H
00024 #define REGCOM_COMMON_UNIT_H
00025 
00026 // PROJECT INCLUDES
00027 #include "regcom/common/ErrorCode.h"
00028 
00029 // NAMESPACES
00030 namespace regcom {
00031 namespace common {
00032 
00033 // FORWARD REFERENCES
00034 class Map;
00035 
00037 //  CLASS: Unit
00043 class Unit  
00044 {
00045 public:
00046 
00047     // PUBLIC METHODS
00048 
00050     Unit();
00051 
00053     virtual ~Unit();
00054 
00056     common::ErrorCodeType PlaceOnMap(Map* pMap, int x, int y);
00057 
00059     common::ErrorCodeType RemoveFromMap();
00060 
00062     common::ErrorCodeType MoveTo(int x, int y);
00063 
00064 private:
00065 
00066     // MEMBER VARIABLES
00067 
00069     int m_IdCode;
00070 
00072     Map* m_pMap;
00073     
00075     int m_TileX;
00076 
00078     int m_TileY;
00079 };
00080 
00081 } // namespace common
00082 } // namespace regcom
00083 
00084 #endif