ryzom/common/src/game_share/item_origin.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_ITEM_ORIGIN_H
  20 #define RY_ITEM_ORIGIN_H
  21
  22 #include "nel/misc/types_nl.h"
  23
  24 #include "people.h"
  25
  26 namespace ITEM_ORIGIN
  27 {
  28         enum EItemOrigin
  29         {
  30                 COMMON = 0,
  31                 FYROS,
  32                 MATIS,
  33                 TRYKER,
  34                 ZORAI,
  35                 REFUGEE,
  36                 TRIBE,
  37                 KAMI,
  38                 KARAVAN,
  39
  40                 UNKNOWN,
  41                 NUM_ITEM_ORIGIN = UNKNOWN
  42         };
  43
  44
  45         /**
  46          * get the right EItemOrigin enum from the input string
  47          * \param str the input string
  48          * \return the EItemOrigin associated to this string (UNKNOWN if the string cannot be interpreted)
  49          */
  50         EItemOrigin stringToEnum(const std::string &str);
  51
  52         /**
  53          * get the EItemOrigin type as a string
  54          * \param e the EItemOrigin enum
  55          * \return the string associated to this EItemOrigin
  56          */
  57         const std::string & enumToString (EItemOrigin e);
  58
  59         /**
  60          * return people enum corresponding to item origin string
  61          * \param e the EItemOrigin enum
  62          * \return the string associated to this EItemOrigin
  63          */
  64         EGSPD::CPeople::TPeople itemOriginStringToPeopleEnum( const std::string &str );
  65 }; // namespace ITEM_ORIGIN
  66
  67 #endif // RY_ITEM_ORIGIN_H
  68