ryzom/common/src/game_share/action_association.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 #ifndef NL_ACTION_ASSOCIATION_H
  19 #define NL_ACTION_ASSOCIATION_H
  20
  21 #include "nel/misc/types_nl.h"
  22
  23 #include "ryzom_entity_id.h"
  24 #include "entity_types.h"
  25 #include "action.h"
  26
  27
  28 namespace CLFECOMMON {
  29
  30 /**
  31  * <Class description>
  32  * \author Benjamin Legros
  33  * \author Nevrax France
  34  * \date 2001
  35  */
  36 class CActionAssociation : public CAction
  37 {
  38 public:
  39
  40         /** This function creates initializes its fields using the buffer.
  41          * \param buffer pointer to the buffer where the data are
  42          * \size size of the buffer
  43          */
  44         virtual void    unpack (NLMISC::CBitMemStream &message)
  45         {
  46                 message.serial(IsNewAssociation);
  47                 if (IsNewAssociation)
  48                 {
  49                         message.serial(SheetId);
  50                         message.serial(Replace);
  51                 }
  52         }
  53
  54         /// This functions is used when you want to transform an action into an IStream.
  55         virtual void    serial (NLMISC::IStream &f) { f.serial(IsNewAssociation, SheetId, Replace); }
  56
  57         /** Returns the size of this action when it will be send to the UDP connection:
  58          * the size is IN BITS, not in bytes (the actual size is this one plus the header size)
  59          */
  60         virtual uint32  size () { return IsNewAssociation ? 8*sizeof(CLFECOMMON::TSheetId)+2 : 1; }
  61
  62         /// Sets the value of the action
  63         virtual TValue  getValue() const { return (CAction::TValue)SheetId; }
  64
  65         static CAction  *create () { return new CActionAssociation(); }
  66
  67 protected:
  68
  69         /// Constructor
  70         CActionAssociation() {}
  71
  72         /** This function transform the internal field and transform them into a buffer for the UDP connection.
  73          * \param buffer pointer to the buffer where the data will be written
  74          * \size size of the buffer
  75          */
  76         virtual void    pack (NLMISC::CBitMemStream &message)
  77         {
  78                 message.serial(IsNewAssociation);
  79                 if (IsNewAssociation)
  80                 {
  81                         message.serial(SheetId);
  82                         message.serial(Replace);
  83                 }
  84         }
  85
  86         friend class CActionFactory;
  87
  88
  89 public:
  90         /// The sheet id of the associated entity
  91         bool                                    IsNewAssociation;
  92         bool                                    Replace;
  93         CLFECOMMON::TSheetId    SheetId;
  94 };
  95
  96 }
  97
  98 #endif // NL_ACTION_ASSOCIATION_H
  99
 100 /* End of action_association.h */