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