ryzom/common/src/game_share/action_target_slot.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 NL_ACTION_TARGET_SLOT_H
  20 #define NL_ACTION_TARGET_SLOT_H
  21
  22 #include "nel/misc/types_nl.h"
  23 #include "action.h"
  24
  25
  26 namespace CLFECOMMON {
  27
  28 /**
  29  * Special action for targetting
  30  * \author Olivier Cado
  31  * \author Nevrax France
  32  * \date 2002
  33  */
  34 class CActionTargetSlot : public CAction
  35 {
  36 public:
  37
  38         /** This function creates initializes its fields using the buffer.
  39          * \param buffer pointer to the buffer where the data are
  40          * \size size of the buffer
  41          */
  42         virtual void unpack (NLMISC::CBitMemStream &message) { message.serial( Slot ); message.serial( TargetOrPickup, 2 ); }
  43
  44         /// This functions is used when you want to transform an action into an IStream.
  45         virtual void serial (NLMISC::IStream &f) { f.serial( Slot ); f.serial( TargetOrPickup ); }
  46
  47         /** Returns the size of this action when it will be send to the UDP connection:
  48          * the size is IN BITS, not in bytes (the actual size is this one plus the header size)
  49          */
  50         virtual uint32 size () { return sizeof(Slot)*8 + 2; }
  51
  52         static CAction *create () { return new CActionTargetSlot(); }
  53
  54         /// The slot value
  55         TCLEntityId                     Slot;
  56
  57         /// Type of targetting ( LHSTATE::TLHState, only 2 bits are transmitted )
  58         uint32                          TargetOrPickup;
  59
  60 protected:
  61
  62         /** This function transform the internal field and transform them into a buffer for the UDP connection.
  63          * \param buffer pointer to the buffer where the data will be written
  64          * \size size of the buffer
  65          */
  66         virtual void pack (NLMISC::CBitMemStream &message) { message.serial( Slot ); message.serial( TargetOrPickup, 2 ); }
  67
  68         friend class CActionFactory;
  69
  70 };
  71
  72 }
  73
  74 #endif // NL_ACTION_TARGET_SLOT_H
  75
  76 /* End of action_target_slot.h */