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