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