--- deliantra/server/include/client.h 2007/03/15 03:30:37 1.39
+++ deliantra/server/include/client.h 2007/07/01 05:00:18 1.59
@@ -1,25 +1,24 @@
/*
- * CrossFire, A Multiplayer game for the X Window System
+ * This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
*
- * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
- * Copyright (C) 2002 Mark Wedel & Crossfire Development Team
- * Copyright (C) 1992 Frank Tore Johansen
+ * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
+ * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
+ * Copyright (©) 1992,2007 Frank Tore Johansen
*
- * This program is free software; you can redistribute it and/or modify
+ * Crossfire TRT is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation, either version 3 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
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * The author can be reached via e-mail to crossfire@schmorp.de
+ * along with this program. If not, see .
+ *
+ * The authors can be reached via e-mail to
*/
#ifndef CLIENT_H
@@ -34,7 +33,7 @@
struct MapCell
{
- UUID player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
+ tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
int count; /* This is really darkness in the map1 command */
faceidx faces[MAP_LAYERS];
unsigned char stat_hp; // health of something in this space, or 0
@@ -68,17 +67,7 @@
* instead of having a bunch of different fields that needed to
* get toggled.
*/
-enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
-
-/* The following is the setup for a ring buffer for storing output
- * data that the OS can't handle right away.
- */
-struct Buffer
-{
- char data[SOCKETBUFSIZE];
- int start;
- int len;
-};
+enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
// states the socket can be in
enum {
@@ -87,7 +76,6 @@
ST_PLAYING, // logged in an playing
ST_CUSTOM, // waiting for custom reply
- ST_CHANGE_CLASS,
ST_GET_PARTY_PASSWORD,
};
@@ -119,43 +107,6 @@
}
};
-struct refitem
-{
- object_ptr op;
-};
-
-// this represents a container on the client side.
-// right now, there are only ever two of them:
-// the inventory and the floor/open container
-//TODO: unused as of yet
-struct client_container : vector< refitem, slice_allocator >
-{
- client *ns;
- enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type;
-
- bool item_changed; // one of the items in here possibly changed
-
- // for mapspace and container
- int x, y;
- maptile *map;
-
- // for container
- object *env;
-
- client_container (client *ns)
- : ns (ns), type (CC_NONE) { }
-
- tag_t tag () const;
-
- inline iterator merge_item (iterator i, object *op);
-
- void clear ();
- void update ();
-
- void set_mapspace (maptile *map, int x, int y);
- void set_container (object *env);
-};
-
/* how many times we are allowed to give the wrong password before being kicked. */
#define MAX_PASSWORD_FAILURES 5
@@ -165,9 +116,18 @@
int ACC (RW, fd);
unsigned int inbuf_len; // number of bytes valid in inbuf
statsinfo stats;
- int ACC (RO, active);
+ object_vector_index ACC (RO, active);
+ player_ptr ACC (RO, pl);
- Buffer outputbuffer;
+ /* The following is the setup for a ring buffer for storing output
+ * data that the OS can't handle right away.
+ */
+ struct
+ {
+ char data[SOCKETBUFSIZE];
+ int start;
+ int len;
+ } outputbuffer;
char *ACC (RW, host); /* Which host it is connected from (ip address) */
uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
@@ -185,20 +145,24 @@
sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */
+ bool ACC (RW, force_face0); // client workaround for buggy checksum calculation in gcfclient
+ bool ACC (RW, force_bad_checksum); // client workaround for buggy checksum calculation in gcfclient
+ bool ACC (RW, force_image_newmap); // client workaround for client not redrawing map on image upload
+ bool ACC (RW, enable_bg_scrub); // client workaround, gcfclient becomes unusable if you send it images
+
bool ACC (RW, afk); /* player is afk */
bool ACC (RW, facecache); /* If true, client is caching images */
bool ACC (RW, sent_scroll);
bool ACC (RW, sound); /* does the client want sound */
bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
- bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */
- bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */
- bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */
- bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */
- bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */
- bool ACC (RW, force_face0); /* CF+ client workaround for buggy checksum calculation in gcfclient */
- bool ACC (RW, force_bad_checksum); /* CF+ client workaround for buggy checksum calculation in gcfclient */
+ bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
+ bool ACC (RW, mapinfocmd); // return map info and send map change info
+ bool ACC (RW, extcmd); // call into extensions/plugins
+ bool ACC (RW, extmap); // extend map comamnd with extra data
+ bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
bool ACC (RW, darkness); /* True if client wants darkness information */
bool ACC (RW, image2); /* Client wants image2/face2 commands */
+ uint8_t ACC (RW, fxix); // client implements fx and ix (face|image extended) commands
bool ACC (RW, update_look); /* If true, we need to send the look window */
bool ACC (RW, has_readable_type); /* If true client accept additional text information */
/* used to arrange text in books, scrolls, or scripted dialogs */
@@ -207,35 +171,48 @@
/* Below are flags for extedend infos to pass to client
* with S->C mapextended command */
bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
+ bool ACC (RW, smoothing); // trt-style smoothing
+ bool ACC (RW, can_msg); // trt-style text messages
+ bool ACC (RW, force_newmap); // force a newmap before next map update
uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
- enum MapMode mapmode; /* Type of map commands the client wants. */
uint16 ACC (RW, look_position); /* start of drawing of look window */
+ uint16 ACC (RW, mss); // likely tcp maximum segment size
+ uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
maptile *ACC (RW, current_map); // CF+ last/current player map
region *ACC (RW, current_region); // CF+ last/current player region
int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
- char ACC (RW, version)[64]; // CF+ client name/version
+ shstr ACC (RW, version); // CF+ client name/version
uint8 ACC (RW, faceset); // CF+ selected faceset
- player_ptr ACC (RO, pl);
+ tstamp ACC (RW, last_send); // last data send on socket.
int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
+ int ACC (RW, rate_avail); // current rate balance
int ACC (RW, max_rate); // max. # of bytes to send per tick
faceidx ACC (RW, scrub_idx); // which face to send next
int ACC (RW, bg_scrub); // how many ticks till the next background face send
- std::vector askface; // which faces have been requested by the client
+
+ struct ixsend {
+ int16_t pri; // unused
+ faceidx idx;
+ uint32_t ofs; // if != 0, need to send remaining bytes of partial_face
+ };
+ std::vector > ixface; // which faces to send to the client using ix
+
+ std::vector > fxface; // which faces to send using fx
+ MTH void flush_fx (); // send fx if required
void do_destroy ();
void gather_callbacks (AV *&callbacks, event_type event) const;
iow socket_ev; void socket_cb (iow &w, int got);
iw cmd_ev; void cmd_cb (iw &w);
- client_container cc_inv, cc_other;
std::deque< command, slice_allocator > cmd_queue;
@@ -248,6 +225,17 @@
// we add 2 byte for the header, one for the trailing 0 byte
uint8 inbuf[MAXSOCKBUF + 2 + 1];
+ enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
+ struct msg_buf
+ {
+ tick_t expire;
+ int len;
+ int count;
+ char msg[MSG_BUF_SIZE];
+ } msgbuf[MSG_BUF_COUNT];
+
+ MTH bool msg_suppressed (const char *msg);
+
bool may_execute (const packet_type *pkt) const;
void execute (const packet_type *pkt, char *data, int datalen);
@@ -277,6 +265,7 @@
MTH void send_image (faceidx facenum);
MTH void send_faces (object *ob);
MTH void send_animation (short anim_num);
+ void send_msg (int color, const char *type, const char *msg);
// called when something under the player changes
MTH void floorbox_update () { update_look = 1; }
@@ -329,7 +318,7 @@
#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
#define VERSION_SC 1026
//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
-#define VERSION_INFO "Crossfire+ Server"
+#define VERSION_INFO "Crossfire TRT Server"
typedef object_vector sockvec;
@@ -337,7 +326,7 @@
#define for_all_clients(var) \
for (int _i = 0; _i < clients.size (); ++_i) \
- declvar (client *, var, clients [_i])
+ statementvar (client *, var, clients [_i])
#endif