ryzom/common/src/game_share/action_nature.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_ACTION_NATURE_H
  20 #define RY_ACTION_NATURE_H
  21
  22 #include "nel/misc/types_nl.h"
  23
  24 namespace ACTNATURE
  25 {
  26         // action nature
  27         enum TActionNature
  28         {
  29                 FIGHT = 0,
  30                 OFFENSIVE_MAGIC,
  31                 CURATIVE_MAGIC,
  32                 CRAFT,
  33                 HARVEST,
  34                 SEARCH_MP,
  35                 DODGE,
  36                 PARRY,
  37                 SHIELD_USE,
  38                 RECHARGE,
  39
  40                 NEUTRAL,        //only for multi effect on spell,progression consider it as OFFENSIVE_MAGIC
  41
  42                 UNKNOWN,
  43                 NB_ACTION_NATURE = UNKNOWN
  44         };
  45
  46
  47         /**
  48          * get action nature corresponding to input string
  49          * \param str the input string
  50          * \return the TActionNature associated to this string (UNKNOWN if the string cannot be interpreted)
  51          */
  52         TActionNature toActionNature(const std::string &str);
  53
  54         /**
  55          * get the action nature string corresponding to enum
  56          * \param nature the TActionNature value
  57          * \return nature as a string (or UNKNOWN)
  58          */
  59         const std::string& toString(TActionNature nature);
  60 }; // ACTNATURE
  61
  62 #endif // RY_ACTION_NATURE_H
  63 /* End of action_nature.h */