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