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