ryzom/client/src/client_sheets/ground_fx_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_GROUND_FX_SHEET_H
  20 #define RY_GROUND_FX_SHEET_H
  21
  22 #include "client_sheets.h"
  23
  24 namespace NLGEORGES
  25 {
  26         class UFormElm;
  27 }
  28
  29 /** A ground fx and its associated ground material
  30   * \author Nicolas Vizerie
  31   * \author Nevrax France
  32   * \date 2003
  33   */
  34 class CGroundFXSheet
  35 {
  36 public:
  37         uint32                                  GroundID;
  38         NLMISC::TSStringId              IdFXName;
  39
  40         std::string     getFXName() const {return ClientSheetsStrings.get(IdFXName);}
  41 public:
  42         // build that sheet from a form
  43         bool build(const NLGEORGES::UFormElm &item);
  44         // serial this sheet
  45         void serial(NLMISC::IStream &f);
  46 };
  47
  48 // operator < sort ground fx by ground type
  49 inline bool operator  < (const CGroundFXSheet &lhs, const CGroundFXSheet &rhs)
  50 {
  51         return lhs.GroundID < rhs.GroundID;
  52 }
  53 //
  54 inline bool operator == (const CGroundFXSheet &lhs, const CGroundFXSheet &rhs)
  55 {
  56         return lhs.GroundID == rhs.GroundID;
  57 }
  58
  59 #endif
  60