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 };
 110
 111 enum ToServerCommand
 112 {
 113         TOSERVER_INIT=0x10,
 114         /*
 115                 Sent first after connected.
 116
 117                 [0] u16 TOSERVER_INIT
 118                 [2] u8 SER_FMT_VER_HIGHEST
 119                 [3] u8[20] player_name
 120         */
 121
 122         TOSERVER_INIT2 = 0x11,
 123         /*
 124                 Sent as an ACK for TOCLIENT_INIT.
 125                 After this, the server can send data.
 126
 127                 [0] u16 TOSERVER_INIT2
 128         */
 129
 130         TOSERVER_GETBLOCK=0x20, // Not used
 131         TOSERVER_ADDNODE = 0x21, // Not used
 132         TOSERVER_REMOVENODE = 0x22, // deprecated
 133
 134         TOSERVER_PLAYERPOS = 0x23,
 135         /*
 136                 [0] u16 command
 137                 [2] v3s32 position*100
 138                 [2+12] v3s32 speed*100
 139                 [2+12+12] s32 pitch*100
 140                 [2+12+12+4] s32 yaw*100
 141         */
 142
 143         TOSERVER_GOTBLOCKS = 0x24,
 144         /*
 145                 [0] u16 command
 146                 [2] u8 count
 147                 [3] v3s16 pos_0
 148                 [3+6] v3s16 pos_1
 149                 ...
 150         */
 151
 152         TOSERVER_DELETEDBLOCKS = 0x25,
 153         /*
 154                 [0] u16 command
 155                 [2] u8 count
 156                 [3] v3s16 pos_0
 157                 [3+6] v3s16 pos_1
 158                 ...
 159         */
 160
 161         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // deprecated
 162         /*
 163                 [0] u16 command
 164                 [2] v3s16 pos
 165                 [8] u16 i
 166         */
 167
 168         TOSERVER_CLICK_OBJECT = 0x27,
 169         /*
 170                 length: 13
 171                 [0] u16 command
 172                 [2] u8 button (0=left, 1=right)
 173                 [3] v3s16 blockpos
 174                 [9] s16 id
 175                 [11] u16 item
 176         */
 177
 178         TOSERVER_GROUND_ACTION = 0x28,
 179         /*
 180                 length: 17
 181                 [0] u16 command
 182                 [2] u8 action
 183                 [3] v3s16 nodepos_undersurface
 184                 [9] v3s16 nodepos_abovesurface
 185                 [15] u16 item
 186                 actions:
 187                 0: start digging (from undersurface)
 188                 1: place block (to abovesurface)
 189                 2: stop digging (all parameters ignored)
 190                 3: digging completed
 191         */
 192
 193         TOSERVER_RELEASE = 0x29, // Not used
 194
 195         TOSERVER_SIGNTEXT = 0x30,
 196         /*
 197                 u16 command
 198                 v3s16 blockpos
 199                 s16 id
 200                 u16 textlen
 201                 textdata
 202         */
 203
 204         TOSERVER_INVENTORY_ACTION = 0x31,
 205         /*
 206                 See InventoryAction in inventory.h
 207         */
 208
 209         TOSERVER_CHAT_MESSAGE = 0x32,
 210         /*
 211                 u16 command
 212                 u16 length
 213                 wstring message
 214         */
 215
 216 };
 217
 218 inline SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time)
 219 {
 220         SharedBuffer<u8> data(2+2);
 221         writeU16(&data[0], TOCLIENT_TIME_OF_DAY);
 222         writeU16(&data[2], time);
 223         return data;
 224 }
 225
 226 #endif
 227