significant cleanup of input networking code (reorganized and now uses
[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
304         // muzzleflash fading
305         float muzzleflash;
306
307         // interpolated movement
308
309         // start time of move
310         float lerpstarttime;
311         // time difference from start to end of move
312         float lerpdeltatime;
313         // the move itself, start and end
314         float oldorigin[3];
315         float oldangles[3];
316         float neworigin[3];
317         float newangles[3];
318 }
319 entity_persistent_t;
320
321 typedef struct entity_s
322 {
323         // baseline state (default values)
324         entity_state_t state_baseline;
325         // previous state (interpolating from this)
326         entity_state_t state_previous;
327         // current state (interpolating to this)
328         entity_state_t state_current;
329
330         // used for regenerating parts of render
331         entity_persistent_t persistent;
332
333         // the only data the renderer should know about
334         entity_render_t render;
335 }
336 entity_t;
337
338 typedef struct usercmd_s
339 {
340         vec3_t  viewangles;
341
342 // intended velocities
343         float   forwardmove;
344         float   sidemove;
345         float   upmove;
346
347         vec3_t  cursor_screen;
348         vec3_t  cursor_start;
349         vec3_t  cursor_end;
350         vec3_t  cursor_impact;
351         vec3_t  cursor_normal;
352         vec_t   cursor_fraction;
353         int             cursor_entitynumber;
354
355         double time;
356         double receivetime;
357         int msec; // for qw moves
358         int buttons;
359         int impulse;
360         int sequence;
361         qboolean applied; // if false we're still accumulating a move
362         qboolean predicted; // if true the sequence should be sent as 0
363 } usercmd_t;
364
365 typedef struct lightstyle_s
366 {
367         int             length;
368         char    map[MAX_STYLESTRING];
369 } lightstyle_t;
370
371 typedef struct scoreboard_s
372 {
373         char    name[MAX_SCOREBOARDNAME];
374         int             frags;
375         int             colors; // two 4 bit fields
376         // QW fields:
377         int             qw_userid;
378         char    qw_userinfo[MAX_USERINFO_STRING];
379         float   qw_entertime;
380         int             qw_ping;
381         int             qw_packetloss;
382         int             qw_spectator;
383         char    qw_team[8];
384         char    qw_skin[MAX_QPATH];
385 } scoreboard_t;
386
387 typedef struct cshift_s
388 {
389         float   destcolor[3];
390         float   percent;                // 0-256
391 } cshift_t;
392
393 #define CSHIFT_CONTENTS 0
394 #define CSHIFT_DAMAGE   1
395 #define CSHIFT_BONUS    2
396 #define CSHIFT_POWERUP  3
397 #define CSHIFT_VCSHIFT  4
398 #define NUM_CSHIFTS             5
399
400 #define NAME_LENGTH     64
401
402
403 //
404 // client_state_t should hold all pieces of the client state
405 //
406
407 #define SIGNONS         4                       // signon messages to receive before connected
408
409 #define MAX_DEMOS               8
410 #define MAX_DEMONAME    16
411
412 typedef enum cactive_e
413 {
414         ca_dedicated,           // a dedicated server with no ability to start a client
415         ca_disconnected,        // full screen console with no connection
416         ca_connected            // valid netcon, talking to a server
417 }
418 cactive_t;
419
420 typedef enum qw_downloadtype_e
421 {
422         dl_none,
423         dl_single,
424         dl_skin,
425         dl_model,
426         dl_sound
427 }
428 qw_downloadtype_t;
429
430 typedef enum capturevideoformat_e
431 {
432         CAPTUREVIDEOFORMAT_AVI_I420
433 }
434 capturevideoformat_t;
435
436 typedef struct capturevideostate_s
437 {
438         double starttime;
439         double framerate;
440         // for AVI saving some values have to be written after capture ends
441         fs_offset_t videofile_totalframes_offset1;
442         fs_offset_t videofile_totalframes_offset2;
443         fs_offset_t videofile_totalsampleframes_offset;
444         qfile_t *videofile;
445         qboolean active;
446         qboolean realtime;
447         qboolean error;
448         capturevideoformat_t format;
449         int soundrate;
450         int frame;
451         int soundsampleframe; // for AVI saving
452         unsigned char *buffer;
453         sizebuf_t riffbuffer;
454         unsigned char riffbufferdata[128];
455         // note: riffindex buffer has an allocated ->data member, not static like most!
456         sizebuf_t riffindexbuffer;
457         int riffstacklevel;
458         fs_offset_t riffstackstartoffset[4];
459         short rgbtoyuvscaletable[3][3][256];
460         unsigned char yuvnormalizetable[3][256];
461         char basename[64];
462 }
463 capturevideostate_t;
464
465 #define CL_MAX_DOWNLOADACKS 4
466
467 typedef struct cl_downloadack_s
468 {
469         int start, size;
470 }
471 cl_downloadack_t;
472
473 //
474 // the client_static_t structure is persistent through an arbitrary number
475 // of server connections
476 //
477 typedef struct client_static_s
478 {
479         cactive_t state;
480
481         // all client memory allocations go in these pools
482         mempool_t *levelmempool;
483         mempool_t *permanentmempool;
484
485 // demo loop control
486         // -1 = don't play demos
487         int demonum;
488         // list of demos in loop
489         char demos[MAX_DEMOS][MAX_DEMONAME];
490         // the actively playing demo (set by CL_PlayDemo_f)
491         char demoname[64];
492
493 // demo recording info must be here, because record is started before
494 // entering a map (and clearing client_state_t)
495         qboolean demorecording;
496         qboolean demoplayback;
497         qboolean timedemo;
498         // -1 = use normal cd track
499         int forcetrack;
500         qfile_t *demofile;
501         // to meter out one message a frame
502         int td_lastframe;
503         // host_framecount at start
504         int td_startframe;
505         // realtime at second frame of timedemo (LordHavoc: changed to double)
506         double td_starttime;
507         double td_onesecondnexttime;
508         double td_onesecondframes;
509         double td_onesecondminframes;
510         double td_onesecondmaxframes;
511         double td_onesecondavgframes;
512         int td_onesecondavgcount;
513         // LordHavoc: pausedemo
514         qboolean demopaused;
515
516         qboolean connect_trying;
517         int connect_remainingtries;
518         double connect_nextsendtime;
519         lhnetsocket_t *connect_mysocket;
520         lhnetaddress_t connect_address;
521         // protocol version of the server we're connected to
522         // (kept outside client_state_t because it's used between levels)
523         protocolversion_t protocol;
524
525 // connection information
526         // 0 to SIGNONS
527         int signon;
528         // network connection
529         netconn_t *netcon;
530
531         // download information
532         // (note: qw_download variables are also used)
533         cl_downloadack_t dp_downloadack[CL_MAX_DOWNLOADACKS];
534
535         // input sequence numbers are not reset on level change, only connect
536         int movesequence;
537         int servermovesequence;
538
539         // quakeworld stuff below
540
541         // value of "qport" cvar at time of connection
542         int qw_qport;
543         // copied from cls.netcon->qw. variables every time they change, or set by demos (which have no cls.netcon)
544         int qw_incoming_sequence;
545         int qw_outgoing_sequence;
546
547         // current file download buffer (only saved when file is completed)
548         char qw_downloadname[MAX_QPATH];
549         unsigned char *qw_downloadmemory;
550         int qw_downloadmemorycursize;
551         int qw_downloadmemorymaxsize;
552         int qw_downloadnumber;
553         int qw_downloadpercent;
554         qw_downloadtype_t qw_downloadtype;
555         // transfer rate display
556         double qw_downloadspeedtime;
557         int qw_downloadspeedcount;
558         int qw_downloadspeedrate;
559
560         // current file upload buffer (for uploading screenshots to server)
561         unsigned char *qw_uploaddata;
562         int qw_uploadsize;
563         int qw_uploadpos;
564
565         // user infostring
566         // this normally contains the following keys in quakeworld:
567         // password spectator name team skin topcolor bottomcolor rate noaim msg *ver *ip
568         char userinfo[MAX_USERINFO_STRING];
569
570         // video capture stuff
571         capturevideostate_t capturevideo;
572 }
573 client_static_t;
574
575 extern client_static_t  cls;
576
577 typedef struct client_movementqueue_s
578 {
579         double time;
580         float frametime;
581         int sequence;
582         float viewangles[3];
583         float move[3];
584         qboolean jump;
585         qboolean crouch;
586         qboolean canjump;
587 }
588 client_movementqueue_t;
589
590 //[515]: csqc
591 typedef struct
592 {
593         qboolean drawworld;
594         qboolean drawenginesbar;
595         qboolean drawcrosshair;
596 }csqc_vidvars_t;
597
598 typedef enum
599 {
600         PARTICLE_BILLBOARD = 0,
601         PARTICLE_SPARK = 1,
602         PARTICLE_ORIENTED_DOUBLESIDED = 2,
603         PARTICLE_BEAM = 3
604 }
605 porientation_t;
606
607 typedef enum
608 {
609         PBLEND_ALPHA = 0,
610         PBLEND_ADD = 1,
611         PBLEND_MOD = 2
612 }
613 pblend_t;
614
615 typedef struct particletype_s
616 {
617         pblend_t blendmode;
618         porientation_t orientation;
619         qboolean lighting;
620 }
621 particletype_t;
622
623 typedef enum
624 {
625         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
626 }
627 ptype_t;
628
629 typedef struct particle_s
630 {
631         particletype_t *type;
632         int                     texnum;
633         vec3_t          org;
634         vec3_t          vel; // velocity of particle, or orientation of decal, or end point of beam
635         float           size;
636         float           sizeincrease; // rate of size change per second
637         float           alpha; // 0-255
638         float           alphafade; // how much alpha reduces per second
639         float           time2; // used for snow fluttering and decal fade
640         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)
641         float           gravity; // how much gravity affects this particle (1.0 = normal gravity, 0.0 = none)
642         float           airfriction; // how much air friction affects this object (objects with a low mass/size ratio tend to get more air friction)
643         float           liquidfriction; // how much liquid friction affects this object (objects with a low mass/size ratio tend to get more liquid friction)
644         unsigned char           color[4];
645         unsigned int            owner; // decal stuck to this entity
646         model_t         *ownermodel; // model the decal is stuck to (used to make sure the entity is still alive)
647         vec3_t          relativeorigin; // decal at this location in entity's coordinate space
648         vec3_t          relativedirection; // decal oriented this way relative to entity's coordinate space
649 }
650 particle_t;
651
652 typedef enum cl_parsingtextmode_e
653 {
654         CL_PARSETEXTMODE_NONE,
655         CL_PARSETEXTMODE_PING,
656         CL_PARSETEXTMODE_STATUS,
657         CL_PARSETEXTMODE_STATUS_PLAYERID,
658         CL_PARSETEXTMODE_STATUS_PLAYERIP
659 }
660 cl_parsingtextmode_t;
661
662 typedef struct cl_locnode_s
663 {
664         struct cl_locnode_s *next;
665         char *name;
666         vec3_t mins, maxs;
667 }
668 cl_locnode_t;
669
670 //
671 // the client_state_t structure is wiped completely at every
672 // server signon
673 //
674 typedef struct client_state_s
675 {
676         // true if playing in a local game and no one else is connected
677         int islocalgame;
678
679         // send a clc_nop periodically until connected
680         float sendnoptime;
681
682         // current input being accumulated by mouse/joystick/etc input
683         usercmd_t cmd;
684         // latest moves sent to the server that have not been confirmed yet
685         usercmd_t movecmd[CL_MAX_USERCMDS];
686
687 // information for local display
688         // health, etc
689         int stats[MAX_CL_STATS];
690         // last known inventory bit flags, for blinking
691         int olditems;
692         // cl.time of acquiring item, for blinking
693         float item_gettime[32];
694         // last known STAT_ACTIVEWEAPON
695         int activeweapon;
696         // cl.time of changing STAT_ACTIVEWEAPON
697         float weapontime;
698         // use pain anim frame if cl.time < this
699         float faceanimtime;
700         // for stair smoothing
701         float stairsmoothz;
702         double stairsmoothtime;
703
704         // color shifts for damage, powerups
705         cshift_t cshifts[NUM_CSHIFTS];
706         // and content types
707         cshift_t prev_cshifts[NUM_CSHIFTS];
708
709 // the client maintains its own idea of view angles, which are
710 // sent to the server each frame.  The server sets punchangle when
711 // the view is temporarily offset, and an angle reset commands at the start
712 // of each level and after teleporting.
713
714         // mviewangles is read from demo
715         // viewangles is either client controlled or lerped from mviewangles
716         vec3_t mviewangles[2], viewangles;
717         // update by server, used by qc to do weapon recoil
718         vec3_t mpunchangle[2], punchangle;
719         // update by server, can be used by mods to kick view around
720         vec3_t mpunchvector[2], punchvector;
721         // update by server, used for lean+bob (0 is newest)
722         vec3_t mvelocity[2], velocity;
723         // update by server, can be used by mods for zooming
724         vec_t mviewzoom[2], viewzoom;
725         // if true interpolation the mviewangles and other interpolation of the
726         // player is disabled until the next network packet
727         // this is used primarily by teleporters, and when spectating players
728         // special checking of the old fixangle[1] is used to differentiate
729         // between teleporting and spectating
730         qboolean fixangle[2];
731
732         // client movement simulation
733         // these fields are only updated by CL_ClientMovement (called by CL_SendMove after parsing each network packet)
734         // set by CL_ClientMovement_Replay functions
735         qboolean movement_predicted;
736         // if true the CL_ClientMovement_Replay function will update origin, etc
737         qboolean movement_replay;
738         // this is set true by svc_time parsing and causes a new movement to be
739         // queued for prediction purposes
740         qboolean movement_needupdate;
741         // timestamps of latest two predicted moves for interpolation
742         double movement_time[4];
743         // simulated data (this is valid even if cl.movement is false)
744         vec3_t movement_origin;
745         vec3_t movement_oldorigin;
746         vec3_t movement_velocity;
747         // queue of proposed moves
748         int movement_numqueue;
749         client_movementqueue_t movement_queue[256];
750         // whether the replay should allow a jump at the first sequence
751         qboolean movement_replay_canjump;
752
753 // pitch drifting vars
754         float idealpitch;
755         float pitchvel;
756         qboolean nodrift;
757         float driftmove;
758         double laststop;
759
760 //[515]: added for csqc purposes
761         float sensitivityscale;
762         csqc_vidvars_t csqc_vidvars;    //[515]: these parms must be set to true by default
763         qboolean csqc_wantsmousemove;
764         struct model_s *csqc_model_precache[MAX_MODELS];
765
766         // local amount for smoothing stepups
767         //float crouch;
768
769         // sent by server
770         qboolean paused;
771         qboolean onground;
772         qboolean inwater;
773
774         // used by bob
775         qboolean oldonground;
776         double lastongroundtime;
777         double hitgroundtime;
778
779         // don't change view angle, full screen, etc
780         int intermission;
781         // latched at intermission start
782         double completed_time;
783
784         // the timestamp of the last two messages
785         double mtime[2];
786
787         // clients view of time, time should be between mtime[0] and mtime[1] to
788         // generate a lerp point for other data, oldtime is the previous frame's
789         // value of time, frametime is the difference between time and oldtime
790         // note: cl.time may be beyond cl.mtime[0] if packet loss is occuring, it
791         // is only forcefully limited when a packet is received
792         double time, oldtime;
793         // how long it has been since the previous client frame in real time
794         // (not game time, for that use cl.time - cl.oldtime)
795         double realframetime;
796
797         // copy of realtime from last recieved message, for net trouble icon
798         float last_received_message;
799
800 // information that is static for the entire time connected to a server
801         struct model_s *model_precache[MAX_MODELS];
802         struct sfx_s *sound_precache[MAX_SOUNDS];
803
804         // FIXME: this is a lot of memory to be keeping around, this really should be dynamically allocated and freed somehow
805         char model_name[MAX_MODELS][MAX_QPATH];
806         char sound_name[MAX_SOUNDS][MAX_QPATH];
807
808         // for display on solo scoreboard
809         char levelname[40];
810         // cl_entitites[cl.viewentity] = player
811         int viewentity;
812         // the real player entity (normally same as viewentity,
813         // different than viewentity if mod uses chasecam or other tricks)
814         int playerentity;
815         // max players that can be in this game
816         int maxclients;
817         // type of game (deathmatch, coop, singleplayer)
818         int gametype;
819
820         // models and sounds used by engine code (particularly cl_parse.c)
821         model_t *model_bolt;
822         model_t *model_bolt2;
823         model_t *model_bolt3;
824         model_t *model_beam;
825         sfx_t *sfx_wizhit;
826         sfx_t *sfx_knighthit;
827         sfx_t *sfx_tink1;
828         sfx_t *sfx_ric1;
829         sfx_t *sfx_ric2;
830         sfx_t *sfx_ric3;
831         sfx_t *sfx_r_exp3;
832         // indicates that the file "sound/misc/talk2.wav" was found (for use by team chat messages)
833         qboolean foundtalk2wav;
834
835 // refresh related state
836
837         // cl_entitites[0].model
838         struct model_s *worldmodel;
839
840         // the gun model
841         entity_t viewent;
842
843         // cd audio
844         int cdtrack, looptrack;
845
846 // frag scoreboard
847
848         // [cl.maxclients]
849         scoreboard_t *scores;
850
851         // keep track of svc_print parsing state (analyzes ping reports and status reports)
852         cl_parsingtextmode_t parsingtextmode;
853         int parsingtextplayerindex;
854         // set by scoreboard code when sending ping command, this causes the next ping results to be hidden
855         // (which could eat the wrong ping report if the player issues one
856         //  manually, but they would still see a ping report, just a later one
857         //  caused by the scoreboard code rather than the one they intentionally
858         //  issued)
859         int parsingtextexpectingpingforscores;
860
861         // entity database stuff
862         // latest received entity frame numbers
863 #define LATESTFRAMENUMS 3
864         int latestframenums[LATESTFRAMENUMS];
865         entityframe_database_t *entitydatabase;
866         entityframe4_database_t *entitydatabase4;
867         entityframeqw_database_t *entitydatabaseqw;
868
869         // keep track of quake entities because they need to be killed if they get stale
870         int lastquakeentity;
871         unsigned char isquakeentity[MAX_EDICTS];
872
873         // bounding boxes for clientside movement
874         vec3_t playerstandmins;
875         vec3_t playerstandmaxs;
876         vec3_t playercrouchmins;
877         vec3_t playercrouchmaxs;
878
879         int max_entities;
880         int max_static_entities;
881         int max_temp_entities;
882         int max_effects;
883         int max_beams;
884         int max_dlights;
885         int max_lightstyle;
886         int max_brushmodel_entities;
887         int max_particles;
888
889         entity_t *entities;
890         unsigned char *entities_active;
891         entity_t *static_entities;
892         entity_t *temp_entities;
893         cl_effect_t *effects;
894         beam_t *beams;
895         dlight_t *dlights;
896         lightstyle_t *lightstyle;
897         int *brushmodel_entities;
898         particle_t *particles;
899
900         int num_entities;
901         int num_static_entities;
902         int num_temp_entities;
903         int num_brushmodel_entities;
904         int num_effects;
905         int num_beams;
906         int num_dlights;
907         int num_particles;
908
909         int free_particle;
910
911         // cl_serverextension_download feature
912         int loadmodel_current;
913         int downloadmodel_current;
914         int loadmodel_total;
915         int loadsound_current;
916         int downloadsound_current;
917         int loadsound_total;
918         qboolean downloadcsqc;
919         qboolean loadbegun;
920         qboolean loadfinished;
921
922         // quakeworld stuff
923
924         // local copy of the server infostring
925         char qw_serverinfo[MAX_SERVERINFO_STRING];
926
927         // time of last qw "pings" command sent to server while showing scores
928         double last_ping_request;
929
930         // used during connect
931         int qw_servercount;
932
933         // updated from serverinfo
934         int qw_teamplay;
935
936         // unused: indicates whether the player is spectating
937         // use cl.scores[cl.playerentity].qw_spectator instead
938         //qboolean qw_spectator;
939
940         // movement parameters for client prediction
941         float qw_movevars_gravity;
942         float qw_movevars_stopspeed;
943         float qw_movevars_maxspeed; // can change during play
944         float qw_movevars_spectatormaxspeed;
945         float qw_movevars_accelerate;
946         float qw_movevars_airaccelerate;
947         float qw_movevars_wateraccelerate;
948         float qw_movevars_friction;
949         float qw_movevars_waterfriction;
950         float qw_movevars_entgravity; // can change during play
951
952         // models used by qw protocol
953         int qw_modelindex_spike;
954         int qw_modelindex_player;
955         int qw_modelindex_flag;
956         int qw_modelindex_s_explod;
957
958         vec3_t qw_intermission_origin;
959         vec3_t qw_intermission_angles;
960
961         // 255 is the most nails the QW protocol could send
962         int qw_num_nails;
963         vec_t qw_nails[255][6];
964
965         float qw_weaponkick;
966
967         int qw_validsequence;
968
969         int qw_deltasequence[QW_UPDATE_BACKUP];
970
971         // csqc stuff:
972
973         // collision culling data
974         world_t world;
975
976         // loc file stuff (points and boxes describing locations in the level)
977         cl_locnode_t *locnodes;
978         // this is updated to cl.movement_origin whenever health is < 1
979         // used by %d print in say/say_team messages if cl_locs_enable is on
980         vec3_t lastdeathorigin;
981 }
982 client_state_t;
983
984 //
985 // cvars
986 //
987 extern cvar_t cl_name;
988 extern cvar_t cl_color;
989 extern cvar_t cl_rate;
990 extern cvar_t cl_pmodel;
991 extern cvar_t cl_playermodel;
992 extern cvar_t cl_playerskin;
993
994 extern cvar_t rcon_password;
995 extern cvar_t rcon_address;
996
997 extern cvar_t cl_upspeed;
998 extern cvar_t cl_forwardspeed;
999 extern cvar_t cl_backspeed;
1000 extern cvar_t cl_sidespeed;
1001
1002 extern cvar_t cl_movespeedkey;
1003
1004 extern cvar_t cl_yawspeed;
1005 extern cvar_t cl_pitchspeed;
1006
1007 extern cvar_t cl_anglespeedkey;
1008
1009 extern cvar_t cl_autofire;
1010
1011 extern cvar_t cl_shownet;
1012 extern cvar_t cl_nolerp;
1013 extern cvar_t cl_nettimesyncfactor;
1014 extern cvar_t cl_nettimesyncboundmode;
1015 extern cvar_t cl_nettimesyncboundtolerance;
1016
1017 extern cvar_t cl_pitchdriftspeed;
1018 extern cvar_t lookspring;
1019 extern cvar_t lookstrafe;
1020 extern cvar_t sensitivity;
1021
1022 extern cvar_t freelook;
1023
1024 extern cvar_t m_pitch;
1025 extern cvar_t m_yaw;
1026 extern cvar_t m_forward;
1027 extern cvar_t m_side;
1028
1029 extern cvar_t cl_autodemo;
1030 extern cvar_t cl_autodemo_nameformat;
1031
1032 extern cvar_t r_draweffects;
1033
1034 extern cvar_t cl_explosions_alpha_start;
1035 extern cvar_t cl_explosions_alpha_end;
1036 extern cvar_t cl_explosions_size_start;
1037 extern cvar_t cl_explosions_size_end;
1038 extern cvar_t cl_explosions_lifetime;
1039 extern cvar_t cl_stainmaps;
1040 extern cvar_t cl_stainmaps_clearonload;
1041
1042 extern cvar_t cl_prydoncursor;
1043
1044 extern cvar_t cl_locs_enable;
1045
1046 extern client_state_t cl;
1047
1048 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);
1049
1050 cl_locnode_t *CL_Locs_FindNearest(const vec3_t point);
1051 void CL_Locs_FindLocationName(char *buffer, size_t buffersize, vec3_t point);
1052
1053 //=============================================================================
1054
1055 //
1056 // cl_main
1057 //
1058
1059 void CL_Shutdown (void);
1060 void CL_Init (void);
1061
1062 void CL_EstablishConnection(const char *host);
1063
1064 void CL_Disconnect (void);
1065 void CL_Disconnect_f (void);
1066
1067 void CL_UpdateRenderEntity(entity_render_t *ent);
1068 void CL_UpdateViewEntities(void);
1069
1070 //
1071 // cl_input
1072 //
1073 typedef struct kbutton_s
1074 {
1075         int             down[2];                // key nums holding it down
1076         int             state;                  // low bit is down state
1077 }
1078 kbutton_t;
1079
1080 extern  kbutton_t       in_mlook, in_klook;
1081 extern  kbutton_t       in_strafe;
1082 extern  kbutton_t       in_speed;
1083
1084 void CL_InitInput (void);
1085 void CL_SendMove (void);
1086
1087 void CL_ValidateState(entity_state_t *s);
1088 void CL_MoveLerpEntityStates(entity_t *ent);
1089 void CL_LerpUpdate(entity_t *e);
1090 void CL_ParseTEnt (void);
1091 void CL_NewBeam (int ent, vec3_t start, vec3_t end, model_t *m, int lightning);
1092 void CL_RelinkBeams (void);
1093 void CL_Beam_CalculatePositions (const beam_t *b, vec3_t start, vec3_t end);
1094 void CL_ClientMovement_Replay(void);
1095
1096 void CL_ClearTempEntities (void);
1097 entity_t *CL_NewTempEntity (void);
1098
1099 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
1100
1101 void CL_ClearState (void);
1102 void CL_ExpandEntities(int num);
1103 void CL_SetInfo(const char *key, const char *value, qboolean send, qboolean allowstarkey, qboolean allowmodel, qboolean quiet);
1104
1105
1106 void CL_UpdateWorld (void);
1107 void CL_WriteToServer (void);
1108 void CL_Input (void);
1109 extern qboolean cl_ignoremousemove;
1110
1111
1112 float CL_KeyState (kbutton_t *key);
1113 const char *Key_KeynumToString (int keynum);
1114 int Key_StringToKeynum (const char *str);
1115
1116 //
1117 // cl_demo.c
1118 //
1119 void CL_StopPlayback(void);
1120 void CL_ReadDemoMessage(void);
1121 void CL_WriteDemoMessage(sizebuf_t *mesage);
1122
1123 void CL_NextDemo(void);
1124 void CL_Stop_f(void);
1125 void CL_Record_f(void);
1126 void CL_PlayDemo_f(void);
1127 void CL_TimeDemo_f(void);
1128
1129 //
1130 // cl_parse.c
1131 //
1132 void CL_Parse_Init(void);
1133 void CL_Parse_Shutdown(void);
1134 void CL_ParseServerMessage(void);
1135 void CL_Parse_DumpPacket(void);
1136 void CL_Parse_ErrorCleanUp(void);
1137 void QW_CL_StartUpload(unsigned char *data, int size);
1138 extern cvar_t qport;
1139
1140 //
1141 // view
1142 //
1143 void V_StartPitchDrift (void);
1144 void V_StopPitchDrift (void);
1145
1146 void V_Init (void);
1147 float V_CalcRoll (vec3_t angles, vec3_t velocity);
1148 void V_UpdateBlends (void);
1149 void V_ParseDamage (void);
1150
1151 //
1152 // cl_part
1153 //
1154
1155 extern cvar_t cl_particles;
1156 extern cvar_t cl_particles_quality;
1157 extern cvar_t cl_particles_size;
1158 extern cvar_t cl_particles_quake;
1159 extern cvar_t cl_particles_blood;
1160 extern cvar_t cl_particles_blood_alpha;
1161 extern cvar_t cl_particles_blood_bloodhack;
1162 extern cvar_t cl_particles_bulletimpacts;
1163 extern cvar_t cl_particles_explosions_smoke;
1164 extern cvar_t cl_particles_explosions_sparks;
1165 extern cvar_t cl_particles_explosions_shell;
1166 extern cvar_t cl_particles_rain;
1167 extern cvar_t cl_particles_snow;
1168 extern cvar_t cl_particles_smoke;
1169 extern cvar_t cl_particles_smoke_alpha;
1170 extern cvar_t cl_particles_smoke_alphafade;
1171 extern cvar_t cl_particles_sparks;
1172 extern cvar_t cl_particles_bubbles;
1173 extern cvar_t cl_decals;
1174 extern cvar_t cl_decals_time;
1175 extern cvar_t cl_decals_fadetime;
1176
1177 void CL_Particles_Clear(void);
1178 void CL_Particles_Init(void);
1179 void CL_Particles_Shutdown(void);
1180
1181 typedef enum effectnameindex_s
1182 {
1183         EFFECT_NONE,
1184         EFFECT_TE_GUNSHOT,
1185         EFFECT_TE_GUNSHOTQUAD,
1186         EFFECT_TE_SPIKE,
1187         EFFECT_TE_SPIKEQUAD,
1188         EFFECT_TE_SUPERSPIKE,
1189         EFFECT_TE_SUPERSPIKEQUAD,
1190         EFFECT_TE_WIZSPIKE,
1191         EFFECT_TE_KNIGHTSPIKE,
1192         EFFECT_TE_EXPLOSION,
1193         EFFECT_TE_EXPLOSIONQUAD,
1194         EFFECT_TE_TAREXPLOSION,
1195         EFFECT_TE_TELEPORT,
1196         EFFECT_TE_LAVASPLASH,
1197         EFFECT_TE_SMALLFLASH,
1198         EFFECT_TE_FLAMEJET,
1199         EFFECT_EF_FLAME,
1200         EFFECT_TE_BLOOD,
1201         EFFECT_TE_SPARK,
1202         EFFECT_TE_PLASMABURN,
1203         EFFECT_TE_TEI_G3,
1204         EFFECT_TE_TEI_SMOKE,
1205         EFFECT_TE_TEI_BIGEXPLOSION,
1206         EFFECT_TE_TEI_PLASMAHIT,
1207         EFFECT_EF_STARDUST,
1208         EFFECT_TR_ROCKET,
1209         EFFECT_TR_GRENADE,
1210         EFFECT_TR_BLOOD,
1211         EFFECT_TR_WIZSPIKE,
1212         EFFECT_TR_SLIGHTBLOOD,
1213         EFFECT_TR_KNIGHTSPIKE,
1214         EFFECT_TR_VORESPIKE,
1215         EFFECT_TR_NEHAHRASMOKE,
1216         EFFECT_TR_NEXUIZPLASMA,
1217         EFFECT_TR_GLOWTRAIL,
1218         EFFECT_SVC_PARTICLE,
1219         EFFECT_TOTAL
1220 }
1221 effectnameindex_t;
1222
1223 int CL_ParticleEffectIndexForName(const char *name);
1224 const char *CL_ParticleEffectNameForIndex(int i);
1225 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);
1226 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);
1227 void CL_ParseParticleEffect (void);
1228 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);
1229 void CL_ParticleRain (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, int type);
1230 void CL_EntityParticles (const entity_t *ent);
1231 void CL_ParticleExplosion (const vec3_t org);
1232 void CL_ParticleExplosion2 (const vec3_t org, int colorStart, int colorLength);
1233 void CL_MoveParticles(void);
1234 void R_MoveExplosions(void);
1235 void R_NewExplosion(const vec3_t org);
1236
1237 void Debug_PolygonBegin(const char *picname, int flags, qboolean draw2d, float linewidth);
1238 void Debug_PolygonVertex(float x, float y, float z, float s, float t, float r, float g, float b, float a);
1239 void Debug_PolygonEnd(void);
1240
1241 #include "cl_screen.h"
1242
1243 extern qboolean sb_showscores;
1244
1245 #define NUMCROSSHAIRS 32
1246 extern cachepic_t *r_crosshairs[NUMCROSSHAIRS+1];
1247
1248 float FogPoint_World(const vec3_t p);
1249 float FogPoint_Model(const vec3_t p);
1250
1251 typedef struct r_refdef_stats_s
1252 {
1253         int entities;
1254         int entities_surfaces;
1255         int entities_triangles;
1256         int world_leafs;
1257         int world_portals;
1258         int particles;
1259         int meshes;
1260         int meshes_elements;
1261         int lights;
1262         int lights_clears;
1263         int lights_scissored;
1264         int lights_lighttriangles;
1265         int lights_shadowtriangles;
1266         int lights_dynamicshadowtriangles;
1267         int bloom;
1268         int bloom_copypixels;
1269         int bloom_drawpixels;
1270 }
1271 r_refdef_stats_t;
1272
1273 typedef struct r_refdef_s
1274 {
1275         // these fields define the basic rendering information for the world
1276         // but not the view, which could change multiple times in one rendered
1277         // frame (for example when rendering textures for certain effects)
1278
1279         // these are set for water warping before
1280         // frustum_x/frustum_y are calculated
1281         float frustumscale_x, frustumscale_y;
1282
1283         // minimum visible distance (pixels closer than this disappear)
1284         double nearclip;
1285         // maximum visible distance (pixels further than this disappear in 16bpp modes,
1286         // in 32bpp an infinite-farclip matrix is used instead)
1287         double farclip;
1288
1289         // fullscreen color blend
1290         float viewblend[4];
1291
1292         // whether to call S_ExtraUpdate during render to reduce sound chop
1293         qboolean extraupdate;
1294
1295         // client gameworld time for rendering time based effects
1296         double time;
1297
1298         // the world
1299         entity_render_t *worldentity;
1300
1301         // same as worldentity->model
1302         model_t *worldmodel;
1303
1304         // renderable entities (excluding world)
1305         entity_render_t **entities;
1306         int numentities;
1307         int maxentities;
1308
1309         // renderable dynamic lights
1310         rtlight_t lights[MAX_DLIGHTS];
1311         int numlights;
1312
1313         // 8.8bit fixed point intensities for light styles
1314         // controls intensity of dynamic lights and lightmap layers
1315         unsigned short  lightstylevalue[256];   // 8.8 fraction of base light value
1316
1317         vec3_t fogcolor;
1318         vec_t fogrange;
1319         vec_t fograngerecip;
1320         vec_t fogmasktabledistmultiplier;
1321 #define FOGMASKTABLEWIDTH 1024
1322         float fogmasktable[FOGMASKTABLEWIDTH];
1323         float fog_density;
1324         float fog_red;
1325         float fog_green;
1326         float fog_blue;
1327         qboolean fogenabled;
1328         qboolean oldgl_fogenable;
1329
1330         qboolean draw2dstage;
1331
1332         // true during envmap command capture
1333         qboolean envmap;
1334
1335         // brightness of world lightmaps and related lighting
1336         // (often reduced when world rtlights are enabled)
1337         float lightmapintensity;
1338         // whether to draw world lights realtime, dlights realtime, and their shadows
1339         qboolean rtworld;
1340         qboolean rtworldshadows;
1341         qboolean rtdlight;
1342         qboolean rtdlightshadows;
1343         float polygonfactor;
1344         float polygonoffset;
1345         float shadowpolygonfactor;
1346         float shadowpolygonoffset;
1347
1348         // rendering stats for r_speeds display
1349         // (these are incremented in many places)
1350         r_refdef_stats_t stats;
1351 }
1352 r_refdef_t;
1353
1354 typedef struct r_view_s
1355 {
1356         // view information (changes multiple times per frame)
1357         // if any of these variables change then r_viewcache must be regenerated
1358         // by calling R_View_Update
1359         // (which also updates viewport, scissor, colormask)
1360
1361         // it is safe and expected to copy this into a structure on the stack and
1362         // call the renderer recursively, then restore from the stack afterward
1363         // (as long as R_View_Update is called)
1364
1365         // eye position information
1366         matrix4x4_t matrix;
1367         vec3_t origin;
1368         vec3_t forward;
1369         vec3_t left;
1370         vec3_t right;
1371         vec3_t up;
1372         mplane_t frustum[5];
1373         float frustum_x, frustum_y;
1374         vec3_t frustumcorner[4];
1375
1376         // screen area to render in
1377         int x;
1378         int y;
1379         int z;
1380         int width;
1381         int height;
1382         int depth;
1383
1384         // which color components to allow (for anaglyph glasses)
1385         int colormask[4];
1386
1387         // global RGB color multiplier for rendering, this is required by HDR
1388         float colorscale;
1389 }
1390 r_view_t;
1391
1392 typedef struct r_viewcache_s
1393 {
1394         // these properties are generated by R_View_Update()
1395
1396         // which entities are currently visible for this viewpoint
1397         // (the used range is 0...r_refdef.numentities)
1398         unsigned char entityvisible[MAX_EDICTS];
1399         // flag arrays used for visibility checking on world model
1400         // (all other entities have no per-surface/per-leaf visibility checks)
1401         // TODO: dynamic resize according to r_refdef.worldmodel->brush.num_clusters
1402         unsigned char world_pvsbits[(32768+7)>>3];
1403         // TODO: dynamic resize according to r_refdef.worldmodel->brush.num_leafs
1404         unsigned char world_leafvisible[32768];
1405         // TODO: dynamic resize according to r_refdef.worldmodel->num_surfaces
1406         unsigned char world_surfacevisible[262144];
1407         // if true, the view is currently in a leaf without pvs data
1408         qboolean world_novis;
1409 }
1410 r_viewcache_t;
1411
1412 extern r_refdef_t r_refdef;
1413 extern r_view_t r_view;
1414 extern r_viewcache_t r_viewcache;
1415
1416 #endif
1417