ryzom/server/src/server_share/pet_interface_msg.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2019  Jan BOON (Kaetemi) <jan.boon@kaetemi.be>
   6 //
   7 // This program is free software: you can redistribute it and/or modify
   8 // it under the terms of the GNU Affero General Public License as
   9 // published by the Free Software Foundation, either version 3 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU Affero General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU Affero General Public License
  18 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20
  21
  22 #ifndef RY_PET_INTERFACE_MESSAGES_H
  23 #define RY_PET_INTERFACE_MESSAGES_H
  24
  25 #include "nel/misc/types_nl.h"
  26 #include "nel/misc/sheet_id.h"
  27
  28 #include "game_share/synchronised_message.h"
  29 #include "game_share/mirror.h"
  30
  31 #include <limits>
  32
  33 // Pet interface message class for AIS / EGS communication
  34
  35 //----------------------------------------------------------------
  36 // pet spawn
  37 //----------------------------------------------------------------
  38 class CPetSpawnMsg : public CMirrorTransportClass
  39 {
  40 public:
  41         enum TSpawnMode { NEAR_PLAYER = 0, NEAR_POINT };
  42         uint32                          AIInstanceId;
  43         uint16                          SpawnMode;
  44         TDataSetRow                     CharacterMirrorRow;
  45         NLMISC::CSheetId        PetSheetId;
  46         uint16                          PetIdx; // must be returned to EGS with CPetSpawnConfirmationMsg class
  47         sint32                          Coordinate_X, Coordinate_Y, Coordinate_H; //For NEAR_POINT mode
  48         sint32                          Cell;
  49         float                           Heading; //For NEAR_POINT mode
  50         ucstring                        CustomName;
  51
  52         virtual void description ()
  53         {
  54                 className ("CPetSpawnMsg");
  55                 property ("AIInstanceId", PropUInt32, std::numeric_limits<uint32>::max(), AIInstanceId);
  56                 property ("SpawnMode", PropUInt16, (uint16)NEAR_PLAYER, SpawnMode);
  57                 property ("CharacterMirrorRow", PropDataSetRow, TDataSetRow(), CharacterMirrorRow);
  58                 property ("PetSheetId", PropSheetId, NLMISC::CSheetId::Unknown, PetSheetId);
  59                 property ("PetIndex", PropUInt16, (uint16)0, PetIdx);
  60                 property ("Coordinate_X", PropSInt32, (sint32)0, Coordinate_X);
  61                 property ("Coordinate_Y", PropSInt32, (sint32)0, Coordinate_Y);
  62                 property ("Coordinate_H", PropSInt32, (sint32)0, Coordinate_H);
  63                 property ("Cell", PropSInt32, (sint32)0, Cell);
  64                 property ("Heading", PropFloat, 0.0f, Heading);
  65                 property ("CustomName", PropUCString, ucstring(""), CustomName);
  66         }
  67
  68         virtual void callback (const std::string &/* name */, NLNET::TServiceId /* id */) {}
  69 };
  70
  71
  72 //----------------------------------------------------------------
  73 // spawn confirmation
  74 //----------------------------------------------------------------
  75 class CPetSpawnConfirmationMsg : public CMirrorTransportClass
  76 {
  77 public:
  78         enum TSpawnError
  79         {
  80                 NO_ERROR_SPAWN = 0,
  81                 CHARATER_UNKNOWN,
  82                 PET_SHEETID_UNKNOWN,
  83                 CHARACTER_LAND_MAP_UNKNOWN,
  84                 COORDINATE_NOT_IN_WORLD,
  85                 NOT_IMPLEMENTED,
  86                 INTERNAL_ERROR,
  87                 PET_ALREADY_SPAWNED
  88         };
  89         uint16 SpawnError;
  90         TDataSetRow     CharacterMirrorRow;
  91         TDataSetRow     PetMirrorRow; //If spawned
  92         uint16 PetIdx;
  93
  94         virtual void description ()
  95         {
  96                 className ("CPetSpawnConfirmationMsg");
  97                 property ("SpawnError", PropUInt16, (uint16)NO_ERROR_SPAWN, SpawnError);
  98                 property ("CharacterMirrorRow", PropDataSetRow, TDataSetRow(), CharacterMirrorRow);
  99                 property ("PetMirrorRow",               PropDataSetRow, TDataSetRow(), PetMirrorRow);
 100                 property ("PetIndex", PropUInt16, (uint16)0, PetIdx);
 101         }
 102         virtual void callback (const std::string &/* name */, NLNET::TServiceId /* id */) {}
 103 };
 104
 105
 106 //----------------------------------------------------------------
 107 // pet command
 108 //----------------------------------------------------------------
 109 class CPetCommandMsg : public CMirrorTransportClass
 110 {
 111 public:
 112         enum TCommand { STAND = 0, FOLLOW, GOTO_POINT, GOTO_POINT_DESPAWN, LIBERATE, DESPAWN };
 113         enum TCommandError { COLLISION_NOT_VALIDNO_ERROR_SPAWN = 0, CHARATER_UNKNOWN, PET_SHEETID_UNKNOWN, CHARACTER_LAND_MAP_UNKNOWN, COORDINATE_NOT_IN_WORLD, NOT_IMPLEMENTED, INTERNAL_ERROR };
 114         uint16 Command;
 115         TDataSetRow     CharacterMirrorRow;
 116         TDataSetRow PetMirrorRow;
 117         sint32  Coordinate_X, Coordinate_Y, Coordinate_H; //For GOTO_POINT, GOTO_POINT_DESPAWN and SPAWN_POINT commands
 118         float Heading; // For GOTO_POINT_DESPAWN commands (via stable)
 119
 120         virtual void description ()
 121         {
 122                 className ("CPetCommandMsg");
 123                 property ("Command", PropUInt16, (uint16)STAND, Command);
 124                 property ("CharacterMirrorRow", PropDataSetRow, TDataSetRow(), CharacterMirrorRow);
 125                 property ("PetMirrorRow", PropDataSetRow, TDataSetRow(), PetMirrorRow);
 126                 property ("Coordinate_X", PropSInt32, (sint32)0, Coordinate_X);
 127                 property ("Coordinate_Y", PropSInt32, (sint32)0, Coordinate_Y);
 128                 property ("Coordinate_H", PropSInt32, (sint32)0, Coordinate_H);
 129                 property ("Heading", PropFloat, 0.0f, Heading);
 130         }
 131
 132         virtual void callback (const std::string &/* name */, NLNET::TServiceId /* id */) {}
 133 };
 134
 135 //----------------------------------------------------------------
 136 // command confirmation
 137 //----------------------------------------------------------------
 138 class CPetCommandConfirmationMsg : public CMirrorTransportClass
 139 {
 140 public:
 141         enum TCommandError { NO_ERROR_COMMAND = 0, POSITION_COLLISION_NOT_VALID };
 142         uint16 CommandError;
 143         TDataSetRow     CharacterMirrorRow;
 144         TDataSetRow PetMirrorRow;
 145
 146         CPetCommandConfirmationMsg()
 147         {}
 148
 149         CPetCommandConfirmationMsg(uint16 commandError, const   CPetCommandMsg  &msg)
 150         :CommandError(commandError)
 151         ,CharacterMirrorRow(msg.CharacterMirrorRow)
 152         ,PetMirrorRow(msg.PetMirrorRow)
 153         {}
 154
 155         virtual void description ()
 156         {
 157                 className ("CPetCommandConfirmationMsg");
 158                 property ("CommandError", PropUInt16, (uint16)NO_ERROR_COMMAND, CommandError);
 159         }
 160         virtual void callback (const std::string &/* name */, NLNET::TServiceId /* id */) {}
 161 };
 162
 163 //----------------------------------------------------------------
 164 // pet owner
 165 //----------------------------------------------------------------
 166 class CPetSetOwner : public CMirrorTransportClass
 167 {
 168 public:
 169
 170         TDataSetRow     OwnerMirrorRow;
 171         TDataSetRow PetMirrorRow;
 172
 173         virtual void description ()
 174         {
 175                 className ("CPetSetOwner");
 176                 property ("OwnerMirrorRow", PropDataSetRow, TDataSetRow(), OwnerMirrorRow);
 177                 property ("PetMirrorRow", PropDataSetRow, TDataSetRow(), PetMirrorRow);
 178         }
 179
 180         virtual void callback (const std::string &/* name */, NLNET::TServiceId /* id */) {}
 181 };
 182
 183 #endif //RY_PET_INTERFACE_MESSAGES_H