1 | /* |
1 | /* |
2 | * CrossFire, A Multiplayer game for the X Window System |
2 | * This file is part of Crossfire TRT, the Roguelike Realtime MORPG. |
3 | * |
3 | * |
4 | * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team |
4 | * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team |
5 | * Copyright (C) 2002 Mark Wedel & Crossfire Development Team |
5 | * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team |
6 | * Copyright (C) 1992 Frank Tore Johansen |
6 | * Copyright (©) 1992,2007 Frank Tore Johansen |
7 | * |
7 | * |
8 | * This program is free software; you can redistribute it and/or modify |
8 | * Crossfire TRT is free software: you can redistribute it and/or modify |
9 | * it under the terms of the GNU General Public License as published by |
9 | * it under the terms of the GNU General Public License as published by |
10 | * the Free Software Foundation; either version 2 of the License, or |
10 | * the Free Software Foundation, either version 3 of the License, or |
11 | * (at your option) any later version. |
11 | * (at your option) any later version. |
12 | * |
12 | * |
13 | * This program is distributed in the hope that it will be useful, |
13 | * This program is distributed in the hope that it will be useful, |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16 | * GNU General Public License for more details. |
16 | * GNU General Public License for more details. |
17 | * |
17 | * |
18 | * You should have received a copy of the GNU General Public License |
18 | * You should have received a copy of the GNU General Public License |
19 | * along with this program; if not, write to the Free Software |
19 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
20 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
|
|
21 | * |
20 | * |
22 | * The author can be reached via e-mail to crossfire@schmorp.de |
21 | * The authors can be reached via e-mail to <crossfire@schmorp.de> |
23 | */ |
22 | */ |
24 | |
23 | |
25 | #ifndef CLIENT_H |
24 | #ifndef CLIENT_H |
26 | #define CLIENT_H |
25 | #define CLIENT_H |
27 | |
26 | |
… | |
… | |
86 | PF_PLAYING = 0x02, // must be in playing state |
85 | PF_PLAYING = 0x02, // must be in playing state |
87 | PF_COMMAND0 = 0x04, // command starts at offset 0 |
86 | PF_COMMAND0 = 0x04, // command starts at offset 0 |
88 | PF_COMMAND6 = 0x08, // command starts at offset 6 |
87 | PF_COMMAND6 = 0x08, // command starts at offset 6 |
89 | }; |
88 | }; |
90 | |
89 | |
|
|
90 | // face type.s bit 0 means "has meta info prepended" |
|
|
91 | enum { |
|
|
92 | FT_FACE = 0 * 2 + 0, // faces (images) |
|
|
93 | FT_MUSIC = 1 * 2 + 1, // background music |
|
|
94 | FT_SOUND = 2 * 2 + 1, // effects |
|
|
95 | FT_RSRC = 3 * 2 + 0, // generic data files |
|
|
96 | FT_NUM, |
|
|
97 | }; |
|
|
98 | |
91 | struct packet_type |
99 | struct packet_type |
92 | { |
100 | { |
93 | const char *name; |
101 | const char *name; |
94 | void *cb; |
102 | void *cb; |
95 | int flags; |
103 | int flags; |
… | |
… | |
115 | struct client : zero_initialised, attachable |
123 | struct client : zero_initialised, attachable |
116 | { |
124 | { |
117 | int ACC (RW, fd); |
125 | int ACC (RW, fd); |
118 | unsigned int inbuf_len; // number of bytes valid in inbuf |
126 | unsigned int inbuf_len; // number of bytes valid in inbuf |
119 | statsinfo stats; |
127 | statsinfo stats; |
120 | int ACC (RO, active); |
128 | object_vector_index ACC (RO, active); |
|
|
129 | player_ptr ACC (RO, pl); |
121 | |
130 | |
122 | /* The following is the setup for a ring buffer for storing output |
131 | /* The following is the setup for a ring buffer for storing output |
123 | * data that the OS can't handle right away. |
132 | * data that the OS can't handle right away. |
124 | */ |
133 | */ |
125 | struct |
134 | struct |
… | |
… | |
155 | bool ACC (RW, sent_scroll); |
164 | bool ACC (RW, sent_scroll); |
156 | bool ACC (RW, sound); /* does the client want sound */ |
165 | bool ACC (RW, sound); /* does the client want sound */ |
157 | bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
166 | bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
158 | bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ |
167 | bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ |
159 | bool ACC (RW, mapinfocmd); // return map info and send map change info |
168 | bool ACC (RW, mapinfocmd); // return map info and send map change info |
160 | bool ACC (RW, extcmd); // call into extensions/plugins |
169 | uint8_t ACC (RW, extcmd); // call into extensions/plugins |
161 | bool ACC (RW, extmap); // extend map comamnd with extra data |
170 | bool ACC (RW, extmap); // extend map comamnd with extra data |
162 | bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls |
171 | bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls |
163 | bool ACC (RW, darkness); /* True if client wants darkness information */ |
172 | bool ACC (RW, darkness); /* True if client wants darkness information */ |
164 | bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
173 | bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
165 | bool ACC (RW, fxix); // client implements fx and ix (face|image extended) commands |
174 | uint8_t ACC (RW, fxix); // client implements fx and ix (face|image extended) commands |
166 | bool ACC (RW, update_look); /* If true, we need to send the look window */ |
175 | bool ACC (RW, update_look); /* If true, we need to send the look window */ |
167 | bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
176 | bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
168 | /* used to arrange text in books, scrolls, or scripted dialogs */ |
177 | /* used to arrange text in books, scrolls, or scripted dialogs */ |
169 | bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ |
178 | bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ |
170 | bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ |
179 | bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ |
… | |
… | |
187 | region *ACC (RW, current_region); // CF+ last/current player region |
196 | region *ACC (RW, current_region); // CF+ last/current player region |
188 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
197 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
189 | shstr ACC (RW, version); // CF+ client name/version |
198 | shstr ACC (RW, version); // CF+ client name/version |
190 | uint8 ACC (RW, faceset); // CF+ selected faceset |
199 | uint8 ACC (RW, faceset); // CF+ selected faceset |
191 | |
200 | |
192 | player_ptr ACC (RO, pl); |
201 | tstamp ACC (RW, last_send); // last data send on socket. |
193 | |
202 | |
194 | int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
203 | int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
|
|
204 | int ACC (RW, outq); // current socket outq length, or 0 if indeterminable |
195 | |
205 | |
196 | int ACC (RW, rate_avail); // current rate balance |
206 | int ACC (RW, rate_avail); // current rate balance |
197 | int ACC (RW, max_rate); // max. # of bytes to send per tick |
207 | int ACC (RW, max_rate); // max. # of bytes to send per tick |
198 | faceidx ACC (RW, scrub_idx); // which face to send next |
208 | faceidx ACC (RW, scrub_idx); // which face to send next |
199 | int ACC (RW, bg_scrub); // how many ticks till the next background face send |
209 | int ACC (RW, bg_scrub); // how many ticks till the next background face send |
200 | |
210 | |
201 | faceidx partial_face; |
211 | struct ixsend { |
202 | uint32 partial_face_ofs; // if != 0, need to send remaining bytes of partial_face |
212 | int16_t pri; // unused |
203 | std::vector<faceidx, slice_allocator<faceidx> > askface; // which faces have been requested by the client |
213 | faceidx idx; |
|
|
214 | uint32_t ofs; // if != 0, need to send remaining bytes of partial_face |
|
|
215 | }; |
|
|
216 | std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix |
204 | |
217 | |
205 | std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx |
218 | std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx |
206 | MTH void flush_fx (); // send fx if required |
219 | MTH void flush_fx (); // send fx if required |
207 | |
220 | |
208 | void do_destroy (); |
221 | void do_destroy (); |
209 | void gather_callbacks (AV *&callbacks, event_type event) const; |
222 | void gather_callbacks (AV *&callbacks, event_type event) const; |
210 | |
223 | |
… | |
… | |
215 | |
228 | |
216 | // large structures at the end please |
229 | // large structures at the end please |
217 | struct Map lastmap; |
230 | struct Map lastmap; |
218 | std::bitset<MAXANIMNUM> anims_sent; |
231 | std::bitset<MAXANIMNUM> anims_sent; |
219 | std::bitset<MAX_FACES> faces_sent; |
232 | std::bitset<MAX_FACES> faces_sent; |
|
|
233 | std::bitset<FT_NUM> fx_want; |
220 | |
234 | |
221 | // if we get an incomplete packet, this is used to hold the data. |
235 | // if we get an incomplete packet, this is used to hold the data. |
222 | // we add 2 byte for the header, one for the trailing 0 byte |
236 | // we add 2 byte for the header, one for the trailing 0 byte |
223 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
237 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
224 | |
238 | |
… | |
… | |
256 | void send_packet (const char *buf, int len); |
270 | void send_packet (const char *buf, int len); |
257 | void send_packet_printf (const char *format, ...); |
271 | void send_packet_printf (const char *format, ...); |
258 | void send_packet (packet &sl); |
272 | void send_packet (packet &sl); |
259 | |
273 | |
260 | void send_drawinfo (const char *msg, int flags = NDI_BLACK); |
274 | void send_drawinfo (const char *msg, int flags = NDI_BLACK); |
|
|
275 | |
261 | MTH void send_face (faceidx facenum); |
276 | MTH void send_face (faceidx facenum, int pri = 0); |
262 | MTH void send_image (faceidx facenum); |
277 | MTH void send_image (faceidx facenum); |
263 | MTH void send_faces (object *ob); |
278 | MTH void send_faces (object *ob); |
264 | MTH void send_animation (short anim_num); |
279 | MTH void send_animation (short anim_num); |
265 | MTH void send_msg (int color, const char *type, const char *msg); |
280 | void send_msg (int color, const char *type, const char *msg); |
266 | |
281 | |
|
|
282 | MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); |
267 | // called when something under the player changes |
283 | // called when something under the player changes |
268 | MTH void floorbox_update () { update_look = 1; } |
284 | MTH void floorbox_update () { update_look = 1; } |
269 | // called when the player has been moved |
285 | // called when the player has been moved |
270 | MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
286 | MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
271 | |
287 | |
… | |
… | |
313 | #define PNG_FACE_INDEX 0 |
329 | #define PNG_FACE_INDEX 0 |
314 | |
330 | |
315 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
331 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
316 | #define VERSION_SC 1026 |
332 | #define VERSION_SC 1026 |
317 | //#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible |
333 | //#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible |
318 | #define VERSION_INFO "Crossfire+ Server" |
334 | #define VERSION_INFO "Crossfire TRT Server" |
319 | |
335 | |
320 | typedef object_vector<client, &client::active> sockvec; |
336 | typedef object_vector<client, &client::active> sockvec; |
321 | |
337 | |
322 | extern sockvec clients; |
338 | extern sockvec clients; |
323 | |
339 | |
324 | #define for_all_clients(var) \ |
340 | #define for_all_clients(var) \ |
325 | for (int _i = 0; _i < clients.size (); ++_i) \ |
341 | for (int _i = 0; _i < clients.size (); ++_i) \ |
326 | declvar (client *, var, clients [_i]) |
342 | statementvar (client *, var, clients [_i]) |
327 | |
343 | |
328 | #endif |
344 | #endif |
329 | |
345 | |