make CSQC support the >0.05s/<0.0005s handling of standard player physics so CSQC...
[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 #include "snd_main.h"
27
28 // flags for rtlight rendering
29 #define LIGHTFLAG_NORMALMODE 1
30 #define LIGHTFLAG_REALTIMEMODE 2
31
32 typedef struct tridecal_s
33 {
34         // color and initial alpha value
35         float                   texcoord2f[3][2];
36         float                   vertex3f[3][3];
37         float                   color4f[3][4];
38         float                   plane[4]; // backface culling
39         // how long this decal has lived so far (the actual fade begins at cl_decals_time)
40         float                   lived;
41         // if >= 0 this indicates the decal should follow an animated triangle
42         int                             triangleindex;
43         // for visibility culling
44         int                             surfaceindex;
45         // old decals are killed to obey cl_decals_max
46         int                             decalsequence;
47 }
48 tridecal_t;
49
50 typedef struct decalsystem_s
51 {
52         dp_model_t *model;
53         double lastupdatetime;
54         int maxdecals;
55         int freedecal;
56         int numdecals;
57         tridecal_t *decals;
58         float *vertex3f;
59         float *texcoord2f;
60         float *color4f;
61         int *element3i;
62         unsigned short *element3s;
63 }
64 decalsystem_t;
65
66 typedef struct effect_s
67 {
68         int active;
69         vec3_t origin;
70         double starttime;
71         float framerate;
72         int modelindex;
73         int startframe;
74         int endframe;
75         // these are for interpolation
76         int frame;
77         double frame1time;
78         double frame2time;
79 }
80 cl_effect_t;
81
82 typedef struct beam_s
83 {
84         int             entity;
85         // draw this as lightning polygons, or a model?
86         int             lightning;
87         struct model_s  *model;
88         float   endtime;
89         vec3_t  start, end;
90 }
91 beam_t;
92
93 typedef struct rtlight_particle_s
94 {
95         float origin[3];
96         float color[3];
97 }
98 rtlight_particle_t;
99
100 typedef struct rtlight_s
101 {
102         // shadow volumes are done entirely in model space, so there are no matrices for dealing with them...  they just use the origin
103
104         // note that the world to light matrices are inversely scaled (divided) by lightradius
105
106         // core properties
107         /// matrix for transforming light filter coordinates to world coordinates
108         matrix4x4_t matrix_lighttoworld;
109         /// matrix for transforming world coordinates to light filter coordinates
110         matrix4x4_t matrix_worldtolight;
111         /// typically 1 1 1, can be lower (dim) or higher (overbright)
112         vec3_t color;
113         /// size of the light (remove?)
114         vec_t radius;
115         /// light filter
116         char cubemapname[64];
117         /// light style to monitor for brightness
118         int style;
119         /// whether light should render shadows
120         int shadow;
121         /// intensity of corona to render
122         vec_t corona;
123         /// radius scale of corona to render (1.0 means same as light radius)
124         vec_t coronasizescale;
125         /// ambient intensity to render
126         vec_t ambientscale;
127         /// diffuse intensity to render
128         vec_t diffusescale;
129         /// specular intensity to render
130         vec_t specularscale;
131         /// LIGHTFLAG_* flags
132         int flags;
133
134         // generated properties
135         /// used only for shadow volumes
136         vec3_t shadoworigin;
137         /// culling
138         vec3_t cullmins;
139         vec3_t cullmaxs;
140         // culling
141         //vec_t cullradius;
142         // squared cullradius
143         //vec_t cullradius2;
144
145         // rendering properties, updated each time a light is rendered
146         // this is rtlight->color * d_lightstylevalue
147         vec3_t currentcolor;
148         /// used by corona updates, due to occlusion query
149         float corona_visibility;
150         unsigned int corona_queryindex_visiblepixels;
151         unsigned int corona_queryindex_allpixels;
152         /// this is R_GetCubemap(rtlight->cubemapname)
153         rtexture_t *currentcubemap;
154         /// set by R_Shadow_PrepareLight to decide whether R_Shadow_DrawLight should draw it
155         qboolean draw;
156         /// these fields are set by R_Shadow_PrepareLight for later drawing
157         int cached_numlightentities;
158         int cached_numlightentities_noselfshadow;
159         int cached_numshadowentities;
160         int cached_numshadowentities_noselfshadow;
161         int cached_numsurfaces;
162         struct entity_render_s **cached_lightentities;
163         struct entity_render_s **cached_lightentities_noselfshadow;
164         struct entity_render_s **cached_shadowentities;
165         struct entity_render_s **cached_shadowentities_noselfshadow;
166         unsigned char *cached_shadowtrispvs;
167         unsigned char *cached_lighttrispvs;
168         int *cached_surfacelist;
169         // reduced light cullbox from GetLightInfo
170         vec3_t cached_cullmins;
171         vec3_t cached_cullmaxs;
172         // current shadow-caster culling planes based on view
173         // (any geometry outside these planes can not contribute to the visible
174         //  shadows in any way, and thus can be culled safely)
175         int cached_numfrustumplanes;
176         mplane_t cached_frustumplanes[5]; // see R_Shadow_ComputeShadowCasterCullingPlanes
177
178         /// static light info
179         /// true if this light should be compiled as a static light
180         int isstatic;
181         /// true if this is a compiled world light, cleared if the light changes
182         int compiled;
183         /// the shadowing mode used to compile this light
184         int shadowmode;
185         /// premade shadow volumes to render for world entity
186         shadowmesh_t *static_meshchain_shadow_zpass;
187         shadowmesh_t *static_meshchain_shadow_zfail;
188         shadowmesh_t *static_meshchain_shadow_shadowmap;
189         /// used for visibility testing (more exact than bbox)
190         int static_numleafs;
191         int static_numleafpvsbytes;
192         int *static_leaflist;
193         unsigned char *static_leafpvs;
194         /// surfaces seen by light
195         int static_numsurfaces;
196         int *static_surfacelist;
197         /// flag bits indicating which triangles of the world model should cast
198         /// shadows, and which ones should be lit
199         ///
200         /// this avoids redundantly scanning the triangles in each surface twice
201         /// for whether they should cast shadows, once in culling and once in the
202         /// actual shadowmarklist production.
203         int static_numshadowtrispvsbytes;
204         unsigned char *static_shadowtrispvs;
205         /// this allows the lighting batch code to skip backfaces andother culled
206         /// triangles not relevant for lighting
207         /// (important on big surfaces such as terrain)
208         int static_numlighttrispvsbytes;
209         unsigned char *static_lighttrispvs;
210         /// masks of all shadowmap sides that have any potential static receivers or casters
211         int static_shadowmap_receivers;
212         int static_shadowmap_casters;
213         /// particle-tracing cache for global illumination
214         int particlecache_numparticles;
215         int particlecache_maxparticles;
216         int particlecache_updateparticle;
217         rtlight_particle_t *particlecache_particles;
218
219         /// bouncegrid light info
220         float photoncolor[3];
221         float photons;
222 }
223 rtlight_t;
224
225 typedef struct dlight_s
226 {
227         // destroy light after this time
228         // (dlight only)
229         vec_t die;
230         // the entity that owns this light (can be NULL)
231         // (dlight only)
232         struct entity_render_s *ent;
233         // location
234         // (worldlight: saved to .rtlights file)
235         vec3_t origin;
236         // worldlight orientation
237         // (worldlight only)
238         // (worldlight: saved to .rtlights file)
239         vec3_t angles;
240         // dlight orientation/scaling/location
241         // (dlight only)
242         matrix4x4_t matrix;
243         // color of light
244         // (worldlight: saved to .rtlights file)
245         vec3_t color;
246         // cubemap name to use on this light
247         // (worldlight: saved to .rtlights file)
248         char cubemapname[64];
249         // make light flash while selected
250         // (worldlight only)
251         int selected;
252         // brightness (not really radius anymore)
253         // (worldlight: saved to .rtlights file)
254         vec_t radius;
255         // drop intensity this much each second
256         // (dlight only)
257         vec_t decay;
258         // intensity value which is dropped over time
259         // (dlight only)
260         vec_t intensity;
261         // initial values for intensity to modify
262         // (dlight only)
263         vec_t initialradius;
264         vec3_t initialcolor;
265         // light style which controls intensity of this light
266         // (worldlight: saved to .rtlights file)
267         int style;
268         // cast shadows
269         // (worldlight: saved to .rtlights file)
270         int shadow;
271         // corona intensity
272         // (worldlight: saved to .rtlights file)
273         vec_t corona;
274         // radius scale of corona to render (1.0 means same as light radius)
275         // (worldlight: saved to .rtlights file)
276         vec_t coronasizescale;
277         // ambient intensity to render
278         // (worldlight: saved to .rtlights file)
279         vec_t ambientscale;
280         // diffuse intensity to render
281         // (worldlight: saved to .rtlights file)
282         vec_t diffusescale;
283         // specular intensity to render
284         // (worldlight: saved to .rtlights file)
285         vec_t specularscale;
286         // LIGHTFLAG_* flags
287         // (worldlight: saved to .rtlights file)
288         int flags;
289         // linked list of world lights
290         // (worldlight only)
291         struct dlight_s *next;
292         // embedded rtlight struct for renderer
293         // (worldlight only)
294         rtlight_t rtlight;
295 }
296 dlight_t;
297
298 // this is derived from processing of the framegroupblend array
299 // note: technically each framegroupblend can produce two of these, but that
300 // never happens in practice because no one blends between more than 2
301 // framegroups at once
302 #define MAX_FRAMEBLENDS (MAX_FRAMEGROUPBLENDS * 2)
303 typedef struct frameblend_s
304 {
305         int subframe;
306         float lerp;
307 }
308 frameblend_t;
309
310 // LordHavoc: this struct is intended for the renderer but some fields are
311 // used by the client.
312 //
313 // The renderer should not rely on any changes to this struct to be persistent
314 // across multiple frames because temp entities are wiped every frame, but it
315 // is acceptable to cache things in this struct that are not critical.
316 //
317 // For example the r_cullentities_trace code does such caching.
318 typedef struct entity_render_s
319 {
320         // location
321         //vec3_t origin;
322         // orientation
323         //vec3_t angles;
324         // transform matrix for model to world
325         matrix4x4_t matrix;
326         // transform matrix for world to model
327         matrix4x4_t inversematrix;
328         // opacity (alpha) of the model
329         float alpha;
330         // size the model is shown
331         float scale;
332         // transparent sorting offset
333         float transparent_offset;
334
335         // NULL = no model
336         dp_model_t *model;
337         // number of the entity represents, or 0 for non-network entities
338         int entitynumber;
339         // literal colormap colors for renderer, if both are 0 0 0 it is not colormapped
340         vec3_t colormap_pantscolor;
341         vec3_t colormap_shirtcolor;
342         // light, particles, etc
343         int effects;
344         // qw CTF flags and other internal-use-only effect bits
345         int internaleffects;
346         // for Alias models
347         int skinnum;
348         // render flags
349         int flags;
350
351         // colormod tinting of models
352         float colormod[3];
353         float glowmod[3];
354
355         // interpolated animation - active framegroups and blend factors
356         framegroupblend_t framegroupblend[MAX_FRAMEGROUPBLENDS];
357
358         // time of last model change (for shader animations)
359         double shadertime;
360
361         // calculated by the renderer (but not persistent)
362
363         // calculated during R_AddModelEntities
364         vec3_t mins, maxs;
365         // subframe numbers (-1 if not used) and their blending scalers (0-1), if interpolation is not desired, use subframeblend[0].subframe
366         frameblend_t frameblend[MAX_FRAMEBLENDS];
367         // skeletal animation data (if skeleton.relativetransforms is not NULL, it overrides frameblend)
368         skeleton_t *skeleton;
369
370         // animation cache (pointers allocated using R_FrameData_Alloc)
371         // ONLY valid during R_RenderView!  may be NULL (not cached)
372         float *animcache_vertex3f;
373         float *animcache_normal3f;
374         float *animcache_svector3f;
375         float *animcache_tvector3f;
376         // interleaved arrays for rendering and dynamic vertex buffers for them
377         r_meshbuffer_t *animcache_vertex3fbuffer;
378         r_vertexmesh_t *animcache_vertexmesh;
379         r_meshbuffer_t *animcache_vertexmeshbuffer;
380
381         // current lighting from map (updated ONLY by client code, not renderer)
382         vec3_t modellight_ambient;
383         vec3_t modellight_diffuse; // q3bsp
384         vec3_t modellight_lightdir; // q3bsp
385
386         // storage of decals on this entity
387         // (note: if allowdecals is set, be sure to call R_DecalSystem_Reset on removal!)
388         int allowdecals;
389         decalsystem_t decalsystem;
390
391         // FIELDS UPDATED BY RENDERER:
392         // last time visible during trace culling
393         double last_trace_visibility;
394
395         // user wavefunc parameters (from csqc)
396         float userwavefunc_param[Q3WAVEFUNC_USER_COUNT];
397 }
398 entity_render_t;
399
400 typedef struct entity_persistent_s
401 {
402         vec3_t trail_origin;
403
404         // particle trail
405         float trail_time;
406         qboolean trail_allowed; // set to false by teleports, true by update code, prevents bad lerps
407
408         // muzzleflash fading
409         float muzzleflash;
410
411         // interpolated movement
412
413         // start time of move
414         float lerpstarttime;
415         // time difference from start to end of move
416         float lerpdeltatime;
417         // the move itself, start and end
418         float oldorigin[3];
419         float oldangles[3];
420         float neworigin[3];
421         float newangles[3];
422 }
423 entity_persistent_t;
424
425 typedef struct entity_s
426 {
427         // baseline state (default values)
428         entity_state_t state_baseline;
429         // previous state (interpolating from this)
430         entity_state_t state_previous;
431         // current state (interpolating to this)
432         entity_state_t state_current;
433
434         // used for regenerating parts of render
435         entity_persistent_t persistent;
436
437         // the only data the renderer should know about
438         entity_render_t render;
439 }
440 entity_t;
441
442 typedef struct usercmd_s
443 {
444         vec3_t  viewangles;
445
446 // intended velocities
447         float   forwardmove;
448         float   sidemove;
449         float   upmove;
450
451         vec3_t  cursor_screen;
452         vec3_t  cursor_start;
453         vec3_t  cursor_end;
454         vec3_t  cursor_impact;
455         vec3_t  cursor_normal;
456         vec_t   cursor_fraction;
457         int             cursor_entitynumber;
458
459         double time; // time the move is executed for (cl_movement: clienttime, non-cl_movement: receivetime)
460         double receivetime; // time the move was received at
461         double clienttime; // time to which server state the move corresponds to
462         int msec; // for predicted moves
463         int buttons;
464         int impulse;
465         int sequence;
466         qboolean applied; // if false we're still accumulating a move
467         qboolean predicted; // if true the sequence should be sent as 0
468
469         // derived properties
470         double frametime;
471         qboolean canjump;
472         qboolean jump;
473         qboolean crouch;
474 } usercmd_t;
475
476 typedef struct lightstyle_s
477 {
478         int             length;
479         char    map[MAX_STYLESTRING];
480 } lightstyle_t;
481
482 typedef struct scoreboard_s
483 {
484         char    name[MAX_SCOREBOARDNAME];
485         int             frags;
486         int             colors; // two 4 bit fields
487         // QW fields:
488         int             qw_userid;
489         char    qw_userinfo[MAX_USERINFO_STRING];
490         float   qw_entertime;
491         int             qw_ping;
492         int             qw_packetloss;
493         int             qw_movementloss;
494         int             qw_spectator;
495         char    qw_team[8];
496         char    qw_skin[MAX_QPATH];
497 } scoreboard_t;
498
499 typedef struct cshift_s
500 {
501         float   destcolor[3];
502         float   percent;                // 0-255
503         float   alphafade;      // (any speed)
504 } cshift_t;
505
506 #define CSHIFT_CONTENTS 0
507 #define CSHIFT_DAMAGE   1
508 #define CSHIFT_BONUS    2
509 #define CSHIFT_POWERUP  3
510 #define CSHIFT_VCSHIFT  4
511 #define NUM_CSHIFTS             5
512
513 #define NAME_LENGTH     64
514
515
516 //
517 // client_state_t should hold all pieces of the client state
518 //
519
520 #define SIGNONS         4                       // signon messages to receive before connected
521
522 typedef enum cactive_e
523 {
524         ca_uninitialized,       // during early startup
525         ca_dedicated,           // a dedicated server with no ability to start a client
526         ca_disconnected,        // full screen console with no connection
527         ca_connected            // valid netcon, talking to a server
528 }
529 cactive_t;
530
531 typedef enum qw_downloadtype_e
532 {
533         dl_none,
534         dl_single,
535         dl_skin,
536         dl_model,
537         dl_sound
538 }
539 qw_downloadtype_t;
540
541 typedef enum capturevideoformat_e
542 {
543         CAPTUREVIDEOFORMAT_AVI_I420,
544         CAPTUREVIDEOFORMAT_OGG_VORBIS_THEORA
545 }
546 capturevideoformat_t;
547
548 typedef struct capturevideostate_s
549 {
550         double startrealtime;
551         double framerate;
552         int framestep;
553         int framestepframe;
554         qboolean active;
555         qboolean realtime;
556         qboolean error;
557         int soundrate;
558         int soundchannels;
559         int frame;
560         double starttime;
561         double lastfpstime;
562         int lastfpsframe;
563         int soundsampleframe;
564         unsigned char *screenbuffer;
565         unsigned char *outbuffer;
566         char basename[MAX_QPATH];
567         int width, height;
568
569         // precomputed RGB to YUV tables
570         // converts the RGB values to YUV (see cap_avi.c for how to use them)
571         short rgbtoyuvscaletable[3][3][256];
572         unsigned char yuvnormalizetable[3][256];
573
574         // precomputed gamma ramp (only needed if the capturevideo module uses RGB output)
575         // note: to map from these values to RGB24, you have to multiply by 255.0/65535.0, then add 0.5, then cast to integer
576         unsigned short vidramp[256 * 3];
577
578         // stuff to be filled in by the video format module
579         capturevideoformat_t format;
580         const char *formatextension;
581         qfile_t *videofile;
582                 // always use this:
583                 //   cls.capturevideo.videofile = FS_OpenRealFile(va(vabuf, sizeof(vabuf), "%s.%s", cls.capturevideo.basename, cls.capturevideo.formatextension), "wb", false);
584         void (*endvideo) (void);
585         void (*videoframes) (int num);
586         void (*soundframe) (const portable_sampleframe_t *paintbuffer, size_t length);
587
588         // format specific data
589         void *formatspecific;
590 }
591 capturevideostate_t;
592
593 #define CL_MAX_DOWNLOADACKS 4
594
595 typedef struct cl_downloadack_s
596 {
597         int start, size;
598 }
599 cl_downloadack_t;
600
601 typedef struct cl_soundstats_s
602 {
603         int mixedsounds;
604         int totalsounds;
605         int latency_milliseconds;
606 }
607 cl_soundstats_t;
608
609 //
610 // the client_static_t structure is persistent through an arbitrary number
611 // of server connections
612 //
613 typedef struct client_static_s
614 {
615         cactive_t state;
616
617         // all client memory allocations go in these pools
618         mempool_t *levelmempool;
619         mempool_t *permanentmempool;
620
621 // demo loop control
622         // -1 = don't play demos
623         int demonum;
624         // list of demos in loop
625         char demos[MAX_DEMOS][MAX_DEMONAME];
626         // the actively playing demo (set by CL_PlayDemo_f)
627         char demoname[MAX_QPATH];
628
629 // demo recording info must be here, because record is started before
630 // entering a map (and clearing client_state_t)
631         qboolean demorecording;
632         fs_offset_t demo_lastcsprogssize;
633         int demo_lastcsprogscrc;
634         qboolean demoplayback;
635         qboolean demostarting; // set if currently starting a demo, to stop -demo from quitting when switching to another demo
636         qboolean timedemo;
637         // -1 = use normal cd track
638         int forcetrack;
639         qfile_t *demofile;
640         // realtime at second frame of timedemo (LordHavoc: changed to double)
641         double td_starttime;
642         int td_frames; // total frames parsed
643         double td_onesecondnexttime;
644         double td_onesecondframes;
645         double td_onesecondrealtime;
646         double td_onesecondminfps;
647         double td_onesecondmaxfps;
648         double td_onesecondavgfps;
649         int td_onesecondavgcount;
650         // LordHavoc: pausedemo
651         qboolean demopaused;
652
653         // sound mixer statistics for showsound display
654         cl_soundstats_t soundstats;
655
656         qboolean connect_trying;
657         int connect_remainingtries;
658         double connect_nextsendtime;
659         lhnetsocket_t *connect_mysocket;
660         lhnetaddress_t connect_address;
661         // protocol version of the server we're connected to
662         // (kept outside client_state_t because it's used between levels)
663         protocolversion_t protocol;
664
665 #define MAX_RCONS 16
666         int rcon_trying;
667         lhnetaddress_t rcon_addresses[MAX_RCONS];
668         char rcon_commands[MAX_RCONS][MAX_INPUTLINE];
669         double rcon_timeout[MAX_RCONS];
670         int rcon_ringpos;
671
672 // connection information
673         // 0 to SIGNONS
674         int signon;
675         // network connection
676         netconn_t *netcon;
677
678         // download information
679         // (note: qw_download variables are also used)
680         cl_downloadack_t dp_downloadack[CL_MAX_DOWNLOADACKS];
681
682         // input sequence numbers are not reset on level change, only connect
683         int movesequence;
684         int servermovesequence;
685
686         // quakeworld stuff below
687
688         // value of "qport" cvar at time of connection
689         int qw_qport;
690         // copied from cls.netcon->qw. variables every time they change, or set by demos (which have no cls.netcon)
691         int qw_incoming_sequence;
692         int qw_outgoing_sequence;
693
694         // current file download buffer (only saved when file is completed)
695         char qw_downloadname[MAX_QPATH];
696         unsigned char *qw_downloadmemory;
697         int qw_downloadmemorycursize;
698         int qw_downloadmemorymaxsize;
699         int qw_downloadnumber;
700         int qw_downloadpercent;
701         qw_downloadtype_t qw_downloadtype;
702         // transfer rate display
703         double qw_downloadspeedtime;
704         int qw_downloadspeedcount;
705         int qw_downloadspeedrate;
706         qboolean qw_download_deflate;
707
708         // current file upload buffer (for uploading screenshots to server)
709         unsigned char *qw_uploaddata;
710         int qw_uploadsize;
711         int qw_uploadpos;
712
713         // user infostring
714         // this normally contains the following keys in quakeworld:
715         // password spectator name team skin topcolor bottomcolor rate noaim msg *ver *ip
716         char userinfo[MAX_USERINFO_STRING];
717
718         // extra user info for the "connect" command
719         char connect_userinfo[MAX_USERINFO_STRING];
720
721         // video capture stuff
722         capturevideostate_t capturevideo;
723
724         // crypto channel
725         crypto_t crypto;
726
727         // ProQuake compatibility stuff
728         int proquake_servermod; // 0 = not proquake, 1 = proquake
729         int proquake_serverversion; // actual proquake server version * 10 (3.40 = 34, etc)
730         int proquake_serverflags; // 0 (PQF_CHEATFREE not supported)
731 }
732 client_static_t;
733
734 extern client_static_t  cls;
735
736 typedef struct client_movementqueue_s
737 {
738         double time;
739         float frametime;
740         int sequence;
741         float viewangles[3];
742         float move[3];
743         qboolean jump;
744         qboolean crouch;
745         qboolean canjump;
746 }
747 client_movementqueue_t;
748
749 //[515]: csqc
750 typedef struct
751 {
752         qboolean drawworld;
753         qboolean drawenginesbar;
754         qboolean drawcrosshair;
755 }csqc_vidvars_t;
756
757 typedef enum
758 {
759         PARTICLE_BILLBOARD = 0,
760         PARTICLE_SPARK = 1,
761         PARTICLE_ORIENTED_DOUBLESIDED = 2,
762         PARTICLE_VBEAM = 3,
763         PARTICLE_HBEAM = 4,
764         PARTICLE_INVALID = -1
765 }
766 porientation_t;
767
768 typedef enum
769 {
770         PBLEND_ALPHA = 0,
771         PBLEND_ADD = 1,
772         PBLEND_INVMOD = 2,
773         PBLEND_INVALID = -1
774 }
775 pblend_t;
776
777 typedef struct particletype_s
778 {
779         pblend_t blendmode;
780         porientation_t orientation;
781         qboolean lighting;
782 }
783 particletype_t;
784
785 typedef enum ptype_e
786 {
787         pt_dead, 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
788 }
789 ptype_t;
790
791 typedef struct decal_s
792 {
793         // fields used by rendering:  (44 bytes)
794         unsigned short  typeindex;
795         unsigned short  texnum;
796         int                             decalsequence;
797         vec3_t                  org;
798         vec3_t                  normal;
799         float                   size;
800         float                   alpha; // 0-255
801         unsigned char   color[3];
802         unsigned char   unused1;
803         int                             clusterindex; // cheap culling by pvs
804
805         // fields not used by rendering: (36 bytes in 32bit, 40 bytes in 64bit)
806         float                   time2; // used for decal fade
807         unsigned int    owner; // decal stuck to this entity
808         dp_model_t                      *ownermodel; // model the decal is stuck to (used to make sure the entity is still alive)
809         vec3_t                  relativeorigin; // decal at this location in entity's coordinate space
810         vec3_t                  relativenormal; // decal oriented this way relative to entity's coordinate space
811 }
812 decal_t;
813
814 typedef struct particle_s
815 {
816         // for faster batch rendering, particles are rendered in groups by effect (resulting in less perfect sorting but far less state changes)
817
818         // fields used by rendering: (48 bytes)
819         vec3_t          sortorigin; // sort by this group origin, not particle org
820         vec3_t          org;
821         vec3_t          vel; // velocity of particle, or orientation of decal, or end point of beam
822         float           size;
823         float           alpha; // 0-255
824         float           stretch; // only for sparks
825
826         // fields not used by rendering:  (44 bytes)
827         float           stainsize;
828         float           stainalpha;
829         float           sizeincrease; // rate of size change per second
830         float           alphafade; // how much alpha reduces per second
831         float           time2; // used for snow fluttering and decal fade
832         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)
833         float           gravity; // how much gravity affects this particle (1.0 = normal gravity, 0.0 = none)
834         float           airfriction; // how much air friction affects this object (objects with a low mass/size ratio tend to get more air friction)
835         float           liquidfriction; // how much liquid friction affects this object (objects with a low mass/size ratio tend to get more liquid friction)
836 //      float           delayedcollisions; // time that p->bounce becomes active
837         float           delayedspawn; // time that particle appears and begins moving
838         float           die; // time when this particle should be removed, regardless of alpha
839
840         // short variables grouped to save memory (4 bytes)
841         short                   angle; // base rotation of particle
842         short                   spin; // geometry rotation speed around the particle center normal
843
844         // byte variables grouped to save memory (12 bytes)
845         unsigned char   color[3];
846         unsigned char   qualityreduction; // enables skipping of this particle according to r_refdef.view.qualityreduction
847         unsigned char   typeindex;
848         unsigned char   blendmode;
849         unsigned char   orientation;
850         unsigned char   texnum;
851         unsigned char   staincolor[3];
852         signed char     staintexnum;
853 }
854 particle_t;
855
856 typedef enum cl_parsingtextmode_e
857 {
858         CL_PARSETEXTMODE_NONE,
859         CL_PARSETEXTMODE_PING,
860         CL_PARSETEXTMODE_STATUS,
861         CL_PARSETEXTMODE_STATUS_PLAYERID,
862         CL_PARSETEXTMODE_STATUS_PLAYERIP
863 }
864 cl_parsingtextmode_t;
865
866 typedef struct cl_locnode_s
867 {
868         struct cl_locnode_s *next;
869         char *name;
870         vec3_t mins, maxs;
871 }
872 cl_locnode_t;
873
874 typedef struct showlmp_s
875 {
876         qboolean        isactive;
877         float           x;
878         float           y;
879         char            label[32];
880         char            pic[128];
881 }
882 showlmp_t;
883
884 //
885 // the client_state_t structure is wiped completely at every
886 // server signon
887 //
888 typedef struct client_state_s
889 {
890         // true if playing in a local game and no one else is connected
891         int islocalgame;
892
893         // send a clc_nop periodically until connected
894         float sendnoptime;
895
896         // current input being accumulated by mouse/joystick/etc input
897         usercmd_t cmd;
898         // latest moves sent to the server that have not been confirmed yet
899         usercmd_t movecmd[CL_MAX_USERCMDS];
900
901 // information for local display
902         // health, etc
903         int stats[MAX_CL_STATS];
904         float *statsf; // points to stats[] array
905         // last known inventory bit flags, for blinking
906         int olditems;
907         // cl.time of acquiring item, for blinking
908         float item_gettime[32];
909         // last known STAT_ACTIVEWEAPON
910         int activeweapon;
911         // cl.time of changing STAT_ACTIVEWEAPON
912         float weapontime;
913         // use pain anim frame if cl.time < this
914         float faceanimtime;
915         // for stair smoothing
916         float stairsmoothz;
917         double stairsmoothtime;
918
919         // color shifts for damage, powerups
920         cshift_t cshifts[NUM_CSHIFTS];
921         // and content types
922         cshift_t prev_cshifts[NUM_CSHIFTS];
923
924 // the client maintains its own idea of view angles, which are
925 // sent to the server each frame.  The server sets punchangle when
926 // the view is temporarily offset, and an angle reset commands at the start
927 // of each level and after teleporting.
928
929         // mviewangles is read from demo
930         // viewangles is either client controlled or lerped from mviewangles
931         vec3_t mviewangles[2], viewangles;
932         // update by server, used by qc to do weapon recoil
933         vec3_t mpunchangle[2], punchangle;
934         // update by server, can be used by mods to kick view around
935         vec3_t mpunchvector[2], punchvector;
936         // update by server, used for lean+bob (0 is newest)
937         vec3_t mvelocity[2], velocity;
938         // update by server, can be used by mods for zooming
939         vec_t mviewzoom[2], viewzoom;
940         // if true interpolation the mviewangles and other interpolation of the
941         // player is disabled until the next network packet
942         // this is used primarily by teleporters, and when spectating players
943         // special checking of the old fixangle[1] is used to differentiate
944         // between teleporting and spectating
945         qboolean fixangle[2];
946
947         // client movement simulation
948         // these fields are only updated by CL_ClientMovement (called by CL_SendMove after parsing each network packet)
949         // set by CL_ClientMovement_Replay functions
950         qboolean movement_predicted;
951         // if true the CL_ClientMovement_Replay function will update origin, etc
952         qboolean movement_replay;
953         // simulated data (this is valid even if cl.movement is false)
954         vec3_t movement_origin;
955         vec3_t movement_velocity;
956         // whether the replay should allow a jump at the first sequence
957         qboolean movement_replay_canjump;
958
959         // previous gun angles (for leaning effects)
960         vec3_t gunangles_prev;
961         vec3_t gunangles_highpass;
962         vec3_t gunangles_adjustment_lowpass;
963         vec3_t gunangles_adjustment_highpass;
964         // previous gun angles (for leaning effects)
965         vec3_t gunorg_prev;
966         vec3_t gunorg_highpass;
967         vec3_t gunorg_adjustment_lowpass;
968         vec3_t gunorg_adjustment_highpass;
969
970 // pitch drifting vars
971         float idealpitch;
972         float pitchvel;
973         qboolean nodrift;
974         float driftmove;
975         double laststop;
976
977 //[515]: added for csqc purposes
978         float sensitivityscale;
979         csqc_vidvars_t csqc_vidvars;    //[515]: these parms must be set to true by default
980         qboolean csqc_wantsmousemove;
981         qboolean csqc_paused; // vortex: int because could be flags
982         struct model_s *csqc_model_precache[MAX_MODELS];
983
984         // local amount for smoothing stepups
985         //float crouch;
986
987         // sent by server
988         qboolean paused;
989         qboolean onground;
990         qboolean inwater;
991
992         // used by bob
993         qboolean oldonground;
994         double lastongroundtime;
995         double hitgroundtime;
996         float bob2_smooth;
997         float bobfall_speed;
998         float bobfall_swing;
999
1000         // don't change view angle, full screen, etc
1001         int intermission;
1002         // latched at intermission start
1003         double completed_time;
1004
1005         // the timestamp of the last two messages
1006         double mtime[2];
1007
1008         // clients view of time, time should be between mtime[0] and mtime[1] to
1009         // generate a lerp point for other data, oldtime is the previous frame's
1010         // value of time, frametime is the difference between time and oldtime
1011         // note: cl.time may be beyond cl.mtime[0] if packet loss is occuring, it
1012         // is only forcefully limited when a packet is received
1013         double time, oldtime;
1014         // how long it has been since the previous client frame in real time
1015         // (not game time, for that use cl.time - cl.oldtime)
1016         double realframetime;
1017         
1018         // fade var for fading while dead
1019         float deathfade;
1020
1021         // motionblur alpha level variable
1022         float motionbluralpha;
1023
1024         // copy of realtime from last recieved message, for net trouble icon
1025         float last_received_message;
1026
1027 // information that is static for the entire time connected to a server
1028         struct model_s *model_precache[MAX_MODELS];
1029         struct sfx_s *sound_precache[MAX_SOUNDS];
1030
1031         // FIXME: this is a lot of memory to be keeping around, this really should be dynamically allocated and freed somehow
1032         char model_name[MAX_MODELS][MAX_QPATH];
1033         char sound_name[MAX_SOUNDS][MAX_QPATH];
1034
1035         // for display on solo scoreboard
1036         char worldmessage[40]; // map title (not related to filename)
1037         // variants of map name
1038         char worldbasename[MAX_QPATH]; // %s
1039         char worldname[MAX_QPATH]; // maps/%s.bsp
1040         char worldnamenoextension[MAX_QPATH]; // maps/%s
1041         // cl_entitites[cl.viewentity] = player
1042         int viewentity;
1043         // the real player entity (normally same as viewentity,
1044         // different than viewentity if mod uses chasecam or other tricks)
1045         int realplayerentity;
1046         // this is updated to match cl.viewentity whenever it is in the clients
1047         // range, basically this is used in preference to cl.realplayerentity for
1048         // most purposes because when spectating another player it should show
1049         // their information rather than yours
1050         int playerentity;
1051         // max players that can be in this game
1052         int maxclients;
1053         // type of game (deathmatch, coop, singleplayer)
1054         int gametype;
1055
1056         // models and sounds used by engine code (particularly cl_parse.c)
1057         dp_model_t *model_bolt;
1058         dp_model_t *model_bolt2;
1059         dp_model_t *model_bolt3;
1060         dp_model_t *model_beam;
1061         sfx_t *sfx_wizhit;
1062         sfx_t *sfx_knighthit;
1063         sfx_t *sfx_tink1;
1064         sfx_t *sfx_ric1;
1065         sfx_t *sfx_ric2;
1066         sfx_t *sfx_ric3;
1067         sfx_t *sfx_r_exp3;
1068         // indicates that the file "sound/misc/talk2.wav" was found (for use by team chat messages)
1069         qboolean foundtalk2wav;
1070
1071 // refresh related state
1072
1073         // cl_entitites[0].model
1074         struct model_s *worldmodel;
1075
1076         // the gun model
1077         entity_t viewent;
1078
1079         // cd audio
1080         int cdtrack, looptrack;
1081
1082 // frag scoreboard
1083
1084         // [cl.maxclients]
1085         scoreboard_t *scores;
1086
1087         // keep track of svc_print parsing state (analyzes ping reports and status reports)
1088         cl_parsingtextmode_t parsingtextmode;
1089         int parsingtextplayerindex;
1090         // set by scoreboard code when sending ping command, this causes the next ping results to be hidden
1091         // (which could eat the wrong ping report if the player issues one
1092         //  manually, but they would still see a ping report, just a later one
1093         //  caused by the scoreboard code rather than the one they intentionally
1094         //  issued)
1095         int parsingtextexpectingpingforscores;
1096
1097         // entity database stuff
1098         // latest received entity frame numbers
1099 #define LATESTFRAMENUMS 32
1100         int latestframenumsposition;
1101         int latestframenums[LATESTFRAMENUMS];
1102         int latestsendnums[LATESTFRAMENUMS];
1103         entityframe_database_t *entitydatabase;
1104         entityframe4_database_t *entitydatabase4;
1105         entityframeqw_database_t *entitydatabaseqw;
1106
1107         // keep track of quake entities because they need to be killed if they get stale
1108         int lastquakeentity;
1109         unsigned char isquakeentity[MAX_EDICTS];
1110
1111         // bounding boxes for clientside movement
1112         vec3_t playerstandmins;
1113         vec3_t playerstandmaxs;
1114         vec3_t playercrouchmins;
1115         vec3_t playercrouchmaxs;
1116
1117         // old decals are killed based on this
1118         int decalsequence;
1119
1120         int max_entities;
1121         int max_csqcrenderentities;
1122         int max_static_entities;
1123         int max_effects;
1124         int max_beams;
1125         int max_dlights;
1126         int max_lightstyle;
1127         int max_brushmodel_entities;
1128         int max_particles;
1129         int max_decals;
1130         int max_showlmps;
1131
1132         entity_t *entities;
1133         entity_render_t *csqcrenderentities;
1134         unsigned char *entities_active;
1135         entity_t *static_entities;
1136         cl_effect_t *effects;
1137         beam_t *beams;
1138         dlight_t *dlights;
1139         lightstyle_t *lightstyle;
1140         int *brushmodel_entities;
1141         particle_t *particles;
1142         decal_t *decals;
1143         showlmp_t *showlmps;
1144
1145         int num_entities;
1146         int num_static_entities;
1147         int num_brushmodel_entities;
1148         int num_effects;
1149         int num_beams;
1150         int num_dlights;
1151         int num_particles;
1152         int num_decals;
1153         int num_showlmps;
1154
1155         double particles_updatetime;
1156         double decals_updatetime;
1157         int free_particle;
1158         int free_decal;
1159
1160         // cl_serverextension_download feature
1161         int loadmodel_current;
1162         int downloadmodel_current;
1163         int loadmodel_total;
1164         int loadsound_current;
1165         int downloadsound_current;
1166         int loadsound_total;
1167         qboolean downloadcsqc;
1168         qboolean loadcsqc;
1169         qboolean loadbegun;
1170         qboolean loadfinished;
1171
1172         // quakeworld stuff
1173
1174         // local copy of the server infostring
1175         char qw_serverinfo[MAX_SERVERINFO_STRING];
1176
1177         // time of last qw "pings" command sent to server while showing scores
1178         double last_ping_request;
1179
1180         // used during connect
1181         int qw_servercount;
1182
1183         // updated from serverinfo
1184         int qw_teamplay;
1185
1186         // unused: indicates whether the player is spectating
1187         // use cl.scores[cl.playerentity-1].qw_spectator instead
1188         //qboolean qw_spectator;
1189
1190         // last time an input packet was sent
1191         double lastpackettime;
1192
1193         // movement parameters for client prediction
1194         unsigned int moveflags;
1195         float movevars_wallfriction;
1196         float movevars_waterfriction;
1197         float movevars_friction;
1198         float movevars_timescale;
1199         float movevars_gravity;
1200         float movevars_stopspeed;
1201         float movevars_maxspeed;
1202         float movevars_spectatormaxspeed;
1203         float movevars_accelerate;
1204         float movevars_airaccelerate;
1205         float movevars_wateraccelerate;
1206         float movevars_entgravity;
1207         float movevars_jumpvelocity;
1208         float movevars_edgefriction;
1209         float movevars_maxairspeed;
1210         float movevars_stepheight;
1211         float movevars_airaccel_qw;
1212         float movevars_airaccel_qw_stretchfactor;
1213         float movevars_airaccel_sideways_friction;
1214         float movevars_airstopaccelerate;
1215         float movevars_airstrafeaccelerate;
1216         float movevars_maxairstrafespeed;
1217         float movevars_airstrafeaccel_qw;
1218         float movevars_aircontrol;
1219         float movevars_aircontrol_power;
1220         float movevars_aircontrol_penalty;
1221         float movevars_warsowbunny_airforwardaccel;
1222         float movevars_warsowbunny_accel;
1223         float movevars_warsowbunny_topspeed;
1224         float movevars_warsowbunny_turnaccel;
1225         float movevars_warsowbunny_backtosideratio;
1226         float movevars_ticrate;
1227         float movevars_airspeedlimit_nonqw;
1228
1229         // models used by qw protocol
1230         int qw_modelindex_spike;
1231         int qw_modelindex_player;
1232         int qw_modelindex_flag;
1233         int qw_modelindex_s_explod;
1234
1235         vec3_t qw_intermission_origin;
1236         vec3_t qw_intermission_angles;
1237
1238         // 255 is the most nails the QW protocol could send
1239         int qw_num_nails;
1240         vec_t qw_nails[255][6];
1241
1242         float qw_weaponkick;
1243
1244         int qw_validsequence;
1245
1246         int qw_deltasequence[QW_UPDATE_BACKUP];
1247
1248         // csqc stuff:
1249         // server entity number corresponding to a clientside entity
1250         unsigned short csqc_server2csqcentitynumber[MAX_EDICTS];
1251         qboolean csqc_loaded;
1252         vec3_t csqc_vieworigin;
1253         vec3_t csqc_viewangles;
1254         vec3_t csqc_vieworiginfromengine;
1255         vec3_t csqc_viewanglesfromengine;
1256         matrix4x4_t csqc_viewmodelmatrixfromengine;
1257         qboolean csqc_usecsqclistener;
1258         matrix4x4_t csqc_listenermatrix;
1259         char csqc_printtextbuf[MAX_INPUTLINE];
1260
1261         // collision culling data
1262         world_t world;
1263
1264         // loc file stuff (points and boxes describing locations in the level)
1265         cl_locnode_t *locnodes;
1266         // this is updated to cl.movement_origin whenever health is < 1
1267         // used by %d print in say/say_team messages if cl_locs_enable is on
1268         vec3_t lastdeathorigin;
1269
1270         // processing buffer used by R_BuildLightMap, reallocated as needed,
1271         // freed on each level change
1272         size_t buildlightmapmemorysize;
1273         unsigned char *buildlightmapmemory;
1274
1275         // used by EntityState5_ReadUpdate
1276         skeleton_t *engineskeletonobjects;
1277 }
1278 client_state_t;
1279
1280 //
1281 // cvars
1282 //
1283 extern cvar_t cl_name;
1284 extern cvar_t cl_color;
1285 extern cvar_t cl_rate;
1286 extern cvar_t cl_pmodel;
1287 extern cvar_t cl_playermodel;
1288 extern cvar_t cl_playerskin;
1289
1290 extern cvar_t rcon_password;
1291 extern cvar_t rcon_address;
1292
1293 extern cvar_t cl_upspeed;
1294 extern cvar_t cl_forwardspeed;
1295 extern cvar_t cl_backspeed;
1296 extern cvar_t cl_sidespeed;
1297
1298 extern cvar_t cl_movespeedkey;
1299
1300 extern cvar_t cl_yawspeed;
1301 extern cvar_t cl_pitchspeed;
1302
1303 extern cvar_t cl_anglespeedkey;
1304
1305 extern cvar_t cl_autofire;
1306
1307 extern cvar_t cl_shownet;
1308 extern cvar_t cl_nolerp;
1309 extern cvar_t cl_nettimesyncfactor;
1310 extern cvar_t cl_nettimesyncboundmode;
1311 extern cvar_t cl_nettimesyncboundtolerance;
1312
1313 extern cvar_t cl_pitchdriftspeed;
1314 extern cvar_t lookspring;
1315 extern cvar_t lookstrafe;
1316 extern cvar_t sensitivity;
1317
1318 extern cvar_t freelook;
1319
1320 extern cvar_t m_pitch;
1321 extern cvar_t m_yaw;
1322 extern cvar_t m_forward;
1323 extern cvar_t m_side;
1324
1325 extern cvar_t cl_autodemo;
1326 extern cvar_t cl_autodemo_nameformat;
1327 extern cvar_t cl_autodemo_delete;
1328
1329 extern cvar_t r_draweffects;
1330
1331 extern cvar_t cl_explosions_alpha_start;
1332 extern cvar_t cl_explosions_alpha_end;
1333 extern cvar_t cl_explosions_size_start;
1334 extern cvar_t cl_explosions_size_end;
1335 extern cvar_t cl_explosions_lifetime;
1336 extern cvar_t cl_stainmaps;
1337 extern cvar_t cl_stainmaps_clearonload;
1338
1339 extern cvar_t cl_prydoncursor;
1340 extern cvar_t cl_prydoncursor_notrace;
1341
1342 extern cvar_t cl_locs_enable;
1343
1344 extern client_state_t cl;
1345
1346 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);
1347
1348 cl_locnode_t *CL_Locs_FindNearest(const vec3_t point);
1349 void CL_Locs_FindLocationName(char *buffer, size_t buffersize, vec3_t point);
1350
1351 //=============================================================================
1352
1353 //
1354 // cl_main
1355 //
1356
1357 void CL_Shutdown (void);
1358 void CL_Init (void);
1359
1360 void CL_EstablishConnection(const char *host, int firstarg);
1361
1362 void CL_Disconnect (void);
1363 void CL_Disconnect_f (void);
1364
1365 void CL_UpdateRenderEntity(entity_render_t *ent);
1366 void CL_SetEntityColormapColors(entity_render_t *ent, int colormap);
1367 void CL_UpdateViewEntities(void);
1368
1369 //
1370 // cl_input
1371 //
1372 typedef struct kbutton_s
1373 {
1374         int             down[2];                // key nums holding it down
1375         int             state;                  // low bit is down state
1376 }
1377 kbutton_t;
1378
1379 extern  kbutton_t       in_mlook, in_klook;
1380 extern  kbutton_t       in_strafe;
1381 extern  kbutton_t       in_speed;
1382
1383 void CL_InitInput (void);
1384 void CL_SendMove (void);
1385
1386 void CL_ValidateState(entity_state_t *s);
1387 void CL_MoveLerpEntityStates(entity_t *ent);
1388 void CL_LerpUpdate(entity_t *e);
1389 void CL_ParseTEnt (void);
1390 void CL_NewBeam (int ent, vec3_t start, vec3_t end, dp_model_t *m, int lightning);
1391 void CL_RelinkBeams (void);
1392 void CL_Beam_CalculatePositions (const beam_t *b, vec3_t start, vec3_t end);
1393 void CL_ClientMovement_Replay(void);
1394
1395 void CL_ClearTempEntities (void);
1396 entity_render_t *CL_NewTempEntity (double shadertime);
1397
1398 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
1399
1400 void CL_ClearState (void);
1401 void CL_ExpandEntities(int num);
1402 void CL_ExpandCSQCRenderEntities(int num);
1403 void CL_SetInfo(const char *key, const char *value, qboolean send, qboolean allowstarkey, qboolean allowmodel, qboolean quiet);
1404
1405
1406 void CL_UpdateWorld (void);
1407 void CL_WriteToServer (void);
1408 void CL_Input (void);
1409 extern int cl_ignoremousemoves;
1410
1411
1412 float CL_KeyState (kbutton_t *key);
1413 const char *Key_KeynumToString (int keynum, char *buf, size_t buflength);
1414 int Key_StringToKeynum (const char *str);
1415
1416 //
1417 // cl_demo.c
1418 //
1419 void CL_StopPlayback(void);
1420 void CL_ReadDemoMessage(void);
1421 void CL_WriteDemoMessage(sizebuf_t *mesage);
1422
1423 void CL_CutDemo(unsigned char **buf, fs_offset_t *filesize);
1424 void CL_PasteDemo(unsigned char **buf, fs_offset_t *filesize);
1425
1426 void CL_NextDemo(void);
1427 void CL_Stop_f(void);
1428 void CL_Record_f(void);
1429 void CL_PlayDemo_f(void);
1430 void CL_TimeDemo_f(void);
1431
1432 //
1433 // cl_parse.c
1434 //
1435 void CL_Parse_Init(void);
1436 void CL_Parse_Shutdown(void);
1437 void CL_ParseServerMessage(void);
1438 void CL_Parse_DumpPacket(void);
1439 void CL_Parse_ErrorCleanUp(void);
1440 void QW_CL_StartUpload(unsigned char *data, int size);
1441 extern cvar_t qport;
1442 void CL_KeepaliveMessage(qboolean readmessages); // call this during loading of large content
1443
1444 //
1445 // view
1446 //
1447 void V_StartPitchDrift (void);
1448 void V_StopPitchDrift (void);
1449
1450 void V_Init (void);
1451 float V_CalcRoll (vec3_t angles, vec3_t velocity);
1452 void V_UpdateBlends (void);
1453 void V_ParseDamage (void);
1454
1455 //
1456 // cl_part
1457 //
1458
1459 extern cvar_t cl_particles;
1460 extern cvar_t cl_particles_quality;
1461 extern cvar_t cl_particles_size;
1462 extern cvar_t cl_particles_quake;
1463 extern cvar_t cl_particles_blood;
1464 extern cvar_t cl_particles_blood_alpha;
1465 extern cvar_t cl_particles_blood_decal_alpha;
1466 extern cvar_t cl_particles_blood_decal_scalemin;
1467 extern cvar_t cl_particles_blood_decal_scalemax;
1468 extern cvar_t cl_particles_blood_bloodhack;
1469 extern cvar_t cl_particles_bulletimpacts;
1470 extern cvar_t cl_particles_explosions_sparks;
1471 extern cvar_t cl_particles_explosions_shell;
1472 extern cvar_t cl_particles_rain;
1473 extern cvar_t cl_particles_snow;
1474 extern cvar_t cl_particles_smoke;
1475 extern cvar_t cl_particles_smoke_alpha;
1476 extern cvar_t cl_particles_smoke_alphafade;
1477 extern cvar_t cl_particles_sparks;
1478 extern cvar_t cl_particles_bubbles;
1479 extern cvar_t cl_decals;
1480 extern cvar_t cl_decals_time;
1481 extern cvar_t cl_decals_fadetime;
1482
1483 void CL_Particles_Clear(void);
1484 void CL_Particles_Init(void);
1485 void CL_Particles_Shutdown(void);
1486 particle_t *CL_NewParticle(const vec3_t sortorigin, unsigned short ptypeindex, int pcolor1, int pcolor2, int ptex, float psize, float psizeincrease, float palpha, float palphafade, float pgravity, float pbounce, float px, float py, float pz, float pvx, float pvy, float pvz, float pairfriction, float pliquidfriction, float originjitter, float velocityjitter, qboolean pqualityreduction, float lifetime, float stretch, pblend_t blendmode, porientation_t orientation, int staincolor1, int staincolor2, int staintex, float stainalpha, float stainsize, float angle, float spin, float tint[4]);
1487
1488 typedef enum effectnameindex_s
1489 {
1490         EFFECT_NONE,
1491         EFFECT_TE_GUNSHOT,
1492         EFFECT_TE_GUNSHOTQUAD,
1493         EFFECT_TE_SPIKE,
1494         EFFECT_TE_SPIKEQUAD,
1495         EFFECT_TE_SUPERSPIKE,
1496         EFFECT_TE_SUPERSPIKEQUAD,
1497         EFFECT_TE_WIZSPIKE,
1498         EFFECT_TE_KNIGHTSPIKE,
1499         EFFECT_TE_EXPLOSION,
1500         EFFECT_TE_EXPLOSIONQUAD,
1501         EFFECT_TE_TAREXPLOSION,
1502         EFFECT_TE_TELEPORT,
1503         EFFECT_TE_LAVASPLASH,
1504         EFFECT_TE_SMALLFLASH,
1505         EFFECT_TE_FLAMEJET,
1506         EFFECT_EF_FLAME,
1507         EFFECT_TE_BLOOD,
1508         EFFECT_TE_SPARK,
1509         EFFECT_TE_PLASMABURN,
1510         EFFECT_TE_TEI_G3,
1511         EFFECT_TE_TEI_SMOKE,
1512         EFFECT_TE_TEI_BIGEXPLOSION,
1513         EFFECT_TE_TEI_PLASMAHIT,
1514         EFFECT_EF_STARDUST,
1515         EFFECT_TR_ROCKET,
1516         EFFECT_TR_GRENADE,
1517         EFFECT_TR_BLOOD,
1518         EFFECT_TR_WIZSPIKE,
1519         EFFECT_TR_SLIGHTBLOOD,
1520         EFFECT_TR_KNIGHTSPIKE,
1521         EFFECT_TR_VORESPIKE,
1522         EFFECT_TR_NEHAHRASMOKE,
1523         EFFECT_TR_NEXUIZPLASMA,
1524         EFFECT_TR_GLOWTRAIL,
1525         EFFECT_SVC_PARTICLE,
1526         EFFECT_TOTAL
1527 }
1528 effectnameindex_t;
1529
1530 int CL_ParticleEffectIndexForName(const char *name);
1531 const char *CL_ParticleEffectNameForIndex(int i);
1532 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);
1533 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, float tintmins[4], float tintmaxs[4]);
1534 void CL_ParseParticleEffect (void);
1535 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);
1536 void CL_ParticleRain (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, int type);
1537 void CL_EntityParticles (const entity_t *ent);
1538 void CL_ParticleExplosion (const vec3_t org);
1539 void CL_ParticleExplosion2 (const vec3_t org, int colorStart, int colorLength);
1540 void R_NewExplosion(const vec3_t org);
1541
1542 void Debug_PolygonBegin(const char *picname, int flags);
1543 void Debug_PolygonVertex(float x, float y, float z, float s, float t, float r, float g, float b, float a);
1544 void Debug_PolygonEnd(void);
1545
1546 #include "cl_screen.h"
1547
1548 extern qboolean sb_showscores;
1549
1550 float RSurf_FogVertex(const vec3_t p);
1551 float RSurf_FogPoint(const vec3_t p);
1552
1553 typedef struct r_refdef_stats_s
1554 {
1555         int renders;
1556         int entities;
1557         int entities_surfaces;
1558         int entities_triangles;
1559         int world_leafs;
1560         int world_portals;
1561         int world_surfaces;
1562         int world_triangles;
1563         int lightmapupdates;
1564         int lightmapupdatepixels;
1565         int particles;
1566         int drawndecals;
1567         int totaldecals;
1568         int draws;
1569         int draws_vertices;
1570         int draws_elements;
1571         int lights;
1572         int lights_clears;
1573         int lights_scissored;
1574         int lights_lighttriangles;
1575         int lights_shadowtriangles;
1576         int lights_dynamicshadowtriangles;
1577         int bouncegrid_lights;
1578         int bouncegrid_particles;
1579         int bouncegrid_traces;
1580         int bouncegrid_hits;
1581         int bouncegrid_splats;
1582         int bouncegrid_bounces;
1583         int collisioncache_animated;
1584         int collisioncache_cached;
1585         int collisioncache_traced;
1586         int bloom;
1587         int bloom_copypixels;
1588         int bloom_drawpixels;
1589         int indexbufferuploadcount;
1590         int indexbufferuploadsize;
1591         int vertexbufferuploadcount;
1592         int vertexbufferuploadsize;
1593         int framedatacurrent;
1594         int framedatasize;
1595 }
1596 r_refdef_stats_t;
1597
1598 typedef enum r_viewport_type_e
1599 {
1600         R_VIEWPORTTYPE_ORTHO,
1601         R_VIEWPORTTYPE_PERSPECTIVE,
1602         R_VIEWPORTTYPE_PERSPECTIVE_INFINITEFARCLIP,
1603         R_VIEWPORTTYPE_PERSPECTIVECUBESIDE,
1604         R_VIEWPORTTYPE_TOTAL
1605 }
1606 r_viewport_type_t;
1607
1608 typedef struct r_viewport_s
1609 {
1610         matrix4x4_t cameramatrix; // from entity (transforms from camera entity to world)
1611         matrix4x4_t viewmatrix; // actual matrix for rendering (transforms to viewspace)
1612         matrix4x4_t projectmatrix; // actual projection matrix (transforms from viewspace to screen)
1613         int x;
1614         int y;
1615         int z;
1616         int width;
1617         int height;
1618         int depth;
1619         r_viewport_type_t type;
1620         float screentodepth[2]; // used by deferred renderer to calculate linear depth from device depth coordinates
1621 }
1622 r_viewport_t;
1623
1624 typedef struct r_refdef_view_s
1625 {
1626         // view information (changes multiple times per frame)
1627         // if any of these variables change then r_refdef.viewcache must be regenerated
1628         // by calling R_View_Update
1629         // (which also updates viewport, scissor, colormask)
1630
1631         // it is safe and expected to copy this into a structure on the stack and
1632         // call the renderer recursively, then restore from the stack afterward
1633         // (as long as R_View_Update is called)
1634
1635         // eye position information
1636         matrix4x4_t matrix, inverse_matrix;
1637         vec3_t origin;
1638         vec3_t forward;
1639         vec3_t left;
1640         vec3_t right;
1641         vec3_t up;
1642         int numfrustumplanes;
1643         mplane_t frustum[6];
1644         qboolean useclipplane;
1645         qboolean usecustompvs; // uses r_refdef.viewcache.pvsbits as-is rather than computing it
1646         mplane_t clipplane;
1647         float frustum_x, frustum_y;
1648         vec3_t frustumcorner[4];
1649         // if turned off it renders an ortho view
1650         int useperspective;
1651         float ortho_x, ortho_y;
1652
1653         // screen area to render in
1654         int x;
1655         int y;
1656         int z;
1657         int width;
1658         int height;
1659         int depth;
1660         r_viewport_t viewport; // note: if r_viewscale is used, the viewport.width and viewport.height may be less than width and height
1661
1662         // which color components to allow (for anaglyph glasses)
1663         int colormask[4];
1664
1665         // global RGB color multiplier for rendering
1666         float colorscale;
1667
1668         // whether to call R_ClearScreen before rendering stuff
1669         qboolean clear;
1670         // if true, don't clear or do any post process effects (bloom, etc)
1671         qboolean isoverlay;
1672         // if true, this is the MAIN view (which is, after CSQC, copied into the scene for use e.g. by r_speeds 1, showtex, prydon cursor)
1673         qboolean ismain;
1674
1675         // whether to draw r_showtris and such, this is only true for the main
1676         // view render, all secondary renders (mirrors, portals, cameras,
1677         // distortion effects, etc) omit such debugging information
1678         qboolean showdebug;
1679
1680         // these define which values to use in GL_CullFace calls to request frontface or backface culling
1681         int cullface_front;
1682         int cullface_back;
1683
1684         // render quality (0 to 1) - affects r_drawparticles_drawdistance and others
1685         float quality;
1686 }
1687 r_refdef_view_t;
1688
1689 typedef struct r_refdef_viewcache_s
1690 {
1691         // updated by gl_main_newmap()
1692         int maxentities;
1693         int world_numclusters;
1694         int world_numclusterbytes;
1695         int world_numleafs;
1696         int world_numsurfaces;
1697
1698         // these properties are generated by R_View_Update()
1699
1700         // which entities are currently visible for this viewpoint
1701         // (the used range is 0...r_refdef.scene.numentities)
1702         unsigned char *entityvisible;
1703
1704         // flag arrays used for visibility checking on world model
1705         // (all other entities have no per-surface/per-leaf visibility checks)
1706         unsigned char *world_pvsbits;
1707         unsigned char *world_leafvisible;
1708         unsigned char *world_surfacevisible;
1709         // if true, the view is currently in a leaf without pvs data
1710         qboolean world_novis;
1711 }
1712 r_refdef_viewcache_t;
1713
1714 // TODO: really think about which fields should go into scene and which one should stay in refdef [1/7/2008 Black]
1715 // maybe also refactor some of the functions to support different setting sources (ie. fogenabled, etc.) for different scenes
1716 typedef struct r_refdef_scene_s {
1717         // whether to call S_ExtraUpdate during render to reduce sound chop
1718         qboolean extraupdate;
1719
1720         // (client gameworld) time for rendering time based effects
1721         double time;
1722
1723         // the world
1724         entity_render_t *worldentity;
1725
1726         // same as worldentity->model
1727         dp_model_t *worldmodel;
1728
1729         // renderable entities (excluding world)
1730         entity_render_t **entities;
1731         int numentities;
1732         int maxentities;
1733
1734         // field of temporary entities that is reset each (client) frame
1735         entity_render_t *tempentities;
1736         int numtempentities;
1737         int maxtempentities;
1738         qboolean expandtempentities;
1739
1740         // renderable dynamic lights
1741         rtlight_t *lights[MAX_DLIGHTS];
1742         rtlight_t templights[MAX_DLIGHTS];
1743         int numlights;
1744
1745         // intensities for light styles right now, controls rtlights
1746         float rtlightstylevalue[MAX_LIGHTSTYLES];       // float fraction of base light value
1747         // 8.8bit fixed point intensities for light styles
1748         // controls intensity lightmap layers
1749         unsigned short lightstylevalue[MAX_LIGHTSTYLES];        // 8.8 fraction of base light value
1750
1751         float ambient;
1752
1753         qboolean rtworld;
1754         qboolean rtworldshadows;
1755         qboolean rtdlight;
1756         qboolean rtdlightshadows;
1757 } r_refdef_scene_t;
1758
1759 typedef struct r_refdef_s
1760 {
1761         // these fields define the basic rendering information for the world
1762         // but not the view, which could change multiple times in one rendered
1763         // frame (for example when rendering textures for certain effects)
1764
1765         // these are set for water warping before
1766         // frustum_x/frustum_y are calculated
1767         float frustumscale_x, frustumscale_y;
1768
1769         // current view settings (these get reset a few times during rendering because of water rendering, reflections, etc)
1770         r_refdef_view_t view;
1771         r_refdef_viewcache_t viewcache;
1772
1773         // minimum visible distance (pixels closer than this disappear)
1774         double nearclip;
1775         // maximum visible distance (pixels further than this disappear in 16bpp modes,
1776         // in 32bpp an infinite-farclip matrix is used instead)
1777         double farclip;
1778
1779         // fullscreen color blend
1780         float viewblend[4];
1781
1782         r_refdef_scene_t scene;
1783
1784         float fogplane[4];
1785         float fogplaneviewdist;
1786         qboolean fogplaneviewabove;
1787         float fogheightfade;
1788         float fogcolor[3];
1789         float fogrange;
1790         float fograngerecip;
1791         float fogmasktabledistmultiplier;
1792 #define FOGMASKTABLEWIDTH 1024
1793         float fogmasktable[FOGMASKTABLEWIDTH];
1794         float fogmasktable_start, fogmasktable_alpha, fogmasktable_range, fogmasktable_density;
1795         float fog_density;
1796         float fog_red;
1797         float fog_green;
1798         float fog_blue;
1799         float fog_alpha;
1800         float fog_start;
1801         float fog_end;
1802         float fog_height;
1803         float fog_fadedepth;
1804         qboolean fogenabled;
1805         qboolean oldgl_fogenable;
1806
1807         // new flexible texture height fog (overrides normal fog)
1808         char fog_height_texturename[64]; // note: must be 64 for the sscanf code
1809         unsigned char *fog_height_table1d;
1810         unsigned char *fog_height_table2d;
1811         int fog_height_tablesize; // enable
1812         float fog_height_tablescale;
1813         float fog_height_texcoordscale;
1814         char fogheighttexturename[64]; // detects changes to active fog height texture
1815
1816         int draw2dstage; // 0 = no, 1 = yes, other value = needs setting up again
1817
1818         // true during envmap command capture
1819         qboolean envmap;
1820
1821         // brightness of world lightmaps and related lighting
1822         // (often reduced when world rtlights are enabled)
1823         float lightmapintensity;
1824         // whether to draw world lights realtime, dlights realtime, and their shadows
1825         float polygonfactor;
1826         float polygonoffset;
1827         float shadowpolygonfactor;
1828         float shadowpolygonoffset;
1829
1830         // how long R_RenderView took on the previous frame
1831         double lastdrawscreentime;
1832
1833         // rendering stats for r_speeds display
1834         // (these are incremented in many places)
1835         r_refdef_stats_t stats;
1836 }
1837 r_refdef_t;
1838
1839 extern r_refdef_t r_refdef;
1840
1841 typedef enum waterlevel_e
1842 {
1843         WATERLEVEL_NONE,
1844         WATERLEVEL_WETFEET,
1845         WATERLEVEL_SWIMMING,
1846         WATERLEVEL_SUBMERGED
1847 }
1848 waterlevel_t;
1849
1850 typedef struct cl_clientmovement_state_s
1851 {
1852         // position
1853         vec3_t origin;
1854         vec3_t velocity;
1855         // current bounding box (different if crouched vs standing)
1856         vec3_t mins;
1857         vec3_t maxs;
1858         // currently on the ground
1859         qboolean onground;
1860         // currently crouching
1861         qboolean crouched;
1862         // what kind of water (SUPERCONTENTS_LAVA for instance)
1863         int watertype;
1864         // how deep
1865         waterlevel_t waterlevel;
1866         // weird hacks when jumping out of water
1867         // (this is in seconds and counts down to 0)
1868         float waterjumptime;
1869
1870         // user command
1871         usercmd_t cmd;
1872 }
1873 cl_clientmovement_state_t;
1874 void CL_ClientMovement_PlayerMove_Frame(cl_clientmovement_state_t *s);
1875
1876 // warpzone prediction hack (CSQC builtin)
1877 void CL_RotateMoves(const matrix4x4_t *m);
1878
1879 void CL_NewFrameReceived(int num);
1880 void CL_ParseEntityLump(char *entitystring);
1881 void CL_FindNonSolidLocation(const vec3_t in, vec3_t out, vec_t radius);
1882 void CL_RelinkLightFlashes(void);
1883 void Sbar_ShowFPS(void);
1884 void Sbar_ShowFPS_Update(void);
1885 void Host_SaveConfig(void);
1886 void Host_LoadConfig_f(void);
1887 void CL_UpdateMoveVars(void);
1888 void SCR_CaptureVideo_SoundFrame(const portable_sampleframe_t *paintbuffer, size_t length);
1889 void V_DriftPitch(void);
1890 void V_FadeViewFlashs(void);
1891 void V_CalcViewBlend(void);
1892 void V_CalcRefdefUsing (const matrix4x4_t *entrendermatrix, const vec3_t clviewangles, qboolean teleported, qboolean clonground, qboolean clcmdjump, float clstatsviewheight);
1893 void V_CalcRefdef(void);
1894 void CL_Locs_Reload_f(void);
1895
1896 #endif
1897