ryzom/client/src/interface_v3/item_special_effect.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 #ifndef NL_ITEM_SPECIAL_EFFECT_H
  18 #define NL_ITEM_SPECIAL_EFFECT_H
  19
  20 #include "inventory_manager.h"
  21
  22 /**
  23  * Helper class to manage special effects on items
  24  * \author Fabien Houlmann
  25  * \author Nevrax France
  26  * \date 2005
  27  */
  28 class CItemSpecialEffectHelper
  29 {
  30 public:
  31         // Singleton access
  32         static CItemSpecialEffectHelper* getInstance();
  33
  34         // Fill itemText with special effects from item sheet
  35         void getItemSpecialEffectText(const CItemSheet *pIS, std::string &itemText);
  36
  37         // Register a new item special effect
  38         void registerItemSpecialEffect(const std::string &name);
  39
  40 private:
  41         CItemSpecialEffectHelper();
  42         CItemSpecialEffectHelper(const CItemSpecialEffectHelper&);
  43
  44         // Get UI text with values filled from 'effect' string
  45         std::string getEffect(const std::string &effect, bool &first);
  46
  47         // Map effects name with parameters
  48         typedef std::vector<std::string> stringVector;
  49         std::map<NLMISC::CSString, stringVector> effectMap;
  50 };
  51
  52 #endif // NL_ITEM_SPECIAL_EFFECT_H