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 #define PASSWORD_SIZE 28       // Maximum password length. Allows for
  28                                // base64-encoded SHA-1 (27+\0).
  29
  30 enum ToClientCommand
  31 {
  32         TOCLIENT_INIT = 0x10,
  33         /*
  34                 Server's reply to TOSERVER_INIT.
  35                 Sent second after connected.
  36
  37                 [0] u16 TOSERVER_INIT
  38                 [2] u8 deployed version
  39                 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
  40                 [12] u64 map seed (new as of 2011-02-27)
  41
  42                 NOTE: The position in here is deprecated; position is
  43                       explicitly sent afterwards
  44         */
  45
  46         TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
  47         TOCLIENT_ADDNODE = 0x21,
  48         TOCLIENT_REMOVENODE = 0x22,
  49
  50         TOCLIENT_PLAYERPOS = 0x23, // Obsolete
  51         /*
  52                 [0] u16 command
  53                 // Followed by an arbitary number of these:
  54                 // Number is determined from packet length.
  55                 [N] u16 peer_id
  56                 [N+2] v3s32 position*100
  57                 [N+2+12] v3s32 speed*100
  58                 [N+2+12+12] s32 pitch*100
  59                 [N+2+12+12+4] s32 yaw*100
  60         */
  61
  62         TOCLIENT_PLAYERINFO = 0x24,
  63         /*
  64                 [0] u16 command
  65                 // Followed by an arbitary number of these:
  66                 // Number is determined from packet length.
  67                 [N] u16 peer_id
  68                 [N] char[20] name
  69         */
  70
  71         TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
  72
  73         TOCLIENT_SECTORMETA = 0x26, // Obsolete
  74         /*
  75                 [0] u16 command
  76                 [2] u8 sector count
  77                 [3...] v2s16 pos + sector metadata
  78         */
  79
  80         TOCLIENT_INVENTORY = 0x27,
  81         /*
  82                 [0] u16 command
  83                 [2] serialized inventory
  84         */
  85
  86         TOCLIENT_OBJECTDATA = 0x28,
  87         /*
  88                 Sent as unreliable.
  89
  90                 u16 command
  91                 u16 number of player positions
  92                 for each player:
  93                         u16 peer_id
  94                         v3s32 position*100
  95                         v3s32 speed*100
  96                         s32 pitch*100
  97                         s32 yaw*100
  98                 u16 count of blocks
  99                 for each block:
 100                         v3s16 blockpos
 101                         block objects
 102         */
 103
 104         TOCLIENT_TIME_OF_DAY = 0x29,
 105         /*
 106                 u16 command
 107                 u16 time (0-23999)
 108         */
 109
 110         TOCLIENT_CHAT_MESSAGE = 0x30,
 111         /*
 112                 u16 command
 113                 u16 length
 114                 wstring message
 115         */
 116
 117         TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
 118         /*
 119                 u16 command
 120                 u16 count of removed objects
 121                 for all removed objects {
 122                         u16 id
 123                 }
 124                 u16 count of added objects
 125                 for all added objects {
 126                         u16 id
 127                         u8 type
 128                         u32 initialization data length
 129                         string initialization data
 130                 }
 131         */
 132
 133         TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
 134         /*
 135                 u16 command
 136                 for all objects
 137                 {
 138                         u16 id
 139                         u16 message length
 140                         string message
 141                 }
 142         */
 143
 144         TOCLIENT_HP = 0x33,
 145         /*
 146                 u16 command
 147                 u8 hp
 148         */
 149
 150         TOCLIENT_MOVE_PLAYER = 0x34,
 151         /*
 152                 u16 command
 153                 v3f1000 player position
 154                 f1000 player pitch
 155                 f1000 player yaw
 156         */
 157
 158         TOCLIENT_ACCESS_DENIED = 0x35,
 159         /*
 160                 u16 command
 161                 u16 reason_length
 162                 wstring reason
 163         */
 164
 165         TOCLIENT_PLAYERITEM = 0x36,
 166         /*
 167                 u16 command
 168                 u16 count of player items
 169                 for all player items {
 170                         u16 peer id
 171                         u16 length of serialized item
 172                         string serialized item
 173                 }
 174         */
 175 };
 176
 177 enum ToServerCommand
 178 {
 179         TOSERVER_INIT=0x10,
 180         /*
 181                 Sent first after connected.
 182
 183                 [0] u16 TOSERVER_INIT
 184                 [2] u8 SER_FMT_VER_HIGHEST
 185                 [3] u8[20] player_name
 186                 [23] u8[28] password (new in some version)
 187                 [51] u16 client network protocol version (new in some version)
 188         */
 189
 190         TOSERVER_INIT2 = 0x11,
 191         /*
 192                 Sent as an ACK for TOCLIENT_INIT.
 193                 After this, the server can send data.
 194
 195                 [0] u16 TOSERVER_INIT2
 196         */
 197
 198         TOSERVER_GETBLOCK=0x20, // Obsolete
 199         TOSERVER_ADDNODE = 0x21, // Obsolete
 200         TOSERVER_REMOVENODE = 0x22, // Obsolete
 201
 202         TOSERVER_PLAYERPOS = 0x23,
 203         /*
 204                 [0] u16 command
 205                 [2] v3s32 position*100
 206                 [2+12] v3s32 speed*100
 207                 [2+12+12] s32 pitch*100
 208                 [2+12+12+4] s32 yaw*100
 209         */
 210
 211         TOSERVER_GOTBLOCKS = 0x24,
 212         /*
 213                 [0] u16 command
 214                 [2] u8 count
 215                 [3] v3s16 pos_0
 216                 [3+6] v3s16 pos_1
 217                 ...
 218         */
 219
 220         TOSERVER_DELETEDBLOCKS = 0x25,
 221         /*
 222                 [0] u16 command
 223                 [2] u8 count
 224                 [3] v3s16 pos_0
 225                 [3+6] v3s16 pos_1
 226                 ...
 227         */
 228
 229         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
 230         /*
 231                 [0] u16 command
 232                 [2] v3s16 pos
 233                 [8] u16 i
 234         */
 235
 236         TOSERVER_CLICK_OBJECT = 0x27,
 237         /*
 238                 length: 13
 239                 [0] u16 command
 240                 [2] u8 button (0=left, 1=right)
 241                 [3] v3s16 blockpos
 242                 [9] s16 id
 243                 [11] u16 item
 244         */
 245
 246         TOSERVER_GROUND_ACTION = 0x28,
 247         /*
 248                 length: 17
 249                 [0] u16 command
 250                 [2] u8 action
 251                 [3] v3s16 nodepos_undersurface
 252                 [9] v3s16 nodepos_abovesurface
 253                 [15] u16 item
 254                 actions:
 255                 0: start digging (from undersurface)
 256                 1: place block (to abovesurface)
 257                 2: stop digging (all parameters ignored)
 258                 3: digging completed
 259         */
 260
 261         TOSERVER_RELEASE = 0x29, // Obsolete
 262
 263         TOSERVER_SIGNTEXT = 0x30, // Old signs
 264         /*
 265                 u16 command
 266                 v3s16 blockpos
 267                 s16 id
 268                 u16 textlen
 269                 textdata
 270         */
 271
 272         TOSERVER_INVENTORY_ACTION = 0x31,
 273         /*
 274                 See InventoryAction in inventory.h
 275         */
 276
 277         TOSERVER_CHAT_MESSAGE = 0x32,
 278         /*
 279                 u16 command
 280                 u16 length
 281                 wstring message
 282         */
 283
 284         TOSERVER_SIGNNODETEXT = 0x33,
 285         /*
 286                 u16 command
 287                 v3s16 p
 288                 u16 textlen
 289                 textdata
 290         */
 291
 292         TOSERVER_CLICK_ACTIVEOBJECT = 0x34,
 293         /*
 294                 length: 7
 295                 [0] u16 command
 296                 [2] u8 button (0=left, 1=right)
 297                 [3] u16 id
 298                 [5] u16 item
 299         */
 300
 301         TOSERVER_DAMAGE = 0x35,
 302         /*
 303                 u16 command
 304                 u8 amount
 305         */
 306
 307         TOSERVER_PASSWORD=0x36,
 308         /*
 309                 Sent to change password.
 310
 311                 [0] u16 TOSERVER_PASSWORD
 312                 [2] u8[28] old password
 313                 [30] u8[28] new password
 314         */
 315
 316         TOSERVER_PLAYERITEM=0x37,
 317         /*
 318                 Sent to change selected item.
 319
 320                 [0] u16 TOSERVER_PLAYERITEM
 321                 [2] u16 item
 322         */
 323
 324 };
 325
 326 inline SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time)
 327 {
 328         SharedBuffer<u8> data(2+2);
 329         writeU16(&data[0], TOCLIENT_TIME_OF_DAY);
 330         writeU16(&data[2], time);
 331         return data;
 332 }
 333
 334 #endif
 335