ryzom/common/src/game_share/ecosystem.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18
  19 #ifndef RY_ECOSYSTEM_H
  20 #define RY_ECOSYSTEM_H
  21
  22 #include "nel/misc/types_nl.h"
  23
  24 namespace ECOSYSTEM
  25 {
  26         // Please do not change the ordering of these (otherwise change arrays [ECOSYSTEM::NUM_ECOSYSTEM])
  27         enum EECosystem
  28         {
  29                 common_ecosystem = 0,
  30                 desert,
  31                 forest,
  32                 lacustre,
  33                 jungle,
  34                 goo,
  35                 primary_root,
  36
  37                 unknown,
  38                 NUM_ECOSYSTEM = unknown
  39         };
  40
  41
  42         /**
  43          * get the right ecosystem enum from the input string (case-unsensitive comparison)
  44          * \param str the input string
  45          * \return the EECosystem associated to this string (UNDEFINED if the string cannot be interpreted)
  46          */
  47         EECosystem stringToEcosystem(const std::string &str);
  48
  49         /**
  50          * get the ecosystem type as a string
  51          * \param cat the EECosystem cat
  52          * \return the string associated to this EECosystem
  53          */
  54         const std::string & toString (EECosystem e);
  55
  56 }; // namespace ECOSYSTEM
  57
  58
  59 // Currently, ecotypes are mapped to ecosystems
  60 typedef ECOSYSTEM::EECosystem TEcotype;
  61
  62
  63 #endif // RY_ECOSYSTEM_H
  64 /* End of ecosystem.h */