src/item.hh

   1 /*
   2  * This file includes the definitions for the item specific classes
   3  * derived from the Kingdom, Type and Entity base classes.
   4  *
   5  * Copyright (C) 2008 David Kolossa
   6  *
   7  * This file is part of OpenStranded
   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_ITEM_HH
  24 #define STRANDED_ITEM_HH
  25
  26 #include "kingdom.hh"
  27 #include "type.hh"
  28 #include "entity.hh"
  29
  30 #define S2_ITEM 3
  31
  32 /**
  33  * This is the class of all entities which belong to the kingdom
  34  * "item".
  35  * An item is the only entity which can be collected by the player
  36  * (without scripts) and which is stored in the inventory afterwards.
  37  * An item can't move without the help of scripts.
  38  */
  39 class ItemEntity: public Entity
  40 {
  41         public:
  42                 /**
  43                  * The constructor.
  44                  * @param type The ID of the Type the item should belong to
  45                  */
  46                 ItemEntity (ID type);
  47 };
  48
  49
  50 /**
  51  * This is the class of all item types derived from the Item base class.
  52  */
  53 class ItemType: public Type
  54 {
  55         public:
  56                 /**
  57                  * The constructor.
  58                  * @param name The name of the new item type
  59                  */
  60                 ItemType (const char* name);
  61 };
  62
  63
  64 /**
  65  * The Item Kingdom class
  66  */
  67 class ItemKingdom: public Kingdom
  68 {
  69         public:
  70                 /**
  71                  * The constructor.
  72                  */
  73                 ItemKingdom ();
  74
  75
  76
  77                 //
  78                 // Virtual methods
  79                 //
  80
  81                 /**
  82                  * Create a new item entity
  83                  * @param type The ID of the type the new item should belong to
  84                  * @return A pointer to the new Entity
  85                  * @see ItemEntity::ItemEntity()
  86                  */
  87                 Entity*
  88                 createEntity (ID type);
  89
  90                 /**
  91                  * Create a new item type
  92                  * @param name The name of the new type (visible in editor)
  93                  * @return A pointer to the new Type
  94                  * @see ItemType::ItemType()
  95                  */
  96                 Type*
  97                 createType (const char* name);
  98 };
  99
 100 #endif /* STRANDED_ITEM_HH */