ryzom/client/src/client_sheets/sphrase_sheet.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_SPHRASE_SHEET_H
  20 #define RY_SPHRASE_SHEET_H
  21
  22 #include "nel/misc/types_nl.h"
  23 #include "nel/misc/sheet_id.h"
  24 #include "entity_sheet.h"
  25
  26 #define SPHRASE_MAX_BRICK       100
  27
  28 // ***************************************************************************
  29 /**
  30  * New Sabrina Brick Sheet def.
  31  * \author Matthieu Besson
  32  * \author Nevrax France
  33  * \date 2003 September
  34  */
  35 class CSPhraseSheet : public CEntitySheet
  36 {
  37 public:
  38         // All these values are sheet id
  39         std::vector<NLMISC::CSheetId>   Bricks;
  40         // False if it is an upgrade phrase for instance. true means it can be memorized
  41         bool                                                    Castable;
  42         // True if it can be shown in the ActionProgression window
  43         bool                                                    ShowInActionProgression;
  44         // True if it can be shown in the ActionProgression window (only if all bricks learn)
  45         bool                                                    ShowInAPOnlyIfLearnt;
  46
  47 public:
  48
  49         CSPhraseSheet ()
  50         {
  51                 Type = CEntitySheet::SPHRASE;
  52                 Castable= true;
  53                 ShowInActionProgression= true;
  54                 ShowInAPOnlyIfLearnt= false;
  55         }
  56
  57         virtual void build (const NLGEORGES::UFormElm &root);
  58
  59         virtual void serial (NLMISC::IStream &s)
  60         {
  61                 s.serialCont (Bricks);
  62                 s.serial(Castable);
  63                 s.serial(ShowInActionProgression);
  64                 s.serial(ShowInAPOnlyIfLearnt);
  65         }
  66
  67         // Valid if Bricks not empty and all Bricks sheetId != NULL.
  68         bool    isValid() const;
  69 };
  70
  71
  72 #endif // RY_SPHRASE_SHEET_H
  73
  74 /* End of sphrase_sheet.h */