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         */
  38
  39         TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
  40         TOCLIENT_ADDNODE = 0x21,
  41         TOCLIENT_REMOVENODE = 0x22,
  42
  43         TOCLIENT_PLAYERPOS = 0x23,
  44         /*
  45                 [0] u16 command
  46                 // Followed by an arbitary number of these:
  47                 // Number is determined from packet length.
  48                 [N] u16 peer_id
  49                 [N+2] v3s32 position*100
  50                 [N+2+12] v3s32 speed*100
  51                 [N+2+12+12] s32 pitch*100
  52                 [N+2+12+12+4] s32 yaw*100
  53         */
  54
  55         TOCLIENT_PLAYERINFO = 0x24,
  56         /*
  57                 [0] u16 command
  58                 // Followed by an arbitary number of these:
  59                 // Number is determined from packet length.
  60                 [N] u16 peer_id
  61                 [N] char[20] name
  62         */
  63
  64         TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Not used
  65
  66         TOCLIENT_SECTORMETA = 0x26, // Not used
  67         /*
  68                 [0] u16 command
  69                 [2] u8 sector count
  70                 [3...] v2s16 pos + sector metadata
  71         */
  72
  73         TOCLIENT_INVENTORY = 0x27,
  74         /*
  75                 [0] u16 command
  76                 [2] serialized inventory
  77         */
  78
  79         TOCLIENT_OBJECTDATA = 0x28,
  80         /*
  81                 Sent as unreliable.
  82
  83                 u16 command
  84                 u16 number of player positions
  85                 for each player:
  86                         v3s32 position*100
  87                         v3s32 speed*100
  88                         s32 pitch*100
  89                         s32 yaw*100
  90                 u16 count of blocks
  91                 for each block:
  92                         v3s16 blockpos
  93                         block objects
  94         */
  95
  96         TOCLIENT_TIME_OF_DAY = 0x29,
  97         /*
  98                 u16 command
  99                 u16 time (0-23999)
 100         */
 101
 102         TOCLIENT_CHAT_MESSAGE = 0x30,
 103         /*
 104                 u16 command
 105                 u16 length
 106                 wstring message
 107         */
 108
 109         TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
 110         /*
 111                 u16 command
 112                 u16 count of removed objects
 113                 for all removed objects {
 114                         u16 id
 115                 }
 116                 u16 count of added objects
 117                 for all added objects {
 118                         u16 id
 119                         u8 type
 120                         u16 initialization data length
 121                         string initialization data
 122                 }
 123         */
 124
 125         TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
 126         /*
 127                 u16 command
 128                 for all objects
 129                 {
 130                         u16 id
 131                         u16 message length
 132                         string message
 133                 }
 134         */
 135
 136 };
 137
 138 enum ToServerCommand
 139 {
 140         TOSERVER_INIT=0x10,
 141         /*
 142                 Sent first after connected.
 143
 144                 [0] u16 TOSERVER_INIT
 145                 [2] u8 SER_FMT_VER_HIGHEST
 146                 [3] u8[20] player_name
 147         */
 148
 149         TOSERVER_INIT2 = 0x11,
 150         /*
 151                 Sent as an ACK for TOCLIENT_INIT.
 152                 After this, the server can send data.
 153
 154                 [0] u16 TOSERVER_INIT2
 155         */
 156
 157         TOSERVER_GETBLOCK=0x20, // Not used
 158         TOSERVER_ADDNODE = 0x21, // Not used
 159         TOSERVER_REMOVENODE = 0x22, // deprecated
 160
 161         TOSERVER_PLAYERPOS = 0x23,
 162         /*
 163                 [0] u16 command
 164                 [2] v3s32 position*100
 165                 [2+12] v3s32 speed*100
 166                 [2+12+12] s32 pitch*100
 167                 [2+12+12+4] s32 yaw*100
 168         */
 169
 170         TOSERVER_GOTBLOCKS = 0x24,
 171         /*
 172                 [0] u16 command
 173                 [2] u8 count
 174                 [3] v3s16 pos_0
 175                 [3+6] v3s16 pos_1
 176                 ...
 177         */
 178
 179         TOSERVER_DELETEDBLOCKS = 0x25,
 180         /*
 181                 [0] u16 command
 182                 [2] u8 count
 183                 [3] v3s16 pos_0
 184                 [3+6] v3s16 pos_1
 185                 ...
 186         */
 187
 188         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // deprecated
 189         /*
 190                 [0] u16 command
 191                 [2] v3s16 pos
 192                 [8] u16 i
 193         */
 194
 195         TOSERVER_CLICK_OBJECT = 0x27,
 196         /*
 197                 length: 13
 198                 [0] u16 command
 199                 [2] u8 button (0=left, 1=right)
 200                 [3] v3s16 blockpos
 201                 [9] s16 id
 202                 [11] u16 item
 203         */
 204
 205         TOSERVER_GROUND_ACTION = 0x28,
 206         /*
 207                 length: 17
 208                 [0] u16 command
 209                 [2] u8 action
 210                 [3] v3s16 nodepos_undersurface
 211                 [9] v3s16 nodepos_abovesurface
 212                 [15] u16 item
 213                 actions:
 214                 0: start digging (from undersurface)
 215                 1: place block (to abovesurface)
 216                 2: stop digging (all parameters ignored)
 217                 3: digging completed
 218         */
 219
 220         TOSERVER_RELEASE = 0x29, // Not used
 221
 222         TOSERVER_SIGNTEXT = 0x30,
 223         /*
 224                 u16 command
 225                 v3s16 blockpos
 226                 s16 id
 227                 u16 textlen
 228                 textdata
 229         */
 230
 231         TOSERVER_INVENTORY_ACTION = 0x31,
 232         /*
 233                 See InventoryAction in inventory.h
 234         */
 235
 236         TOSERVER_CHAT_MESSAGE = 0x32,
 237         /*
 238                 u16 command
 239                 u16 length
 240                 wstring message
 241         */
 242
 243 };
 244
 245 inline SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time)
 246 {
 247         SharedBuffer<u8> data(2+2);
 248         writeU16(&data[0], TOCLIENT_TIME_OF_DAY);
 249         writeU16(&data[2], time);
 250         return data;
 251 }
 252
 253 #endif
 254