src/unit.hh

   1 /*
   2  * This file includes the definitions for the unit specific classes
   3  * derived from the Kingdom, Type and Entity base classes
   4  *
   5  * This file is part of OpenStranded
   6  *
   7  * Copyright (C) 2008 David Kolossa
   8  *
   9  * OpenStranded is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * OpenStranded is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with OpenStranded. If not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23 #ifndef STRANDED_UNIT_HH
  24 #define STRANDED_UNIT_HH
  25
  26 #include "kingdom.hh"
  27 #include "type.hh"
  28 #include "entity.hh"
  29
  30 // Unit Kingdom's Constant ID
  31 #define S2_UNIT 2
  32
  33 /**
  34  * This is the class of all entities which belong to the "unit" kingdom.
  35  * An unit is a mobile and intelligent (or controlled) entity.
  36  */
  37 class UnitEntity: public Entity
  38 {
  39         public:
  40                 /**
  41                  * The constructor.
  42                  * @param type The ID of the new entity's type
  43                  */
  44                 UnitEntity (ID type);
  45 };
  46
  47
  48 /**
  49  * This is the class of the unit type.
  50  */
  51 class UnitType: public Type
  52 {
  53         public:
  54                 /**
  55                  * The constructor.
  56                  * @param name The name of the new type
  57                  */
  58                 UnitType (const char* name);
  59 };
  60
  61
  62 /**
  63  * This is the class of the unit kingdom
  64  */
  65 class UnitKingdom: public Kingdom
  66 {
  67         public:
  68                 /**
  69                  * The constructor.
  70                  */
  71                 UnitKingdom ();
  72
  73
  74
  75                 //
  76                 // Virtual functions
  77                 //
  78
  79                 /**
  80                  * Create a new unit entity.
  81                  * @param The ID of the new entity's type
  82                  * @return A pointer to the created entity
  83                  * @see UnitEntity::UnitEntity()
  84                  */
  85                 Entity*
  86                 createEntity (ID type);
  87
  88                 /**
  89                  * Create a new type.
  90                  * @param The name of the new type
  91                  * @return A pointer to the created type
  92                  * @see UnitType::UnitType()
  93                  */
  94                 Type*
  95                 createType (const char* name);
  96
  97 };
  98
  99 #endif /* STRANDED_UNIT_HH */