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