src/clientserver.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation; either version 2 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef CLIENTSERVER_HEADER
  21 #define CLIENTSERVER_HEADER
  22
  23 #include "utility.h"
  24
  25 #define PROTOCOL_ID 0x4f457403
  26
  27 enum ToClientCommand
  28 {
  29         TOCLIENT_INIT = 0x10,
  30         /*
  31                 Server's reply to TOSERVER_INIT.
  32                 Sent second after connected.
  33
  34                 [0] u16 TOSERVER_INIT
  35                 [2] u8 deployed version
  36                 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
  37                 ([4] u64 map seed (new as of 2011-02-27))
  38
  39                 NOTE: The position in here is deprecated; position is
  40                       explicitly sent afterwards
  41         */
  42
  43         TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
  44         TOCLIENT_ADDNODE = 0x21,
  45         TOCLIENT_REMOVENODE = 0x22,
  46
  47         TOCLIENT_PLAYERPOS = 0x23, // Obsolete
  48         /*
  49                 [0] u16 command
  50                 // Followed by an arbitary number of these:
  51                 // Number is determined from packet length.
  52                 [N] u16 peer_id
  53                 [N+2] v3s32 position*100
  54                 [N+2+12] v3s32 speed*100
  55                 [N+2+12+12] s32 pitch*100
  56                 [N+2+12+12+4] s32 yaw*100
  57         */
  58
  59         TOCLIENT_PLAYERINFO = 0x24,
  60         /*
  61                 [0] u16 command
  62                 // Followed by an arbitary number of these:
  63                 // Number is determined from packet length.
  64                 [N] u16 peer_id
  65                 [N] char[20] name
  66         */
  67
  68         TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
  69
  70         TOCLIENT_SECTORMETA = 0x26, // Obsolete
  71         /*
  72                 [0] u16 command
  73                 [2] u8 sector count
  74                 [3...] v2s16 pos + sector metadata
  75         */
  76
  77         TOCLIENT_INVENTORY = 0x27,
  78         /*
  79                 [0] u16 command
  80                 [2] serialized inventory
  81         */
  82
  83         TOCLIENT_OBJECTDATA = 0x28,
  84         /*
  85                 Sent as unreliable.
  86
  87                 u16 command
  88                 u16 number of player positions
  89                 for each player:
  90                         v3s32 position*100
  91                         v3s32 speed*100
  92                         s32 pitch*100
  93                         s32 yaw*100
  94                 u16 count of blocks
  95                 for each block:
  96                         v3s16 blockpos
  97                         block objects
  98         */
  99
 100         TOCLIENT_TIME_OF_DAY = 0x29,
 101         /*
 102                 u16 command
 103                 u16 time (0-23999)
 104         */
 105
 106         TOCLIENT_CHAT_MESSAGE = 0x30,
 107         /*
 108                 u16 command
 109                 u16 length
 110                 wstring message
 111         */
 112
 113         TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
 114         /*
 115                 u16 command
 116                 u16 count of removed objects
 117                 for all removed objects {
 118                         u16 id
 119                 }
 120                 u16 count of added objects
 121                 for all added objects {
 122                         u16 id
 123                         u8 type
 124                         u16 initialization data length
 125                         string initialization data
 126                 }
 127         */
 128
 129         TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
 130         /*
 131                 u16 command
 132                 for all objects
 133                 {
 134                         u16 id
 135                         u16 message length
 136                         string message
 137                 }
 138         */
 139
 140         TOCLIENT_HP = 0x33,
 141         /*
 142                 u16 command
 143                 u8 hp
 144         */
 145
 146         TOCLIENT_MOVE_PLAYER = 0x34,
 147         /*
 148                 u16 command
 149                 v3f1000 player position
 150                 f1000 player pitch
 151                 f1000 player yaw
 152         */
 153 };
 154
 155 enum ToServerCommand
 156 {
 157         TOSERVER_INIT=0x10,
 158         /*
 159                 Sent first after connected.
 160
 161                 [0] u16 TOSERVER_INIT
 162                 [2] u8 SER_FMT_VER_HIGHEST
 163                 [3] u8[20] player_name
 164         */
 165
 166         TOSERVER_INIT2 = 0x11,
 167         /*
 168                 Sent as an ACK for TOCLIENT_INIT.
 169                 After this, the server can send data.
 170
 171                 [0] u16 TOSERVER_INIT2
 172         */
 173
 174         TOSERVER_GETBLOCK=0x20, // Obsolete
 175         TOSERVER_ADDNODE = 0x21, // Obsolete
 176         TOSERVER_REMOVENODE = 0x22, // Obsolete
 177
 178         TOSERVER_PLAYERPOS = 0x23,
 179         /*
 180                 [0] u16 command
 181                 [2] v3s32 position*100
 182                 [2+12] v3s32 speed*100
 183                 [2+12+12] s32 pitch*100
 184                 [2+12+12+4] s32 yaw*100
 185         */
 186
 187         TOSERVER_GOTBLOCKS = 0x24,
 188         /*
 189                 [0] u16 command
 190                 [2] u8 count
 191                 [3] v3s16 pos_0
 192                 [3+6] v3s16 pos_1
 193                 ...
 194         */
 195
 196         TOSERVER_DELETEDBLOCKS = 0x25,
 197         /*
 198                 [0] u16 command
 199                 [2] u8 count
 200                 [3] v3s16 pos_0
 201                 [3+6] v3s16 pos_1
 202                 ...
 203         */
 204
 205         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
 206         /*
 207                 [0] u16 command
 208                 [2] v3s16 pos
 209                 [8] u16 i
 210         */
 211
 212         TOSERVER_CLICK_OBJECT = 0x27,
 213         /*
 214                 length: 13
 215                 [0] u16 command
 216                 [2] u8 button (0=left, 1=right)
 217                 [3] v3s16 blockpos
 218                 [9] s16 id
 219                 [11] u16 item
 220         */
 221
 222         TOSERVER_GROUND_ACTION = 0x28,
 223         /*
 224                 length: 17
 225                 [0] u16 command
 226                 [2] u8 action
 227                 [3] v3s16 nodepos_undersurface
 228                 [9] v3s16 nodepos_abovesurface
 229                 [15] u16 item
 230                 actions:
 231                 0: start digging (from undersurface)
 232                 1: place block (to abovesurface)
 233                 2: stop digging (all parameters ignored)
 234                 3: digging completed
 235         */
 236
 237         TOSERVER_RELEASE = 0x29, // Obsolete
 238
 239         TOSERVER_SIGNTEXT = 0x30, // Old signs
 240         /*
 241                 u16 command
 242                 v3s16 blockpos
 243                 s16 id
 244                 u16 textlen
 245                 textdata
 246         */
 247
 248         TOSERVER_INVENTORY_ACTION = 0x31,
 249         /*
 250                 See InventoryAction in inventory.h
 251         */
 252
 253         TOSERVER_CHAT_MESSAGE = 0x32,
 254         /*
 255                 u16 command
 256                 u16 length
 257                 wstring message
 258         */
 259
 260         TOSERVER_SIGNNODETEXT = 0x33,
 261         /*
 262                 u16 command
 263                 v3s16 p
 264                 u16 textlen
 265                 textdata
 266         */
 267
 268         TOSERVER_CLICK_ACTIVEOBJECT = 0x34,
 269         /*
 270                 length: 7
 271                 [0] u16 command
 272                 [2] u8 button (0=left, 1=right)
 273                 [3] u16 id
 274                 [5] u16 item
 275         */
 276
 277         TOSERVER_DAMAGE = 0x35,
 278         /*
 279                 u16 command
 280                 u8 amount
 281         */
 282 };
 283
 284 inline SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time)
 285 {
 286         SharedBuffer<u8> data(2+2);
 287         writeU16(&data[0], TOCLIENT_TIME_OF_DAY);
 288         writeU16(&data[2], time);
 289         return data;
 290 }
 291
 292 #endif
 293