minetest/src/clientserver.h

524 lines
9.6 KiB
C
Raw Normal View History

/*
Minetest-c55
Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
2010-11-27 00:02:21 +01:00
#ifndef CLIENTSERVER_HEADER
#define CLIENTSERVER_HEADER
#include "utility.h"
2011-11-15 00:00:16 +01:00
/*
changes by PROTOCOL_VERSION:
PROTOCOL_VERSION 3:
Base for writing changes here
PROTOCOL_VERSION 4:
2012-03-25 10:50:29 +02:00
Add TOCLIENT_MEDIA
2011-11-15 22:58:56 +01:00
Add TOCLIENT_TOOLDEF
2011-11-15 19:32:56 +01:00
Add TOCLIENT_NODEDEF
2011-11-29 16:15:18 +01:00
Add TOCLIENT_CRAFTITEMDEF
Add TOSERVER_INTERACT
Obsolete TOSERVER_CLICK_ACTIVEOBJECT
Obsolete TOSERVER_GROUND_ACTION
PROTOCOL_VERSION 5:
Make players to be handled mostly as ActiveObjects
PROTOCOL_VERSION 6:
Only non-cached textures are sent
PROTOCOL_VERSION 7:
Add TOCLIENT_ITEMDEF
Obsolete TOCLIENT_TOOLDEF
Obsolete TOCLIENT_CRAFTITEMDEF
Compress the contents of TOCLIENT_ITEMDEF and TOCLIENT_NODEDEF
2012-02-28 18:45:23 +01:00
PROTOCOL_VERSION 8:
Digging based on item groups
2012-03-24 18:01:26 +01:00
Many things
PROTOCOL_VERSION 9:
ContentFeatures and NodeDefManager use a different serialization
format; better for future version cross-compatibility
Many things
PROTOCOL_VERSION 10:
TOCLIENT_PRIVILEGES
Version raised to force 'fly' and 'fast' privileges into effect.
2011-11-15 00:00:16 +01:00
*/
#define PROTOCOL_VERSION 10
2010-11-27 00:02:21 +01:00
#define PROTOCOL_ID 0x4f457403
#define PASSWORD_SIZE 28 // Maximum password length. Allows for
// base64-encoded SHA-1 (27+\0).
2012-01-03 23:37:46 +01:00
#define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_."
2010-11-27 00:02:21 +01:00
enum ToClientCommand
{
TOCLIENT_INIT = 0x10,
2010-11-27 00:02:21 +01:00
/*
Server's reply to TOSERVER_INIT.
Sent second after connected.
[0] u16 TOSERVER_INIT
[2] u8 deployed version
[3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
[12] u64 map seed (new as of 2011-02-27)
NOTE: The position in here is deprecated; position is
explicitly sent afterwards
2010-11-27 00:02:21 +01:00
*/
TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
TOCLIENT_ADDNODE = 0x21,
TOCLIENT_REMOVENODE = 0x22,
2010-11-27 00:02:21 +01:00
TOCLIENT_PLAYERPOS = 0x23, // Obsolete
2010-11-27 00:02:21 +01:00
/*
[0] u16 command
// Followed by an arbitary number of these:
// Number is determined from packet length.
[N] u16 peer_id
[N+2] v3s32 position*100
[N+2+12] v3s32 speed*100
[N+2+12+12] s32 pitch*100
[N+2+12+12+4] s32 yaw*100
*/
TOCLIENT_PLAYERINFO = 0x24, // Obsolete
2010-11-27 00:02:21 +01:00
/*
[0] u16 command
// Followed by an arbitary number of these:
// Number is determined from packet length.
[N] u16 peer_id
[N] char[20] name
*/
TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
2010-11-27 00:02:21 +01:00
TOCLIENT_SECTORMETA = 0x26, // Obsolete
2010-11-27 00:02:21 +01:00
/*
[0] u16 command
[2] u8 sector count
[3...] v2s16 pos + sector metadata
*/
TOCLIENT_INVENTORY = 0x27,
2010-11-27 00:02:21 +01:00
/*
[0] u16 command
[2] serialized inventory
*/
TOCLIENT_OBJECTDATA = 0x28, // Obsolete
2010-11-27 00:02:21 +01:00
/*
Sent as unreliable.
u16 command
u16 number of player positions
for each player:
u16 peer_id
2010-11-27 00:02:21 +01:00
v3s32 position*100
v3s32 speed*100
s32 pitch*100
s32 yaw*100
u16 count of blocks
for each block:
v3s16 blockpos
block objects
*/
TOCLIENT_TIME_OF_DAY = 0x29,
/*
u16 command
u16 time (0-23999)
Added in a later version:
f1000 time_speed
*/
2011-11-15 19:32:56 +01:00
// (oops, there is some gap here)
TOCLIENT_CHAT_MESSAGE = 0x30,
/*
u16 command
u16 length
wstring message
*/
TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
/*
u16 command
u16 count of removed objects
for all removed objects {
u16 id
}
u16 count of added objects
for all added objects {
u16 id
u8 type
u32 initialization data length
string initialization data
}
*/
TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
/*
u16 command
for all objects
{
u16 id
u16 message length
string message
}
*/
TOCLIENT_HP = 0x33,
/*
u16 command
u8 hp
*/
TOCLIENT_MOVE_PLAYER = 0x34,
/*
u16 command
v3f1000 player position
f1000 player pitch
f1000 player yaw
*/
TOCLIENT_ACCESS_DENIED = 0x35,
/*
u16 command
u16 reason_length
wstring reason
*/
TOCLIENT_PLAYERITEM = 0x36, // Obsolete
/*
u16 command
u16 count of player items
for all player items {
u16 peer id
u16 length of serialized item
string serialized item
}
*/
2011-10-15 13:46:59 +02:00
TOCLIENT_DEATHSCREEN = 0x37,
/*
u16 command
u8 bool set camera point target
v3f1000 camera point target (to point the death cause or whatever)
*/
2011-11-15 00:00:16 +01:00
2012-03-25 10:50:29 +02:00
TOCLIENT_MEDIA = 0x38,
2011-11-15 10:02:47 +01:00
/*
u16 command
2011-11-15 22:58:56 +01:00
u16 total number of texture bunches
u16 index of this bunch
2012-03-25 10:50:29 +02:00
u32 number of files in this bunch
for each file {
2011-11-15 10:02:47 +01:00
u16 length of name
string name
u32 length of data
data
}
*/
2011-11-15 22:58:56 +01:00
TOCLIENT_TOOLDEF = 0x39,
2011-11-15 19:32:56 +01:00
/*
u16 command
u32 length of the next item
2011-11-15 22:58:56 +01:00
serialized ToolDefManager
2011-11-15 19:32:56 +01:00
*/
2011-11-15 22:58:56 +01:00
TOCLIENT_NODEDEF = 0x3a,
2011-11-15 00:00:16 +01:00
/*
u16 command
2011-11-15 22:58:56 +01:00
u32 length of the next item
serialized NodeDefManager
2011-11-15 00:00:16 +01:00
*/
2011-11-29 16:15:18 +01:00
TOCLIENT_CRAFTITEMDEF = 0x3b,
/*
u16 command
u32 length of the next item
serialized CraftiItemDefManager
*/
2012-03-25 10:50:29 +02:00
TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
/*
u16 command
2012-03-25 10:50:29 +02:00
u32 number of files
for each texture {
u16 length of name
string name
u16 length of sha1_digest
string sha1_digest
}
*/
TOCLIENT_ITEMDEF = 0x3d,
/*
u16 command
u32 length of next item
serialized ItemDefManager
*/
2012-03-24 18:01:26 +01:00
TOCLIENT_PLAY_SOUND = 0x3f,
/*
u16 command
s32 sound_id
u16 len
u8[len] sound name
s32 gain*1000
u8 type (0=local, 1=positional, 2=object)
s32[3] pos_nodes*10000
u16 object_id
u8 loop (bool)
*/
2012-03-24 18:01:26 +01:00
TOCLIENT_STOP_SOUND = 0x40,
/*
u16 command
s32 sound_id
*/
TOCLIENT_PRIVILEGES = 0x41,
/*
u16 command
u16 number of privileges
for each privilege
u16 len
u8[len] privilege
*/
2010-11-27 00:02:21 +01:00
};
enum ToServerCommand
{
TOSERVER_INIT=0x10,
/*
Sent first after connected.
[0] u16 TOSERVER_INIT
[2] u8 SER_FMT_VER_HIGHEST
[3] u8[20] player_name
[23] u8[28] password (new in some version)
[51] u16 client network protocol version (new in some version)
2010-11-27 00:02:21 +01:00
*/
TOSERVER_INIT2 = 0x11,
2010-11-27 00:02:21 +01:00
/*
Sent as an ACK for TOCLIENT_INIT.
After this, the server can send data.
[0] u16 TOSERVER_INIT2
*/
TOSERVER_GETBLOCK=0x20, // Obsolete
TOSERVER_ADDNODE = 0x21, // Obsolete
TOSERVER_REMOVENODE = 0x22, // Obsolete
2010-11-27 00:02:21 +01:00
TOSERVER_PLAYERPOS = 0x23,
2010-11-27 00:02:21 +01:00
/*
[0] u16 command
[2] v3s32 position*100
[2+12] v3s32 speed*100
[2+12+12] s32 pitch*100
[2+12+12+4] s32 yaw*100
*/
TOSERVER_GOTBLOCKS = 0x24,
2010-11-27 00:02:21 +01:00
/*
[0] u16 command
[2] u8 count
[3] v3s16 pos_0
[3+6] v3s16 pos_1
...
*/
TOSERVER_DELETEDBLOCKS = 0x25,
2010-11-27 00:02:21 +01:00
/*
[0] u16 command
[2] u8 count
[3] v3s16 pos_0
[3+6] v3s16 pos_1
...
*/
TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
2010-11-27 00:02:21 +01:00
/*
[0] u16 command
[2] v3s16 pos
[8] u16 i
*/
2011-11-29 16:15:18 +01:00
TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
2010-11-27 00:02:21 +01:00
/*
length: 13
[0] u16 command
[2] u8 button (0=left, 1=right)
[3] v3s16 blockpos
[9] s16 id
[11] u16 item
*/
2011-11-29 16:15:18 +01:00
TOSERVER_GROUND_ACTION = 0x28, // Obsolete
2010-11-27 00:02:21 +01:00
/*
length: 17
[0] u16 command
[2] u8 action
2010-11-27 00:02:21 +01:00
[3] v3s16 nodepos_undersurface
[9] v3s16 nodepos_abovesurface
[15] u16 item
actions:
0: start digging (from undersurface)
1: place block (to abovesurface)
2: stop digging (all parameters ignored)
3: digging completed
2010-11-27 00:02:21 +01:00
*/
TOSERVER_RELEASE = 0x29, // Obsolete
2010-11-27 00:02:21 +01:00
2011-11-15 19:32:56 +01:00
// (oops, there is some gap here)
2011-11-29 16:15:18 +01:00
TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
2010-11-27 00:02:21 +01:00
/*
u16 command
v3s16 blockpos
s16 id
u16 textlen
textdata
*/
2010-12-22 15:30:23 +01:00
TOSERVER_INVENTORY_ACTION = 0x31,
/*
See InventoryAction in inventory.h
*/
TOSERVER_CHAT_MESSAGE = 0x32,
/*
u16 command
u16 length
wstring message
*/
TOSERVER_SIGNNODETEXT = 0x33, // obsolete
/*
u16 command
v3s16 p
u16 textlen
textdata
*/
2011-11-29 16:15:18 +01:00
TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
2011-04-10 03:15:10 +02:00
/*
length: 7
[0] u16 command
[2] u8 button (0=left, 1=right)
[3] u16 id
[5] u16 item
*/
TOSERVER_DAMAGE = 0x35,
/*
u16 command
u8 amount
*/
TOSERVER_PASSWORD=0x36,
/*
Sent to change password.
[0] u16 TOSERVER_PASSWORD
[2] u8[28] old password
[30] u8[28] new password
*/
TOSERVER_PLAYERITEM=0x37,
/*
Sent to change selected item.
[0] u16 TOSERVER_PLAYERITEM
[2] u16 item
*/
2011-10-15 13:46:59 +02:00
TOSERVER_RESPAWN=0x38,
/*
u16 TOSERVER_RESPAWN
*/
2011-11-29 16:15:18 +01:00
TOSERVER_INTERACT = 0x39,
/*
[0] u16 command
[2] u8 action
[3] u16 item
[5] u32 length of the next item
[9] serialized PointedThing
actions:
0: start digging (from undersurface) or use
1: stop digging (all parameters ignored)
2: digging completed
3: place block or item (to abovesurface)
4: use item
(Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
*/
2012-03-24 18:01:26 +01:00
TOSERVER_REMOVED_SOUNDS = 0x3a,
/*
u16 command
u16 len
s32[len] sound_id
*/
TOSERVER_NODEMETA_FIELDS = 0x3b,
/*
u16 command
v3s16 p
u16 len
u8[len] form name (reserved for future use)
u16 number of fields
for each field:
u16 len
u8[len] field name
u32 len
u8[len] field value
*/
2012-03-25 10:50:29 +02:00
TOSERVER_REQUEST_MEDIA = 0x40,
/*
2012-03-24 18:01:26 +01:00
u16 command
2012-03-25 10:50:29 +02:00
u16 number of files requested
for each file {
2012-03-24 18:01:26 +01:00
u16 length of name
string name
}
*/
2010-11-27 00:02:21 +01:00
};
inline SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time, float time_speed)
{
SharedBuffer<u8> data(2+2+4);
writeU16(&data[0], TOCLIENT_TIME_OF_DAY);
writeU16(&data[2], time);
writeF1000(&data[4], time_speed);
return data;
}
2010-11-27 00:02:21 +01:00
#endif