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         TOCLIENT_DEATHSCREEN = 0x37,
 177         /*
 178                 u16 command
 179                 u8 bool set camera point target
 180                 v3f1000 camera point target (to point the death cause or whatever)
 181         */
 182 };
 183
 184 enum ToServerCommand
 185 {
 186         TOSERVER_INIT=0x10,
 187         /*
 188                 Sent first after connected.
 189
 190                 [0] u16 TOSERVER_INIT
 191                 [2] u8 SER_FMT_VER_HIGHEST
 192                 [3] u8[20] player_name
 193                 [23] u8[28] password (new in some version)
 194                 [51] u16 client network protocol version (new in some version)
 195         */
 196
 197         TOSERVER_INIT2 = 0x11,
 198         /*
 199                 Sent as an ACK for TOCLIENT_INIT.
 200                 After this, the server can send data.
 201
 202                 [0] u16 TOSERVER_INIT2
 203         */
 204
 205         TOSERVER_GETBLOCK=0x20, // Obsolete
 206         TOSERVER_ADDNODE = 0x21, // Obsolete
 207         TOSERVER_REMOVENODE = 0x22, // Obsolete
 208
 209         TOSERVER_PLAYERPOS = 0x23,
 210         /*
 211                 [0] u16 command
 212                 [2] v3s32 position*100
 213                 [2+12] v3s32 speed*100
 214                 [2+12+12] s32 pitch*100
 215                 [2+12+12+4] s32 yaw*100
 216         */
 217
 218         TOSERVER_GOTBLOCKS = 0x24,
 219         /*
 220                 [0] u16 command
 221                 [2] u8 count
 222                 [3] v3s16 pos_0
 223                 [3+6] v3s16 pos_1
 224                 ...
 225         */
 226
 227         TOSERVER_DELETEDBLOCKS = 0x25,
 228         /*
 229                 [0] u16 command
 230                 [2] u8 count
 231                 [3] v3s16 pos_0
 232                 [3+6] v3s16 pos_1
 233                 ...
 234         */
 235
 236         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
 237         /*
 238                 [0] u16 command
 239                 [2] v3s16 pos
 240                 [8] u16 i
 241         */
 242
 243         TOSERVER_CLICK_OBJECT = 0x27,
 244         /*
 245                 length: 13
 246                 [0] u16 command
 247                 [2] u8 button (0=left, 1=right)
 248                 [3] v3s16 blockpos
 249                 [9] s16 id
 250                 [11] u16 item
 251         */
 252
 253         TOSERVER_GROUND_ACTION = 0x28,
 254         /*
 255                 length: 17
 256                 [0] u16 command
 257                 [2] u8 action
 258                 [3] v3s16 nodepos_undersurface
 259                 [9] v3s16 nodepos_abovesurface
 260                 [15] u16 item
 261                 actions:
 262                 0: start digging (from undersurface)
 263                 1: place block (to abovesurface)
 264                 2: stop digging (all parameters ignored)
 265                 3: digging completed
 266         */
 267
 268         TOSERVER_RELEASE = 0x29, // Obsolete
 269
 270         TOSERVER_SIGNTEXT = 0x30, // Old signs
 271         /*
 272                 u16 command
 273                 v3s16 blockpos
 274                 s16 id
 275                 u16 textlen
 276                 textdata
 277         */
 278
 279         TOSERVER_INVENTORY_ACTION = 0x31,
 280         /*
 281                 See InventoryAction in inventory.h
 282         */
 283
 284         TOSERVER_CHAT_MESSAGE = 0x32,
 285         /*
 286                 u16 command
 287                 u16 length
 288                 wstring message
 289         */
 290
 291         TOSERVER_SIGNNODETEXT = 0x33,
 292         /*
 293                 u16 command
 294                 v3s16 p
 295                 u16 textlen
 296                 textdata
 297         */
 298
 299         TOSERVER_CLICK_ACTIVEOBJECT = 0x34,
 300         /*
 301                 length: 7
 302                 [0] u16 command
 303                 [2] u8 button (0=left, 1=right)
 304                 [3] u16 id
 305                 [5] u16 item
 306         */
 307
 308         TOSERVER_DAMAGE = 0x35,
 309         /*
 310                 u16 command
 311                 u8 amount
 312         */
 313
 314         TOSERVER_PASSWORD=0x36,
 315         /*
 316                 Sent to change password.
 317
 318                 [0] u16 TOSERVER_PASSWORD
 319                 [2] u8[28] old password
 320                 [30] u8[28] new password
 321         */
 322
 323         TOSERVER_PLAYERITEM=0x37,
 324         /*
 325                 Sent to change selected item.
 326
 327                 [0] u16 TOSERVER_PLAYERITEM
 328                 [2] u16 item
 329         */
 330
 331         TOSERVER_RESPAWN=0x38,
 332         /*
 333                 u16 TOSERVER_RESPAWN
 334         */
 335 };
 336
 337 inline SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time)
 338 {
 339         SharedBuffer<u8> data(2+2);
 340         writeU16(&data[0], TOCLIENT_TIME_OF_DAY);
 341         writeU16(&data[2], time);
 342         return data;
 343 }
 344
 345 #endif
 346