rewrote server sendstates building code, no longer builds two
[divverent/darkplaces.git] / client.h
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12
13 See the GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18
19 */
20 // client.h
21
22 #ifndef CLIENT_H
23 #define CLIENT_H
24
25 #include "matrixlib.h"
26
27 // LordHavoc: 256 dynamic lights
28 #define MAX_DLIGHTS 256
29
30 // this is the maximum number of input packets that can be lost without a
31 // misprediction
32 #define CL_MAX_USERCMDS 16
33
34 // flags for rtlight rendering
35 #define LIGHTFLAG_NORMALMODE 1
36 #define LIGHTFLAG_REALTIMEMODE 2
37
38 typedef struct effect_s
39 {
40         int active;
41         vec3_t origin;
42         float starttime;
43         float framerate;
44         int modelindex;
45         int startframe;
46         int endframe;
47         // these are for interpolation
48         int frame;
49         double frame1time;
50         double frame2time;
51 }
52 cl_effect_t;
53
54 typedef struct beam_s
55 {
56         int             entity;
57         // draw this as lightning polygons, or a model?
58         int             lightning;
59         struct model_s  *model;
60         float   endtime;
61         vec3_t  start, end;
62 }
63 beam_t;
64
65 typedef struct rtlight_s
66 {
67         // shadow volumes are done entirely in model space, so there are no matrices for dealing with them...  they just use the origin
68
69         // note that the world to light matrices are inversely scaled (divided) by lightradius
70
71         // core properties
72         // matrix for transforming light filter coordinates to world coordinates
73         matrix4x4_t matrix_lighttoworld;
74         // matrix for transforming world coordinates to light filter coordinates
75         matrix4x4_t matrix_worldtolight;
76         // typically 1 1 1, can be lower (dim) or higher (overbright)
77         vec3_t color;
78         // size of the light (remove?)
79         vec_t radius;
80         // light filter
81         char cubemapname[64];
82         // light style to monitor for brightness
83         int style;
84         // whether light should render shadows
85         int shadow;
86         // intensity of corona to render
87         vec_t corona;
88         // radius scale of corona to render (1.0 means same as light radius)
89         vec_t coronasizescale;
90         // ambient intensity to render
91         vec_t ambientscale;
92         // diffuse intensity to render
93         vec_t diffusescale;
94         // specular intensity to render
95         vec_t specularscale;
96         // LIGHTFLAG_* flags
97         int flags;
98
99         // generated properties
100         // used only for shadow volumes
101         vec3_t shadoworigin;
102         // culling
103         vec3_t cullmins;
104         vec3_t cullmaxs;
105         // culling
106         //vec_t cullradius;
107         // squared cullradius
108         //vec_t cullradius2;
109
110         // rendering properties, updated each time a light is rendered
111         // this is rtlight->color * d_lightstylevalue
112         vec3_t currentcolor;
113         // this is R_Shadow_Cubemap(rtlight->cubemapname)
114         rtexture_t *currentcubemap;
115
116         // static light info
117         // true if this light should be compiled as a static light
118         int isstatic;
119         // true if this is a compiled world light, cleared if the light changes
120         int compiled;
121         // premade shadow volumes to render for world entity
122         shadowmesh_t *static_meshchain_shadow;
123         // used for visibility testing (more exact than bbox)
124         int static_numleafs;
125         int static_numleafpvsbytes;
126         int *static_leaflist;
127         unsigned char *static_leafpvs;
128         // surfaces seen by light
129         int static_numsurfaces;
130         int *static_surfacelist;
131         // flag bits indicating which triangles of the world model should cast
132         // shadows, and which ones should be lit
133         //
134         // this avoids redundantly scanning the triangles in each surface twice
135         // for whether they should cast shadows, once in culling and once in the
136         // actual shadowmarklist production.
137         int static_numshadowtrispvsbytes;
138         unsigned char *static_shadowtrispvs;
139         // this allows the lighting batch code to skip backfaces andother culled
140         // triangles not relevant for lighting
141         // (important on big surfaces such as terrain)
142         int static_numlighttrispvsbytes;
143         unsigned char *static_lighttrispvs;
144 }
145 rtlight_t;
146
147 typedef struct dlight_s
148 {
149         // destroy light after this time
150         // (dlight only)
151         vec_t die;
152         // the entity that owns this light (can be NULL)
153         // (dlight only)
154         struct entity_render_s *ent;
155         // location
156         // (worldlight: saved to .rtlights file)
157         vec3_t origin;
158         // worldlight orientation
159         // (worldlight only)
160         // (worldlight: saved to .rtlights file)
161         vec3_t angles;
162         // dlight orientation/scaling/location
163         // (dlight only)
164         matrix4x4_t matrix;
165         // color of light
166         // (worldlight: saved to .rtlights file)
167         vec3_t color;
168         // cubemap name to use on this light
169         // (worldlight: saved to .rtlights file)
170         char cubemapname[64];
171         // make light flash while selected
172         // (worldlight only)
173         int selected;
174         // brightness (not really radius anymore)
175         // (worldlight: saved to .rtlights file)
176         vec_t radius;
177         // drop intensity this much each second
178         // (dlight only)
179         vec_t decay;
180         // intensity value which is dropped over time
181         // (dlight only)
182         vec_t intensity;
183         // initial values for intensity to modify
184         // (dlight only)
185         vec_t initialradius;
186         vec3_t initialcolor;
187         // light style which controls intensity of this light
188         // (worldlight: saved to .rtlights file)
189         int style;
190         // cast shadows
191         // (worldlight: saved to .rtlights file)
192         int shadow;
193         // corona intensity
194         // (worldlight: saved to .rtlights file)
195         vec_t corona;
196         // radius scale of corona to render (1.0 means same as light radius)
197         // (worldlight: saved to .rtlights file)
198         vec_t coronasizescale;
199         // ambient intensity to render
200         // (worldlight: saved to .rtlights file)
201         vec_t ambientscale;
202         // diffuse intensity to render
203         // (worldlight: saved to .rtlights file)
204         vec_t diffusescale;
205         // specular intensity to render
206         // (worldlight: saved to .rtlights file)
207         vec_t specularscale;
208         // LIGHTFLAG_* flags
209         // (worldlight: saved to .rtlights file)
210         int flags;
211         // linked list of world lights
212         // (worldlight only)
213         struct dlight_s *next;
214         // embedded rtlight struct for renderer
215         // (worldlight only)
216         rtlight_t rtlight;
217 }
218 dlight_t;
219
220 typedef struct frameblend_s
221 {
222         int frame;
223         float lerp;
224 }
225 frameblend_t;
226
227 // LordHavoc: this struct is intended for the renderer but some fields are
228 // used by the client.
229 typedef struct entity_render_s
230 {
231         // location
232         //vec3_t origin;
233         // orientation
234         //vec3_t angles;
235         // transform matrix for model to world
236         matrix4x4_t matrix;
237         // transform matrix for world to model
238         matrix4x4_t inversematrix;
239         // opacity (alpha) of the model
240         float alpha;
241         // size the model is shown
242         float scale;
243
244         // NULL = no model
245         model_t *model;
246         // current uninterpolated animation frame (for things which do not use interpolation)
247         int frame;
248         // number of the entity represents, or 0 for non-network entities
249         int entitynumber;
250         // entity shirt and pants colors (-1 if not colormapped)
251         int colormap;
252         // literal colors for renderer
253         vec3_t colormap_pantscolor;
254         vec3_t colormap_shirtcolor;
255         // light, particles, etc
256         int effects;
257         // qw CTF flags and other internal-use-only effect bits
258         int internaleffects;
259         // for Alias models
260         int skinnum;
261         // render flags
262         int flags;
263
264         // colormod tinting of models
265         float colormod[3];
266
267         // interpolated animation
268
269         // frame that the model is interpolating from
270         int frame1;
271         // frame that the model is interpolating to
272         int frame2;
273         // interpolation factor, usually computed from frame2time
274         float framelerp;
275         // time frame1 began playing (for framegroup animations)
276         double frame1time;
277         // time frame2 began playing (for framegroup animations)
278         double frame2time;
279
280         // calculated by the renderer (but not persistent)
281
282         // calculated during R_AddModelEntities
283         vec3_t mins, maxs;
284         // 4 frame numbers (-1 if not used) and their blending scalers (0-1), if interpolation is not desired, use frame instead
285         frameblend_t frameblend[4];
286
287         // current lighting from map
288         vec3_t modellight_ambient;
289         vec3_t modellight_diffuse; // q3bsp
290         vec3_t modellight_lightdir; // q3bsp
291
292         // last time visible during trace culling
293         double last_trace_visibility;
294 }
295 entity_render_t;
296
297 typedef struct entity_persistent_s
298 {
299         vec3_t trail_origin;
300
301         // particle trail
302         float trail_time;
303         qboolean trail_allowed; // set to false by teleports, true by update code, prevents bad lerps
304
305         // muzzleflash fading
306         float muzzleflash;
307
308         // interpolated movement
309
310         // start time of move
311         float lerpstarttime;
312         // time difference from start to end of move
313         float lerpdeltatime;
314         // the move itself, start and end
315         float oldorigin[3];
316         float oldangles[3];
317         float neworigin[3];
318         float newangles[3];
319 }
320 entity_persistent_t;
321
322 typedef struct entity_s
323 {
324         // baseline state (default values)
325         entity_state_t state_baseline;
326         // previous state (interpolating from this)
327         entity_state_t state_previous;
328         // current state (interpolating to this)
329         entity_state_t state_current;
330
331         // used for regenerating parts of render
332         entity_persistent_t persistent;
333
334         // the only data the renderer should know about
335         entity_render_t render;
336 }
337 entity_t;
338
339 typedef struct usercmd_s
340 {
341         vec3_t  viewangles;
342
343 // intended velocities
344         float   forwardmove;
345         float   sidemove;
346         float   upmove;
347
348         vec3_t  cursor_screen;
349         vec3_t  cursor_start;
350         vec3_t  cursor_end;
351         vec3_t  cursor_impact;
352         vec3_t  cursor_normal;
353         vec_t   cursor_fraction;
354         int             cursor_entitynumber;
355
356         double time;
357         double receivetime;
358         int msec; // for qw moves
359         int buttons;
360         int impulse;
361         int sequence;
362         qboolean applied; // if false we're still accumulating a move
363         qboolean predicted; // if true the sequence should be sent as 0
364 } usercmd_t;
365
366 typedef struct lightstyle_s
367 {
368         int             length;
369         char    map[MAX_STYLESTRING];
370 } lightstyle_t;
371
372 typedef struct scoreboard_s
373 {
374         char    name[MAX_SCOREBOARDNAME];
375         int             frags;
376         int             colors; // two 4 bit fields
377         // QW fields:
378         int             qw_userid;
379         char    qw_userinfo[MAX_USERINFO_STRING];
380         float   qw_entertime;
381         int             qw_ping;
382         int             qw_packetloss;
383         int             qw_spectator;
384         char    qw_team[8];
385         char    qw_skin[MAX_QPATH];
386 } scoreboard_t;
387
388 typedef struct cshift_s
389 {
390         float   destcolor[3];
391         float   percent;                // 0-256
392 } cshift_t;
393
394 #define CSHIFT_CONTENTS 0
395 #define CSHIFT_DAMAGE   1
396 #define CSHIFT_BONUS    2
397 #define CSHIFT_POWERUP  3
398 #define CSHIFT_VCSHIFT  4
399 #define NUM_CSHIFTS             5
400
401 #define NAME_LENGTH     64
402
403
404 //
405 // client_state_t should hold all pieces of the client state
406 //
407
408 #define SIGNONS         4                       // signon messages to receive before connected
409
410 #define MAX_DEMOS               8
411 #define MAX_DEMONAME    16
412
413 typedef enum cactive_e
414 {
415         ca_dedicated,           // a dedicated server with no ability to start a client
416         ca_disconnected,        // full screen console with no connection
417         ca_connected            // valid netcon, talking to a server
418 }
419 cactive_t;
420
421 typedef enum qw_downloadtype_e
422 {
423         dl_none,
424         dl_single,
425         dl_skin,
426         dl_model,
427         dl_sound
428 }
429 qw_downloadtype_t;
430
431 typedef enum capturevideoformat_e
432 {
433         CAPTUREVIDEOFORMAT_AVI_I420
434 }
435 capturevideoformat_t;
436
437 typedef struct capturevideostate_s
438 {
439         double starttime;
440         double framerate;
441         // for AVI saving some values have to be written after capture ends
442         fs_offset_t videofile_totalframes_offset1;
443         fs_offset_t videofile_totalframes_offset2;
444         fs_offset_t videofile_totalsampleframes_offset;
445         qfile_t *videofile;
446         qboolean active;
447         qboolean realtime;
448         qboolean error;
449         capturevideoformat_t format;
450         int soundrate;
451         int frame;
452         int soundsampleframe; // for AVI saving
453         unsigned char *buffer;
454         sizebuf_t riffbuffer;
455         unsigned char riffbufferdata[128];
456         // note: riffindex buffer has an allocated ->data member, not static like most!
457         sizebuf_t riffindexbuffer;
458         int riffstacklevel;
459         fs_offset_t riffstackstartoffset[4];
460         short rgbtoyuvscaletable[3][3][256];
461         unsigned char yuvnormalizetable[3][256];
462         char basename[64];
463 }
464 capturevideostate_t;
465
466 #define CL_MAX_DOWNLOADACKS 4
467
468 typedef struct cl_downloadack_s
469 {
470         int start, size;
471 }
472 cl_downloadack_t;
473
474 //
475 // the client_static_t structure is persistent through an arbitrary number
476 // of server connections
477 //
478 typedef struct client_static_s
479 {
480         cactive_t state;
481
482         // all client memory allocations go in these pools
483         mempool_t *levelmempool;
484         mempool_t *permanentmempool;
485
486 // demo loop control
487         // -1 = don't play demos
488         int demonum;
489         // list of demos in loop
490         char demos[MAX_DEMOS][MAX_DEMONAME];
491         // the actively playing demo (set by CL_PlayDemo_f)
492         char demoname[64];
493
494 // demo recording info must be here, because record is started before
495 // entering a map (and clearing client_state_t)
496         qboolean demorecording;
497         qboolean demoplayback;
498         qboolean timedemo;
499         // -1 = use normal cd track
500         int forcetrack;
501         qfile_t *demofile;
502         // to meter out one message a frame
503         int td_lastframe;
504         // host_framecount at start
505         int td_startframe;
506         // realtime at second frame of timedemo (LordHavoc: changed to double)
507         double td_starttime;
508         double td_onesecondnexttime;
509         double td_onesecondframes;
510         double td_onesecondminframes;
511         double td_onesecondmaxframes;
512         double td_onesecondavgframes;
513         int td_onesecondavgcount;
514         // LordHavoc: pausedemo
515         qboolean demopaused;
516
517         qboolean connect_trying;
518         int connect_remainingtries;
519         double connect_nextsendtime;
520         lhnetsocket_t *connect_mysocket;
521         lhnetaddress_t connect_address;
522         // protocol version of the server we're connected to
523         // (kept outside client_state_t because it's used between levels)
524         protocolversion_t protocol;
525
526 // connection information
527         // 0 to SIGNONS
528         int signon;
529         // network connection
530         netconn_t *netcon;
531
532         // download information
533         // (note: qw_download variables are also used)
534         cl_downloadack_t dp_downloadack[CL_MAX_DOWNLOADACKS];
535
536         // input sequence numbers are not reset on level change, only connect
537         int movesequence;
538         int servermovesequence;
539
540         // quakeworld stuff below
541
542         // value of "qport" cvar at time of connection
543         int qw_qport;
544         // copied from cls.netcon->qw. variables every time they change, or set by demos (which have no cls.netcon)
545         int qw_incoming_sequence;
546         int qw_outgoing_sequence;
547
548         // current file download buffer (only saved when file is completed)
549         char qw_downloadname[MAX_QPATH];
550         unsigned char *qw_downloadmemory;
551         int qw_downloadmemorycursize;
552         int qw_downloadmemorymaxsize;
553         int qw_downloadnumber;
554         int qw_downloadpercent;
555         qw_downloadtype_t qw_downloadtype;
556         // transfer rate display
557         double qw_downloadspeedtime;
558         int qw_downloadspeedcount;
559         int qw_downloadspeedrate;
560
561         // current file upload buffer (for uploading screenshots to server)
562         unsigned char *qw_uploaddata;
563         int qw_uploadsize;
564         int qw_uploadpos;
565
566         // user infostring
567         // this normally contains the following keys in quakeworld:
568         // password spectator name team skin topcolor bottomcolor rate noaim msg *ver *ip
569         char userinfo[MAX_USERINFO_STRING];
570
571         // video capture stuff
572         capturevideostate_t capturevideo;
573 }
574 client_static_t;
575
576 extern client_static_t  cls;
577
578 typedef struct client_movementqueue_s
579 {
580         double time;
581         float frametime;
582         int sequence;
583         float viewangles[3];
584         float move[3];
585         qboolean jump;
586         qboolean crouch;
587         qboolean canjump;
588 }
589 client_movementqueue_t;
590
591 //[515]: csqc
592 typedef struct
593 {
594         qboolean drawworld;
595         qboolean drawenginesbar;
596         qboolean drawcrosshair;
597 }csqc_vidvars_t;
598
599 typedef enum
600 {
601         PARTICLE_BILLBOARD = 0,
602         PARTICLE_SPARK = 1,
603         PARTICLE_ORIENTED_DOUBLESIDED = 2,
604         PARTICLE_BEAM = 3
605 }
606 porientation_t;
607
608 typedef enum
609 {
610         PBLEND_ALPHA = 0,
611         PBLEND_ADD = 1,
612         PBLEND_MOD = 2
613 }
614 pblend_t;
615
616 typedef struct particletype_s
617 {
618         pblend_t blendmode;
619         porientation_t orientation;
620         qboolean lighting;
621 }
622 particletype_t;
623
624 typedef enum
625 {
626         pt_alphastatic, pt_static, pt_spark, pt_beam, pt_rain, pt_raindecal, pt_snow, pt_bubble, pt_blood, pt_smoke, pt_decal, pt_entityparticle, pt_total
627 }
628 ptype_t;
629
630 typedef struct particle_s
631 {
632         particletype_t *type;
633         int                     texnum;
634         vec3_t          org;
635         vec3_t          vel; // velocity of particle, or orientation of decal, or end point of beam
636         float           size;
637         float           sizeincrease; // rate of size change per second
638         float           alpha; // 0-255
639         float           alphafade; // how much alpha reduces per second
640         float           time2; // used for snow fluttering and decal fade
641         float           bounce; // how much bounce-back from a surface the particle hits (0 = no physics, 1 = stop and slide, 2 = keep bouncing forever, 1.5 is typical)
642         float           gravity; // how much gravity affects this particle (1.0 = normal gravity, 0.0 = none)
643         float           airfriction; // how much air friction affects this object (objects with a low mass/size ratio tend to get more air friction)
644         float           liquidfriction; // how much liquid friction affects this object (objects with a low mass/size ratio tend to get more liquid friction)
645         unsigned char           color[4];
646         unsigned int            owner; // decal stuck to this entity
647         model_t         *ownermodel; // model the decal is stuck to (used to make sure the entity is still alive)
648         vec3_t          relativeorigin; // decal at this location in entity's coordinate space
649         vec3_t          relativedirection; // decal oriented this way relative to entity's coordinate space
650         float           delayedcollisions; // time that p->bounce becomes active
651         float           delayedspawn; // time that particle appears and begins moving
652         float           die; // time when this particle should be removed, regardless of alpha
653 }
654 particle_t;
655
656 typedef enum cl_parsingtextmode_e
657 {
658         CL_PARSETEXTMODE_NONE,
659         CL_PARSETEXTMODE_PING,
660         CL_PARSETEXTMODE_STATUS,
661         CL_PARSETEXTMODE_STATUS_PLAYERID,
662         CL_PARSETEXTMODE_STATUS_PLAYERIP
663 }
664 cl_parsingtextmode_t;
665
666 typedef struct cl_locnode_s
667 {
668         struct cl_locnode_s *next;
669         char *name;
670         vec3_t mins, maxs;
671 }
672 cl_locnode_t;
673
674 //
675 // the client_state_t structure is wiped completely at every
676 // server signon
677 //
678 typedef struct client_state_s
679 {
680         // true if playing in a local game and no one else is connected
681         int islocalgame;
682
683         // send a clc_nop periodically until connected
684         float sendnoptime;
685
686         // current input being accumulated by mouse/joystick/etc input
687         usercmd_t cmd;
688         // latest moves sent to the server that have not been confirmed yet
689         usercmd_t movecmd[CL_MAX_USERCMDS];
690
691 // information for local display
692         // health, etc
693         int stats[MAX_CL_STATS];
694         float *statsf; // points to stats[] array
695         // last known inventory bit flags, for blinking
696         int olditems;
697         // cl.time of acquiring item, for blinking
698         float item_gettime[32];
699         // last known STAT_ACTIVEWEAPON
700         int activeweapon;
701         // cl.time of changing STAT_ACTIVEWEAPON
702         float weapontime;
703         // use pain anim frame if cl.time < this
704         float faceanimtime;
705         // for stair smoothing
706         float stairsmoothz;
707         double stairsmoothtime;
708
709         // color shifts for damage, powerups
710         cshift_t cshifts[NUM_CSHIFTS];
711         // and content types
712         cshift_t prev_cshifts[NUM_CSHIFTS];
713
714 // the client maintains its own idea of view angles, which are
715 // sent to the server each frame.  The server sets punchangle when
716 // the view is temporarily offset, and an angle reset commands at the start
717 // of each level and after teleporting.
718
719         // mviewangles is read from demo
720         // viewangles is either client controlled or lerped from mviewangles
721         vec3_t mviewangles[2], viewangles;
722         // update by server, used by qc to do weapon recoil
723         vec3_t mpunchangle[2], punchangle;
724         // update by server, can be used by mods to kick view around
725         vec3_t mpunchvector[2], punchvector;
726         // update by server, used for lean+bob (0 is newest)
727         vec3_t mvelocity[2], velocity;
728         // update by server, can be used by mods for zooming
729         vec_t mviewzoom[2], viewzoom;
730         // if true interpolation the mviewangles and other interpolation of the
731         // player is disabled until the next network packet
732         // this is used primarily by teleporters, and when spectating players
733         // special checking of the old fixangle[1] is used to differentiate
734         // between teleporting and spectating
735         qboolean fixangle[2];
736
737         // client movement simulation
738         // these fields are only updated by CL_ClientMovement (called by CL_SendMove after parsing each network packet)
739         // set by CL_ClientMovement_Replay functions
740         qboolean movement_predicted;
741         // if true the CL_ClientMovement_Replay function will update origin, etc
742         qboolean movement_replay;
743         // this is set true by svc_time parsing and causes a new movement to be
744         // queued for prediction purposes
745         qboolean movement_needupdate;
746         // timestamps of latest two predicted moves for interpolation
747         double movement_time[4];
748         // simulated data (this is valid even if cl.movement is false)
749         vec3_t movement_origin;
750         vec3_t movement_oldorigin;
751         vec3_t movement_velocity;
752         // queue of proposed moves
753         int movement_numqueue;
754         client_movementqueue_t movement_queue[256];
755         // whether the replay should allow a jump at the first sequence
756         qboolean movement_replay_canjump;
757
758 // pitch drifting vars
759         float idealpitch;
760         float pitchvel;
761         qboolean nodrift;
762         float driftmove;
763         double laststop;
764
765 //[515]: added for csqc purposes
766         float sensitivityscale;
767         csqc_vidvars_t csqc_vidvars;    //[515]: these parms must be set to true by default
768         qboolean csqc_wantsmousemove;
769         struct model_s *csqc_model_precache[MAX_MODELS];
770
771         // local amount for smoothing stepups
772         //float crouch;
773
774         // sent by server
775         qboolean paused;
776         qboolean onground;
777         qboolean inwater;
778
779         // used by bob
780         qboolean oldonground;
781         double lastongroundtime;
782         double hitgroundtime;
783
784         // don't change view angle, full screen, etc
785         int intermission;
786         // latched at intermission start
787         double completed_time;
788
789         // the timestamp of the last two messages
790         double mtime[2];
791
792         // clients view of time, time should be between mtime[0] and mtime[1] to
793         // generate a lerp point for other data, oldtime is the previous frame's
794         // value of time, frametime is the difference between time and oldtime
795         // note: cl.time may be beyond cl.mtime[0] if packet loss is occuring, it
796         // is only forcefully limited when a packet is received
797         double time, oldtime;
798         // how long it has been since the previous client frame in real time
799         // (not game time, for that use cl.time - cl.oldtime)
800         double realframetime;
801
802         // copy of realtime from last recieved message, for net trouble icon
803         float last_received_message;
804
805 // information that is static for the entire time connected to a server
806         struct model_s *model_precache[MAX_MODELS];
807         struct sfx_s *sound_precache[MAX_SOUNDS];
808
809         // FIXME: this is a lot of memory to be keeping around, this really should be dynamically allocated and freed somehow
810         char model_name[MAX_MODELS][MAX_QPATH];
811         char sound_name[MAX_SOUNDS][MAX_QPATH];
812
813         // for display on solo scoreboard
814         char levelname[40];
815         // cl_entitites[cl.viewentity] = player
816         int viewentity;
817         // the real player entity (normally same as viewentity,
818         // different than viewentity if mod uses chasecam or other tricks)
819         int playerentity;
820         // max players that can be in this game
821         int maxclients;
822         // type of game (deathmatch, coop, singleplayer)
823         int gametype;
824
825         // models and sounds used by engine code (particularly cl_parse.c)
826         model_t *model_bolt;
827         model_t *model_bolt2;
828         model_t *model_bolt3;
829         model_t *model_beam;
830         sfx_t *sfx_wizhit;
831         sfx_t *sfx_knighthit;
832         sfx_t *sfx_tink1;
833         sfx_t *sfx_ric1;
834         sfx_t *sfx_ric2;
835         sfx_t *sfx_ric3;
836         sfx_t *sfx_r_exp3;
837         // indicates that the file "sound/misc/talk2.wav" was found (for use by team chat messages)
838         qboolean foundtalk2wav;
839
840 // refresh related state
841
842         // cl_entitites[0].model
843         struct model_s *worldmodel;
844
845         // the gun model
846         entity_t viewent;
847
848         // cd audio
849         int cdtrack, looptrack;
850
851 // frag scoreboard
852
853         // [cl.maxclients]
854         scoreboard_t *scores;
855
856         // keep track of svc_print parsing state (analyzes ping reports and status reports)
857         cl_parsingtextmode_t parsingtextmode;
858         int parsingtextplayerindex;
859         // set by scoreboard code when sending ping command, this causes the next ping results to be hidden
860         // (which could eat the wrong ping report if the player issues one
861         //  manually, but they would still see a ping report, just a later one
862         //  caused by the scoreboard code rather than the one they intentionally
863         //  issued)
864         int parsingtextexpectingpingforscores;
865
866         // entity database stuff
867         // latest received entity frame numbers
868 #define LATESTFRAMENUMS 3
869         int latestframenums[LATESTFRAMENUMS];
870         entityframe_database_t *entitydatabase;
871         entityframe4_database_t *entitydatabase4;
872         entityframeqw_database_t *entitydatabaseqw;
873
874         // keep track of quake entities because they need to be killed if they get stale
875         int lastquakeentity;
876         unsigned char isquakeentity[MAX_EDICTS];
877
878         // bounding boxes for clientside movement
879         vec3_t playerstandmins;
880         vec3_t playerstandmaxs;
881         vec3_t playercrouchmins;
882         vec3_t playercrouchmaxs;
883
884         int max_entities;
885         int max_static_entities;
886         int max_temp_entities;
887         int max_effects;
888         int max_beams;
889         int max_dlights;
890         int max_lightstyle;
891         int max_brushmodel_entities;
892         int max_particles;
893
894         entity_t *entities;
895         unsigned char *entities_active;
896         entity_t *static_entities;
897         entity_t *temp_entities;
898         cl_effect_t *effects;
899         beam_t *beams;
900         dlight_t *dlights;
901         lightstyle_t *lightstyle;
902         int *brushmodel_entities;
903         particle_t *particles;
904
905         int num_entities;
906         int num_static_entities;
907         int num_temp_entities;
908         int num_brushmodel_entities;
909         int num_effects;
910         int num_beams;
911         int num_dlights;
912         int num_particles;
913
914         int free_particle;
915
916         // cl_serverextension_download feature
917         int loadmodel_current;
918         int downloadmodel_current;
919         int loadmodel_total;
920         int loadsound_current;
921         int downloadsound_current;
922         int loadsound_total;
923         qboolean downloadcsqc;
924         qboolean loadbegun;
925         qboolean loadfinished;
926
927         // quakeworld stuff
928
929         // local copy of the server infostring
930         char qw_serverinfo[MAX_SERVERINFO_STRING];
931
932         // time of last qw "pings" command sent to server while showing scores
933         double last_ping_request;
934
935         // used during connect
936         int qw_servercount;
937
938         // updated from serverinfo
939         int qw_teamplay;
940
941         // unused: indicates whether the player is spectating
942         // use cl.scores[cl.playerentity].qw_spectator instead
943         //qboolean qw_spectator;
944
945         // movement parameters for client prediction
946         float movevars_ticrate;
947         float movevars_slowmo;
948         float movevars_gravity;
949         float movevars_stopspeed;
950         float movevars_maxspeed;
951         float movevars_spectatormaxspeed;
952         float movevars_accelerate;
953         float movevars_airaccelerate;
954         float movevars_wateraccelerate;
955         float movevars_friction;
956         float movevars_waterfriction;
957         float movevars_entgravity;
958         float movevars_jumpvelocity;
959         float movevars_edgefriction;
960         float movevars_maxairspeed;
961         float movevars_stepheight;
962         float movevars_airaccel_qw;
963         float movevars_airaccel_sideways_friction;
964
965         // models used by qw protocol
966         int qw_modelindex_spike;
967         int qw_modelindex_player;
968         int qw_modelindex_flag;
969         int qw_modelindex_s_explod;
970
971         vec3_t qw_intermission_origin;
972         vec3_t qw_intermission_angles;
973
974         // 255 is the most nails the QW protocol could send
975         int qw_num_nails;
976         vec_t qw_nails[255][6];
977
978         float qw_weaponkick;
979
980         int qw_validsequence;
981
982         int qw_deltasequence[QW_UPDATE_BACKUP];
983
984         // csqc stuff:
985         // server entity number corresponding to a clientside entity
986         unsigned short csqc_server2csqcentitynumber[MAX_EDICTS];
987         qboolean csqc_loaded;
988         vec3_t csqc_origin;
989         vec3_t csqc_angles;
990         qboolean csqc_usecsqclistener;
991         matrix4x4_t csqc_listenermatrix;
992         char csqc_printtextbuf[MAX_INPUTLINE];
993
994         // collision culling data
995         world_t world;
996
997         // loc file stuff (points and boxes describing locations in the level)
998         cl_locnode_t *locnodes;
999         // this is updated to cl.movement_origin whenever health is < 1
1000         // used by %d print in say/say_team messages if cl_locs_enable is on
1001         vec3_t lastdeathorigin;
1002 }
1003 client_state_t;
1004
1005 //
1006 // cvars
1007 //
1008 extern cvar_t cl_name;
1009 extern cvar_t cl_color;
1010 extern cvar_t cl_rate;
1011 extern cvar_t cl_pmodel;
1012 extern cvar_t cl_playermodel;
1013 extern cvar_t cl_playerskin;
1014
1015 extern cvar_t rcon_password;
1016 extern cvar_t rcon_address;
1017
1018 extern cvar_t cl_upspeed;
1019 extern cvar_t cl_forwardspeed;
1020 extern cvar_t cl_backspeed;
1021 extern cvar_t cl_sidespeed;
1022
1023 extern cvar_t cl_movespeedkey;
1024
1025 extern cvar_t cl_yawspeed;
1026 extern cvar_t cl_pitchspeed;
1027
1028 extern cvar_t cl_anglespeedkey;
1029
1030 extern cvar_t cl_autofire;
1031
1032 extern cvar_t cl_shownet;
1033 extern cvar_t cl_nolerp;
1034 extern cvar_t cl_nettimesyncfactor;
1035 extern cvar_t cl_nettimesyncboundmode;
1036 extern cvar_t cl_nettimesyncboundtolerance;
1037
1038 extern cvar_t cl_pitchdriftspeed;
1039 extern cvar_t lookspring;
1040 extern cvar_t lookstrafe;
1041 extern cvar_t sensitivity;
1042
1043 extern cvar_t freelook;
1044
1045 extern cvar_t m_pitch;
1046 extern cvar_t m_yaw;
1047 extern cvar_t m_forward;
1048 extern cvar_t m_side;
1049
1050 extern cvar_t cl_autodemo;
1051 extern cvar_t cl_autodemo_nameformat;
1052
1053 extern cvar_t r_draweffects;
1054
1055 extern cvar_t cl_explosions_alpha_start;
1056 extern cvar_t cl_explosions_alpha_end;
1057 extern cvar_t cl_explosions_size_start;
1058 extern cvar_t cl_explosions_size_end;
1059 extern cvar_t cl_explosions_lifetime;
1060 extern cvar_t cl_stainmaps;
1061 extern cvar_t cl_stainmaps_clearonload;
1062
1063 extern cvar_t cl_prydoncursor;
1064
1065 extern cvar_t cl_locs_enable;
1066
1067 extern client_state_t cl;
1068
1069 extern void CL_AllocLightFlash (entity_render_t *ent, matrix4x4_t *matrix, float radius, float red, float green, float blue, float decay, float lifetime, int cubemapnum, int style, int shadowenable, vec_t corona, vec_t coronasizescale, vec_t ambientscale, vec_t diffusescale, vec_t specularscale, int flags);
1070
1071 cl_locnode_t *CL_Locs_FindNearest(const vec3_t point);
1072 void CL_Locs_FindLocationName(char *buffer, size_t buffersize, vec3_t point);
1073
1074 //=============================================================================
1075
1076 //
1077 // cl_main
1078 //
1079
1080 void CL_Shutdown (void);
1081 void CL_Init (void);
1082
1083 void CL_EstablishConnection(const char *host);
1084
1085 void CL_Disconnect (void);
1086 void CL_Disconnect_f (void);
1087
1088 void CL_UpdateRenderEntity(entity_render_t *ent);
1089 void CL_UpdateViewEntities(void);
1090
1091 //
1092 // cl_input
1093 //
1094 typedef struct kbutton_s
1095 {
1096         int             down[2];                // key nums holding it down
1097         int             state;                  // low bit is down state
1098 }
1099 kbutton_t;
1100
1101 extern  kbutton_t       in_mlook, in_klook;
1102 extern  kbutton_t       in_strafe;
1103 extern  kbutton_t       in_speed;
1104
1105 void CL_InitInput (void);
1106 void CL_SendMove (void);
1107
1108 void CL_ValidateState(entity_state_t *s);
1109 void CL_MoveLerpEntityStates(entity_t *ent);
1110 void CL_LerpUpdate(entity_t *e);
1111 void CL_ParseTEnt (void);
1112 void CL_NewBeam (int ent, vec3_t start, vec3_t end, model_t *m, int lightning);
1113 void CL_RelinkBeams (void);
1114 void CL_Beam_CalculatePositions (const beam_t *b, vec3_t start, vec3_t end);
1115 void CL_ClientMovement_Replay(void);
1116
1117 void CL_ClearTempEntities (void);
1118 entity_t *CL_NewTempEntity (void);
1119
1120 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
1121
1122 void CL_ClearState (void);
1123 void CL_ExpandEntities(int num);
1124 void CL_SetInfo(const char *key, const char *value, qboolean send, qboolean allowstarkey, qboolean allowmodel, qboolean quiet);
1125
1126
1127 void CL_UpdateWorld (void);
1128 void CL_WriteToServer (void);
1129 void CL_Input (void);
1130 extern qboolean cl_ignoremousemove;
1131
1132
1133 float CL_KeyState (kbutton_t *key);
1134 const char *Key_KeynumToString (int keynum);
1135 int Key_StringToKeynum (const char *str);
1136
1137 //
1138 // cl_demo.c
1139 //
1140 void CL_StopPlayback(void);
1141 void CL_ReadDemoMessage(void);
1142 void CL_WriteDemoMessage(sizebuf_t *mesage);
1143
1144 void CL_NextDemo(void);
1145 void CL_Stop_f(void);
1146 void CL_Record_f(void);
1147 void CL_PlayDemo_f(void);
1148 void CL_TimeDemo_f(void);
1149
1150 //
1151 // cl_parse.c
1152 //
1153 void CL_Parse_Init(void);
1154 void CL_Parse_Shutdown(void);
1155 void CL_ParseServerMessage(void);
1156 void CL_Parse_DumpPacket(void);
1157 void CL_Parse_ErrorCleanUp(void);
1158 void QW_CL_StartUpload(unsigned char *data, int size);
1159 extern cvar_t qport;
1160
1161 //
1162 // view
1163 //
1164 void V_StartPitchDrift (void);
1165 void V_StopPitchDrift (void);
1166
1167 void V_Init (void);
1168 float V_CalcRoll (vec3_t angles, vec3_t velocity);
1169 void V_UpdateBlends (void);
1170 void V_ParseDamage (void);
1171
1172 //
1173 // cl_part
1174 //
1175
1176 extern cvar_t cl_particles;
1177 extern cvar_t cl_particles_quality;
1178 extern cvar_t cl_particles_size;
1179 extern cvar_t cl_particles_quake;
1180 extern cvar_t cl_particles_blood;
1181 extern cvar_t cl_particles_blood_alpha;
1182 extern cvar_t cl_particles_blood_bloodhack;
1183 extern cvar_t cl_particles_bulletimpacts;
1184 extern cvar_t cl_particles_explosions_smoke;
1185 extern cvar_t cl_particles_explosions_sparks;
1186 extern cvar_t cl_particles_explosions_shell;
1187 extern cvar_t cl_particles_rain;
1188 extern cvar_t cl_particles_snow;
1189 extern cvar_t cl_particles_smoke;
1190 extern cvar_t cl_particles_smoke_alpha;
1191 extern cvar_t cl_particles_smoke_alphafade;
1192 extern cvar_t cl_particles_sparks;
1193 extern cvar_t cl_particles_bubbles;
1194 extern cvar_t cl_decals;
1195 extern cvar_t cl_decals_time;
1196 extern cvar_t cl_decals_fadetime;
1197
1198 void CL_Particles_Clear(void);
1199 void CL_Particles_Init(void);
1200 void CL_Particles_Shutdown(void);
1201
1202 typedef enum effectnameindex_s
1203 {
1204         EFFECT_NONE,
1205         EFFECT_TE_GUNSHOT,
1206         EFFECT_TE_GUNSHOTQUAD,
1207         EFFECT_TE_SPIKE,
1208         EFFECT_TE_SPIKEQUAD,
1209         EFFECT_TE_SUPERSPIKE,
1210         EFFECT_TE_SUPERSPIKEQUAD,
1211         EFFECT_TE_WIZSPIKE,
1212         EFFECT_TE_KNIGHTSPIKE,
1213         EFFECT_TE_EXPLOSION,
1214         EFFECT_TE_EXPLOSIONQUAD,
1215         EFFECT_TE_TAREXPLOSION,
1216         EFFECT_TE_TELEPORT,
1217         EFFECT_TE_LAVASPLASH,
1218         EFFECT_TE_SMALLFLASH,
1219         EFFECT_TE_FLAMEJET,
1220         EFFECT_EF_FLAME,
1221         EFFECT_TE_BLOOD,
1222         EFFECT_TE_SPARK,
1223         EFFECT_TE_PLASMABURN,
1224         EFFECT_TE_TEI_G3,
1225         EFFECT_TE_TEI_SMOKE,
1226         EFFECT_TE_TEI_BIGEXPLOSION,
1227         EFFECT_TE_TEI_PLASMAHIT,
1228         EFFECT_EF_STARDUST,
1229         EFFECT_TR_ROCKET,
1230         EFFECT_TR_GRENADE,
1231         EFFECT_TR_BLOOD,
1232         EFFECT_TR_WIZSPIKE,
1233         EFFECT_TR_SLIGHTBLOOD,
1234         EFFECT_TR_KNIGHTSPIKE,
1235         EFFECT_TR_VORESPIKE,
1236         EFFECT_TR_NEHAHRASMOKE,
1237         EFFECT_TR_NEXUIZPLASMA,
1238         EFFECT_TR_GLOWTRAIL,
1239         EFFECT_SVC_PARTICLE,
1240         EFFECT_TOTAL
1241 }
1242 effectnameindex_t;
1243
1244 int CL_ParticleEffectIndexForName(const char *name);
1245 const char *CL_ParticleEffectNameForIndex(int i);
1246 void CL_ParticleEffect(int effectindex, float pcount, const vec3_t originmins, const vec3_t originmaxs, const vec3_t velocitymins, const vec3_t velocitymaxs, entity_t *ent, int palettecolor);
1247 void CL_ParticleTrail(int effectindex, float pcount, const vec3_t originmins, const vec3_t originmaxs, const vec3_t velocitymins, const vec3_t velocitymaxs, entity_t *ent, int palettecolor, qboolean spawndlight, qboolean spawnparticles);
1248 void CL_ParseParticleEffect (void);
1249 void CL_ParticleCube (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, vec_t gravity, vec_t randomvel);
1250 void CL_ParticleRain (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, int type);
1251 void CL_EntityParticles (const entity_t *ent);
1252 void CL_ParticleExplosion (const vec3_t org);
1253 void CL_ParticleExplosion2 (const vec3_t org, int colorStart, int colorLength);
1254 void CL_MoveParticles(void);
1255 void R_MoveExplosions(void);
1256 void R_NewExplosion(const vec3_t org);
1257
1258 void Debug_PolygonBegin(const char *picname, int flags, qboolean draw2d, float linewidth);
1259 void Debug_PolygonVertex(float x, float y, float z, float s, float t, float r, float g, float b, float a);
1260 void Debug_PolygonEnd(void);
1261
1262 #include "cl_screen.h"
1263
1264 extern qboolean sb_showscores;
1265
1266 #define NUMCROSSHAIRS 32
1267 extern cachepic_t *r_crosshairs[NUMCROSSHAIRS+1];
1268
1269 float FogPoint_World(const vec3_t p);
1270 float FogPoint_Model(const vec3_t p);
1271
1272 typedef struct r_refdef_stats_s
1273 {
1274         int entities;
1275         int entities_surfaces;
1276         int entities_triangles;
1277         int world_leafs;
1278         int world_portals;
1279         int particles;
1280         int meshes;
1281         int meshes_elements;
1282         int lights;
1283         int lights_clears;
1284         int lights_scissored;
1285         int lights_lighttriangles;
1286         int lights_shadowtriangles;
1287         int lights_dynamicshadowtriangles;
1288         int bloom;
1289         int bloom_copypixels;
1290         int bloom_drawpixels;
1291 }
1292 r_refdef_stats_t;
1293
1294 typedef struct r_refdef_s
1295 {
1296         // these fields define the basic rendering information for the world
1297         // but not the view, which could change multiple times in one rendered
1298         // frame (for example when rendering textures for certain effects)
1299
1300         // these are set for water warping before
1301         // frustum_x/frustum_y are calculated
1302         float frustumscale_x, frustumscale_y;
1303
1304         // minimum visible distance (pixels closer than this disappear)
1305         double nearclip;
1306         // maximum visible distance (pixels further than this disappear in 16bpp modes,
1307         // in 32bpp an infinite-farclip matrix is used instead)
1308         double farclip;
1309
1310         // fullscreen color blend
1311         float viewblend[4];
1312
1313         // whether to call S_ExtraUpdate during render to reduce sound chop
1314         qboolean extraupdate;
1315
1316         // client gameworld time for rendering time based effects
1317         double time;
1318
1319         // the world
1320         entity_render_t *worldentity;
1321
1322         // same as worldentity->model
1323         model_t *worldmodel;
1324
1325         // renderable entities (excluding world)
1326         entity_render_t **entities;
1327         int numentities;
1328         int maxentities;
1329
1330         // renderable dynamic lights
1331         rtlight_t lights[MAX_DLIGHTS];
1332         int numlights;
1333
1334         // 8.8bit fixed point intensities for light styles
1335         // controls intensity of dynamic lights and lightmap layers
1336         unsigned short  lightstylevalue[256];   // 8.8 fraction of base light value
1337
1338         vec3_t fogcolor;
1339         vec_t fogrange;
1340         vec_t fograngerecip;
1341         vec_t fogmasktabledistmultiplier;
1342 #define FOGMASKTABLEWIDTH 1024
1343         float fogmasktable[FOGMASKTABLEWIDTH];
1344         float fog_density;
1345         float fog_red;
1346         float fog_green;
1347         float fog_blue;
1348         qboolean fogenabled;
1349         qboolean oldgl_fogenable;
1350
1351         qboolean draw2dstage;
1352
1353         // true during envmap command capture
1354         qboolean envmap;
1355
1356         // brightness of world lightmaps and related lighting
1357         // (often reduced when world rtlights are enabled)
1358         float lightmapintensity;
1359         // whether to draw world lights realtime, dlights realtime, and their shadows
1360         qboolean rtworld;
1361         qboolean rtworldshadows;
1362         qboolean rtdlight;
1363         qboolean rtdlightshadows;
1364         float polygonfactor;
1365         float polygonoffset;
1366         float shadowpolygonfactor;
1367         float shadowpolygonoffset;
1368
1369         // rendering stats for r_speeds display
1370         // (these are incremented in many places)
1371         r_refdef_stats_t stats;
1372 }
1373 r_refdef_t;
1374
1375 typedef struct r_view_s
1376 {
1377         // view information (changes multiple times per frame)
1378         // if any of these variables change then r_viewcache must be regenerated
1379         // by calling R_View_Update
1380         // (which also updates viewport, scissor, colormask)
1381
1382         // it is safe and expected to copy this into a structure on the stack and
1383         // call the renderer recursively, then restore from the stack afterward
1384         // (as long as R_View_Update is called)
1385
1386         // eye position information
1387         matrix4x4_t matrix;
1388         vec3_t origin;
1389         vec3_t forward;
1390         vec3_t left;
1391         vec3_t right;
1392         vec3_t up;
1393         mplane_t frustum[5];
1394         float frustum_x, frustum_y;
1395         vec3_t frustumcorner[4];
1396
1397         // screen area to render in
1398         int x;
1399         int y;
1400         int z;
1401         int width;
1402         int height;
1403         int depth;
1404
1405         // which color components to allow (for anaglyph glasses)
1406         int colormask[4];
1407
1408         // global RGB color multiplier for rendering, this is required by HDR
1409         float colorscale;
1410 }
1411 r_view_t;
1412
1413 typedef struct r_viewcache_s
1414 {
1415         // these properties are generated by R_View_Update()
1416
1417         // which entities are currently visible for this viewpoint
1418         // (the used range is 0...r_refdef.numentities)
1419         unsigned char entityvisible[MAX_EDICTS];
1420         // flag arrays used for visibility checking on world model
1421         // (all other entities have no per-surface/per-leaf visibility checks)
1422         // TODO: dynamic resize according to r_refdef.worldmodel->brush.num_clusters
1423         unsigned char world_pvsbits[(32768+7)>>3];
1424         // TODO: dynamic resize according to r_refdef.worldmodel->brush.num_leafs
1425         unsigned char world_leafvisible[32768];
1426         // TODO: dynamic resize according to r_refdef.worldmodel->num_surfaces
1427         unsigned char world_surfacevisible[262144];
1428         // if true, the view is currently in a leaf without pvs data
1429         qboolean world_novis;
1430 }
1431 r_viewcache_t;
1432
1433 extern r_refdef_t r_refdef;
1434 extern r_view_t r_view;
1435 extern r_viewcache_t r_viewcache;
1436
1437 #endif
1438