Included first (incomplete) doxygen documentation
[openstranded.git] / src / unit.hh
blob6b5a259dda043cef85a1d73c2abfc5820c2414d8
1 /*
2 * This file includes the definitions for the unit specific classes
3 * derived from the Kingdom, Type and Entity base classes
5 * This file is part of OpenStranded
7 * Copyright (C) 2008 David Kolossa
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.
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.
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/>.
23 #ifndef STRANDED_UNIT_HH
24 #define STRANDED_UNIT_HH
26 #include "kingdom.hh"
27 #include "type.hh"
28 #include "entity.hh"
30 // Unit Kingdom's Constant ID
31 #define S2_UNIT 2
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.
37 class UnitEntity: public Entity
39 public:
40 UnitEntity (ID type);
45 * This is the class of the unit type derived from the Type base class
47 class UnitType: public Type
49 public:
50 UnitType (const char* name);
54 class UnitKingdom: public Kingdom
56 public:
57 // Constructor
58 UnitKingdom ();
60 // Virtual functions
61 Entity*
62 createEntity (ID type);
64 Type*
65 createType (const char* name);
69 #endif /* STRANDED_UNIT_HH */