new movement cvar and stat: sv_airaccel_qw_stretchfactor
[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 rtlight_t;
220
221 typedef struct dlight_s
222 {
223         // destroy light after this time
224         // (dlight only)
225         vec_t die;
226         // the entity that owns this light (can be NULL)
227         // (dlight only)
228         struct entity_render_s *ent;
229         // location
230         // (worldlight: saved to .rtlights file)
231         vec3_t origin;
232         // worldlight orientation
233         // (worldlight only)
234         // (worldlight: saved to .rtlights file)
235         vec3_t angles;
236         // dlight orientation/scaling/location
237         // (dlight only)
238         matrix4x4_t matrix;
239         // color of light
240         // (worldlight: saved to .rtlights file)
241         vec3_t color;
242         // cubemap name to use on this light
243         // (worldlight: saved to .rtlights file)
244         char cubemapname[64];
245         // make light flash while selected
246         // (worldlight only)
247         int selected;
248         // brightness (not really radius anymore)
249         // (worldlight: saved to .rtlights file)
250         vec_t radius;
251         // drop intensity this much each second
252         // (dlight only)
253         vec_t decay;
254         // intensity value which is dropped over time
255         // (dlight only)
256         vec_t intensity;
257         // initial values for intensity to modify
258         // (dlight only)
259         vec_t initialradius;
260         vec3_t initialcolor;
261         // light style which controls intensity of this light
262         // (worldlight: saved to .rtlights file)
263         int style;
264         // cast shadows
265         // (worldlight: saved to .rtlights file)
266         int shadow;
267         // corona intensity
268         // (worldlight: saved to .rtlights file)
269         vec_t corona;
270         // radius scale of corona to render (1.0 means same as light radius)
271         // (worldlight: saved to .rtlights file)
272         vec_t coronasizescale;
273         // ambient intensity to render
274         // (worldlight: saved to .rtlights file)
275         vec_t ambientscale;
276         // diffuse intensity to render
277         // (worldlight: saved to .rtlights file)
278         vec_t diffusescale;
279         // specular intensity to render
280         // (worldlight: saved to .rtlights file)
281         vec_t specularscale;
282         // LIGHTFLAG_* flags
283         // (worldlight: saved to .rtlights file)
284         int flags;
285         // linked list of world lights
286         // (worldlight only)
287         struct dlight_s *next;
288         // embedded rtlight struct for renderer
289         // (worldlight only)
290         rtlight_t rtlight;
291 }
292 dlight_t;
293
294 // this is derived from processing of the framegroupblend array
295 // note: technically each framegroupblend can produce two of these, but that
296 // never happens in practice because no one blends between more than 2
297 // framegroups at once
298 #define MAX_FRAMEBLENDS (MAX_FRAMEGROUPBLENDS * 2)
299 typedef struct frameblend_s
300 {
301         int subframe;
302         float lerp;
303 }
304 frameblend_t;
305
306 // LordHavoc: this struct is intended for the renderer but some fields are
307 // used by the client.
308 //
309 // The renderer should not rely on any changes to this struct to be persistent
310 // across multiple frames because temp entities are wiped every frame, but it
311 // is acceptable to cache things in this struct that are not critical.
312 //
313 // For example the r_cullentities_trace code does such caching.
314 typedef struct entity_render_s
315 {
316         // location
317         //vec3_t origin;
318         // orientation
319         //vec3_t angles;
320         // transform matrix for model to world
321         matrix4x4_t matrix;
322         // transform matrix for world to model
323         matrix4x4_t inversematrix;
324         // opacity (alpha) of the model
325         float alpha;
326         // size the model is shown
327         float scale;
328         // transparent sorting offset
329         float transparent_offset;
330
331         // NULL = no model
332         dp_model_t *model;
333         // number of the entity represents, or 0 for non-network entities
334         int entitynumber;
335         // literal colormap colors for renderer, if both are 0 0 0 it is not colormapped
336         vec3_t colormap_pantscolor;
337         vec3_t colormap_shirtcolor;
338         // light, particles, etc
339         int effects;
340         // qw CTF flags and other internal-use-only effect bits
341         int internaleffects;
342         // for Alias models
343         int skinnum;
344         // render flags
345         int flags;
346
347         // colormod tinting of models
348         float colormod[3];
349         float glowmod[3];
350
351         // interpolated animation - active framegroups and blend factors
352         framegroupblend_t framegroupblend[MAX_FRAMEGROUPBLENDS];
353
354         // time of last model change (for shader animations)
355         double shadertime;
356
357         // calculated by the renderer (but not persistent)
358
359         // calculated during R_AddModelEntities
360         vec3_t mins, maxs;
361         // subframe numbers (-1 if not used) and their blending scalers (0-1), if interpolation is not desired, use subframeblend[0].subframe
362         frameblend_t frameblend[MAX_FRAMEBLENDS];
363         // skeletal animation data (if skeleton.relativetransforms is not NULL, it overrides frameblend)
364         skeleton_t *skeleton;
365
366         // animation cache (pointers allocated using R_FrameData_Alloc)
367         // ONLY valid during R_RenderView!  may be NULL (not cached)
368         float *animcache_vertex3f;
369         float *animcache_normal3f;
370         float *animcache_svector3f;
371         float *animcache_tvector3f;
372         // interleaved arrays for rendering and dynamic vertex buffers for them
373         r_meshbuffer_t *animcache_vertex3fbuffer;
374         r_vertexmesh_t *animcache_vertexmesh;
375         r_meshbuffer_t *animcache_vertexmeshbuffer;
376
377         // current lighting from map (updated ONLY by client code, not renderer)
378         vec3_t modellight_ambient;
379         vec3_t modellight_diffuse; // q3bsp
380         vec3_t modellight_lightdir; // q3bsp
381
382         // storage of decals on this entity
383         // (note: if allowdecals is set, be sure to call R_DecalSystem_Reset on removal!)
384         int allowdecals;
385         decalsystem_t decalsystem;
386
387         // FIELDS UPDATED BY RENDERER:
388         // last time visible during trace culling
389         double last_trace_visibility;
390
391         // user wavefunc parameters (from csqc)
392         float userwavefunc_param[Q3WAVEFUNC_USER_COUNT];
393 }
394 entity_render_t;
395
396 typedef struct entity_persistent_s
397 {
398         vec3_t trail_origin;
399
400         // particle trail
401         float trail_time;
402         qboolean trail_allowed; // set to false by teleports, true by update code, prevents bad lerps
403
404         // muzzleflash fading
405         float muzzleflash;
406
407         // interpolated movement
408
409         // start time of move
410         float lerpstarttime;
411         // time difference from start to end of move
412         float lerpdeltatime;
413         // the move itself, start and end
414         float oldorigin[3];
415         float oldangles[3];
416         float neworigin[3];
417         float newangles[3];
418 }
419 entity_persistent_t;
420
421 typedef struct entity_s
422 {
423         // baseline state (default values)
424         entity_state_t state_baseline;
425         // previous state (interpolating from this)
426         entity_state_t state_previous;
427         // current state (interpolating to this)
428         entity_state_t state_current;
429
430         // used for regenerating parts of render
431         entity_persistent_t persistent;
432
433         // the only data the renderer should know about
434         entity_render_t render;
435 }
436 entity_t;
437
438 typedef struct usercmd_s
439 {
440         vec3_t  viewangles;
441
442 // intended velocities
443         float   forwardmove;
444         float   sidemove;
445         float   upmove;
446
447         vec3_t  cursor_screen;
448         vec3_t  cursor_start;
449         vec3_t  cursor_end;
450         vec3_t  cursor_impact;
451         vec3_t  cursor_normal;
452         vec_t   cursor_fraction;
453         int             cursor_entitynumber;
454
455         double time; // time the move is executed for (cl_movement: clienttime, non-cl_movement: receivetime)
456         double receivetime; // time the move was received at
457         double clienttime; // time to which server state the move corresponds to
458         int msec; // for predicted moves
459         int buttons;
460         int impulse;
461         int sequence;
462         qboolean applied; // if false we're still accumulating a move
463         qboolean predicted; // if true the sequence should be sent as 0
464
465         // derived properties
466         double frametime;
467         qboolean canjump;
468         qboolean jump;
469         qboolean crouch;
470 } usercmd_t;
471
472 typedef struct lightstyle_s
473 {
474         int             length;
475         char    map[MAX_STYLESTRING];
476 } lightstyle_t;
477
478 typedef struct scoreboard_s
479 {
480         char    name[MAX_SCOREBOARDNAME];
481         int             frags;
482         int             colors; // two 4 bit fields
483         // QW fields:
484         int             qw_userid;
485         char    qw_userinfo[MAX_USERINFO_STRING];
486         float   qw_entertime;
487         int             qw_ping;
488         int             qw_packetloss;
489         int             qw_movementloss;
490         int             qw_spectator;
491         char    qw_team[8];
492         char    qw_skin[MAX_QPATH];
493 } scoreboard_t;
494
495 typedef struct cshift_s
496 {
497         float   destcolor[3];
498         float   percent;                // 0-255
499         float   alphafade;      // (any speed)
500 } cshift_t;
501
502 #define CSHIFT_CONTENTS 0
503 #define CSHIFT_DAMAGE   1
504 #define CSHIFT_BONUS    2
505 #define CSHIFT_POWERUP  3
506 #define CSHIFT_VCSHIFT  4
507 #define NUM_CSHIFTS             5
508
509 #define NAME_LENGTH     64
510
511
512 //
513 // client_state_t should hold all pieces of the client state
514 //
515
516 #define SIGNONS         4                       // signon messages to receive before connected
517
518 typedef enum cactive_e
519 {
520         ca_uninitialized,       // during early startup
521         ca_dedicated,           // a dedicated server with no ability to start a client
522         ca_disconnected,        // full screen console with no connection
523         ca_connected            // valid netcon, talking to a server
524 }
525 cactive_t;
526
527 typedef enum qw_downloadtype_e
528 {
529         dl_none,
530         dl_single,
531         dl_skin,
532         dl_model,
533         dl_sound
534 }
535 qw_downloadtype_t;
536
537 typedef enum capturevideoformat_e
538 {
539         CAPTUREVIDEOFORMAT_AVI_I420,
540         CAPTUREVIDEOFORMAT_OGG_VORBIS_THEORA
541 }
542 capturevideoformat_t;
543
544 typedef struct capturevideostate_s
545 {
546         double startrealtime;
547         double framerate;
548         int framestep;
549         int framestepframe;
550         qboolean active;
551         qboolean realtime;
552         qboolean error;
553         int soundrate;
554         int soundchannels;
555         int frame;
556         double starttime;
557         double lastfpstime;
558         int lastfpsframe;
559         int soundsampleframe;
560         unsigned char *screenbuffer;
561         unsigned char *outbuffer;
562         char basename[MAX_QPATH];
563         int width, height;
564
565         // precomputed RGB to YUV tables
566         // converts the RGB values to YUV (see cap_avi.c for how to use them)
567         short rgbtoyuvscaletable[3][3][256];
568         unsigned char yuvnormalizetable[3][256];
569
570         // precomputed gamma ramp (only needed if the capturevideo module uses RGB output)
571         // 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
572         unsigned short vidramp[256 * 3];
573
574         // stuff to be filled in by the video format module
575         capturevideoformat_t format;
576         const char *formatextension;
577         qfile_t *videofile;
578                 // always use this:
579                 //   cls.capturevideo.videofile = FS_OpenRealFile(va("%s.%s", cls.capturevideo.basename, cls.capturevideo.formatextension), "wb", false);
580         void (*endvideo) (void);
581         void (*videoframes) (int num);
582         void (*soundframe) (const portable_sampleframe_t *paintbuffer, size_t length);
583
584         // format specific data
585         void *formatspecific;
586 }
587 capturevideostate_t;
588
589 #define CL_MAX_DOWNLOADACKS 4
590
591 typedef struct cl_downloadack_s
592 {
593         int start, size;
594 }
595 cl_downloadack_t;
596
597 typedef struct cl_soundstats_s
598 {
599         int mixedsounds;
600         int totalsounds;
601         int latency_milliseconds;
602 }
603 cl_soundstats_t;
604
605 //
606 // the client_static_t structure is persistent through an arbitrary number
607 // of server connections
608 //
609 typedef struct client_static_s
610 {
611         cactive_t state;
612
613         // all client memory allocations go in these pools
614         mempool_t *levelmempool;
615         mempool_t *permanentmempool;
616
617 // demo loop control
618         // -1 = don't play demos
619         int demonum;
620         // list of demos in loop
621         char demos[MAX_DEMOS][MAX_DEMONAME];
622         // the actively playing demo (set by CL_PlayDemo_f)
623         char demoname[MAX_QPATH];
624
625 // demo recording info must be here, because record is started before
626 // entering a map (and clearing client_state_t)
627         qboolean demorecording;
628         fs_offset_t demo_lastcsprogssize;
629         int demo_lastcsprogscrc;
630         qboolean demoplayback;
631         qboolean timedemo;
632         // -1 = use normal cd track
633         int forcetrack;
634         qfile_t *demofile;
635         // realtime at second frame of timedemo (LordHavoc: changed to double)
636         double td_starttime;
637         int td_frames; // total frames parsed
638         double td_onesecondnexttime;
639         double td_onesecondframes;
640         double td_onesecondrealtime;
641         double td_onesecondminfps;
642         double td_onesecondmaxfps;
643         double td_onesecondavgfps;
644         int td_onesecondavgcount;
645         // LordHavoc: pausedemo
646         qboolean demopaused;
647
648         // sound mixer statistics for showsound display
649         cl_soundstats_t soundstats;
650
651         qboolean connect_trying;
652         int connect_remainingtries;
653         double connect_nextsendtime;
654         lhnetsocket_t *connect_mysocket;
655         lhnetaddress_t connect_address;
656         // protocol version of the server we're connected to
657         // (kept outside client_state_t because it's used between levels)
658         protocolversion_t protocol;
659
660 #define MAX_RCONS 16
661         int rcon_trying;
662         lhnetaddress_t rcon_addresses[MAX_RCONS];
663         char rcon_commands[MAX_RCONS][MAX_INPUTLINE];
664         double rcon_timeout[MAX_RCONS];
665         int rcon_ringpos;
666
667 // connection information
668         // 0 to SIGNONS
669         int signon;
670         // network connection
671         netconn_t *netcon;
672
673         // download information
674         // (note: qw_download variables are also used)
675         cl_downloadack_t dp_downloadack[CL_MAX_DOWNLOADACKS];
676
677         // input sequence numbers are not reset on level change, only connect
678         int movesequence;
679         int servermovesequence;
680
681         // quakeworld stuff below
682
683         // value of "qport" cvar at time of connection
684         int qw_qport;
685         // copied from cls.netcon->qw. variables every time they change, or set by demos (which have no cls.netcon)
686         int qw_incoming_sequence;
687         int qw_outgoing_sequence;
688
689         // current file download buffer (only saved when file is completed)
690         char qw_downloadname[MAX_QPATH];
691         unsigned char *qw_downloadmemory;
692         int qw_downloadmemorycursize;
693         int qw_downloadmemorymaxsize;
694         int qw_downloadnumber;
695         int qw_downloadpercent;
696         qw_downloadtype_t qw_downloadtype;
697         // transfer rate display
698         double qw_downloadspeedtime;
699         int qw_downloadspeedcount;
700         int qw_downloadspeedrate;
701         qboolean qw_download_deflate;
702
703         // current file upload buffer (for uploading screenshots to server)
704         unsigned char *qw_uploaddata;
705         int qw_uploadsize;
706         int qw_uploadpos;
707
708         // user infostring
709         // this normally contains the following keys in quakeworld:
710         // password spectator name team skin topcolor bottomcolor rate noaim msg *ver *ip
711         char userinfo[MAX_USERINFO_STRING];
712
713         // extra user info for the "connect" command
714         char connect_userinfo[MAX_USERINFO_STRING];
715
716         // video capture stuff
717         capturevideostate_t capturevideo;
718
719         // crypto channel
720         crypto_t crypto;
721
722         // ProQuake compatibility stuff
723         int proquake_servermod; // 0 = not proquake, 1 = proquake
724         int proquake_serverversion; // actual proquake server version * 10 (3.40 = 34, etc)
725         int proquake_serverflags; // 0 (PQF_CHEATFREE not supported)
726 }
727 client_static_t;
728
729 extern client_static_t  cls;
730
731 typedef struct client_movementqueue_s
732 {
733         double time;
734         float frametime;
735         int sequence;
736         float viewangles[3];
737         float move[3];
738         qboolean jump;
739         qboolean crouch;
740         qboolean canjump;
741 }
742 client_movementqueue_t;
743
744 //[515]: csqc
745 typedef struct
746 {
747         qboolean drawworld;
748         qboolean drawenginesbar;
749         qboolean drawcrosshair;
750 }csqc_vidvars_t;
751
752 typedef enum
753 {
754         PARTICLE_BILLBOARD = 0,
755         PARTICLE_SPARK = 1,
756         PARTICLE_ORIENTED_DOUBLESIDED = 2,
757         PARTICLE_VBEAM = 3,
758         PARTICLE_HBEAM = 4,
759         PARTICLE_INVALID = -1
760 }
761 porientation_t;
762
763 typedef enum
764 {
765         PBLEND_ALPHA = 0,
766         PBLEND_ADD = 1,
767         PBLEND_INVMOD = 2,
768         PBLEND_INVALID = -1
769 }
770 pblend_t;
771
772 typedef struct particletype_s
773 {
774         pblend_t blendmode;
775         porientation_t orientation;
776         qboolean lighting;
777 }
778 particletype_t;
779
780 typedef enum ptype_e
781 {
782         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
783 }
784 ptype_t;
785
786 typedef struct decal_s
787 {
788         // fields used by rendering:  (44 bytes)
789         unsigned short  typeindex;
790         unsigned short  texnum;
791         int                             decalsequence;
792         vec3_t                  org;
793         vec3_t                  normal;
794         float                   size;
795         float                   alpha; // 0-255
796         unsigned char   color[3];
797         unsigned char   unused1;
798         int                             clusterindex; // cheap culling by pvs
799
800         // fields not used by rendering: (36 bytes in 32bit, 40 bytes in 64bit)
801         float                   time2; // used for decal fade
802         unsigned int    owner; // decal stuck to this entity
803         dp_model_t                      *ownermodel; // model the decal is stuck to (used to make sure the entity is still alive)
804         vec3_t                  relativeorigin; // decal at this location in entity's coordinate space
805         vec3_t                  relativenormal; // decal oriented this way relative to entity's coordinate space
806 }
807 decal_t;
808
809 typedef struct particle_s
810 {
811         // for faster batch rendering, particles are rendered in groups by effect (resulting in less perfect sorting but far less state changes)
812
813         // fields used by rendering: (48 bytes)
814         vec3_t          sortorigin; // sort by this group origin, not particle org
815         vec3_t          org;
816         vec3_t          vel; // velocity of particle, or orientation of decal, or end point of beam
817         float           size;
818         float           alpha; // 0-255
819         float           stretch; // only for sparks
820
821         // fields not used by rendering:  (44 bytes)
822         float           stainsize;
823         float           stainalpha;
824         float           sizeincrease; // rate of size change per second
825         float           alphafade; // how much alpha reduces per second
826         float           time2; // used for snow fluttering and decal fade
827         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)
828         float           gravity; // how much gravity affects this particle (1.0 = normal gravity, 0.0 = none)
829         float           airfriction; // how much air friction affects this object (objects with a low mass/size ratio tend to get more air friction)
830         float           liquidfriction; // how much liquid friction affects this object (objects with a low mass/size ratio tend to get more liquid friction)
831 //      float           delayedcollisions; // time that p->bounce becomes active
832         float           delayedspawn; // time that particle appears and begins moving
833         float           die; // time when this particle should be removed, regardless of alpha
834
835         // short variables grouped to save memory (4 bytes)
836         short                   angle; // base rotation of particle
837         short                   spin; // geometry rotation speed around the particle center normal
838
839         // byte variables grouped to save memory (12 bytes)
840         unsigned char   color[3];
841         unsigned char   qualityreduction; // enables skipping of this particle according to r_refdef.view.qualityreduction
842         unsigned char   typeindex;
843         unsigned char   blendmode;
844         unsigned char   orientation;
845         unsigned char   texnum;
846         unsigned char   staincolor[3];
847         signed char     staintexnum;
848 }
849 particle_t;
850
851 typedef enum cl_parsingtextmode_e
852 {
853         CL_PARSETEXTMODE_NONE,
854         CL_PARSETEXTMODE_PING,
855         CL_PARSETEXTMODE_STATUS,
856         CL_PARSETEXTMODE_STATUS_PLAYERID,
857         CL_PARSETEXTMODE_STATUS_PLAYERIP
858 }
859 cl_parsingtextmode_t;
860
861 typedef struct cl_locnode_s
862 {
863         struct cl_locnode_s *next;
864         char *name;
865         vec3_t mins, maxs;
866 }
867 cl_locnode_t;
868
869 typedef struct showlmp_s
870 {
871         qboolean        isactive;
872         float           x;
873         float           y;
874         char            label[32];
875         char            pic[128];
876 }
877 showlmp_t;
878
879 //
880 // the client_state_t structure is wiped completely at every
881 // server signon
882 //
883 typedef struct client_state_s
884 {
885         // true if playing in a local game and no one else is connected
886         int islocalgame;
887
888         // send a clc_nop periodically until connected
889         float sendnoptime;
890
891         // current input being accumulated by mouse/joystick/etc input
892         usercmd_t cmd;
893         // latest moves sent to the server that have not been confirmed yet
894         usercmd_t movecmd[CL_MAX_USERCMDS];
895
896 // information for local display
897         // health, etc
898         int stats[MAX_CL_STATS];
899         float *statsf; // points to stats[] array
900         // last known inventory bit flags, for blinking
901         int olditems;
902         // cl.time of acquiring item, for blinking
903         float item_gettime[32];
904         // last known STAT_ACTIVEWEAPON
905         int activeweapon;
906         // cl.time of changing STAT_ACTIVEWEAPON
907         float weapontime;
908         // use pain anim frame if cl.time < this
909         float faceanimtime;
910         // for stair smoothing
911         float stairsmoothz;
912         double stairsmoothtime;
913
914         // color shifts for damage, powerups
915         cshift_t cshifts[NUM_CSHIFTS];
916         // and content types
917         cshift_t prev_cshifts[NUM_CSHIFTS];
918
919 // the client maintains its own idea of view angles, which are
920 // sent to the server each frame.  The server sets punchangle when
921 // the view is temporarily offset, and an angle reset commands at the start
922 // of each level and after teleporting.
923
924         // mviewangles is read from demo
925         // viewangles is either client controlled or lerped from mviewangles
926         vec3_t mviewangles[2], viewangles;
927         // update by server, used by qc to do weapon recoil
928         vec3_t mpunchangle[2], punchangle;
929         // update by server, can be used by mods to kick view around
930         vec3_t mpunchvector[2], punchvector;
931         // update by server, used for lean+bob (0 is newest)
932         vec3_t mvelocity[2], velocity;
933         // update by server, can be used by mods for zooming
934         vec_t mviewzoom[2], viewzoom;
935         // if true interpolation the mviewangles and other interpolation of the
936         // player is disabled until the next network packet
937         // this is used primarily by teleporters, and when spectating players
938         // special checking of the old fixangle[1] is used to differentiate
939         // between teleporting and spectating
940         qboolean fixangle[2];
941
942         // client movement simulation
943         // these fields are only updated by CL_ClientMovement (called by CL_SendMove after parsing each network packet)
944         // set by CL_ClientMovement_Replay functions
945         qboolean movement_predicted;
946         // if true the CL_ClientMovement_Replay function will update origin, etc
947         qboolean movement_replay;
948         // simulated data (this is valid even if cl.movement is false)
949         vec3_t movement_origin;
950         vec3_t movement_velocity;
951         // whether the replay should allow a jump at the first sequence
952         qboolean movement_replay_canjump;
953
954         // previous gun angles (for leaning effects)
955         vec3_t gunangles_prev;
956         vec3_t gunangles_highpass;
957         vec3_t gunangles_adjustment_lowpass;
958         vec3_t gunangles_adjustment_highpass;
959         // previous gun angles (for leaning effects)
960         vec3_t gunorg_prev;
961         vec3_t gunorg_highpass;
962         vec3_t gunorg_adjustment_lowpass;
963         vec3_t gunorg_adjustment_highpass;
964
965 // pitch drifting vars
966         float idealpitch;
967         float pitchvel;
968         qboolean nodrift;
969         float driftmove;
970         double laststop;
971
972 //[515]: added for csqc purposes
973         float sensitivityscale;
974         csqc_vidvars_t csqc_vidvars;    //[515]: these parms must be set to true by default
975         qboolean csqc_wantsmousemove;
976         qboolean csqc_paused; // vortex: int because could be flags
977         struct model_s *csqc_model_precache[MAX_MODELS];
978
979         // local amount for smoothing stepups
980         //float crouch;
981
982         // sent by server
983         qboolean paused;
984         qboolean onground;
985         qboolean inwater;
986
987         // used by bob
988         qboolean oldonground;
989         double lastongroundtime;
990         double hitgroundtime;
991         float bob2_smooth;
992         float bobfall_speed;
993         float bobfall_swing;
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         qboolean csqc_usecsqclistener;
1252         matrix4x4_t csqc_listenermatrix;
1253         char csqc_printtextbuf[MAX_INPUTLINE];
1254
1255         // collision culling data
1256         world_t world;
1257
1258         // loc file stuff (points and boxes describing locations in the level)
1259         cl_locnode_t *locnodes;
1260         // this is updated to cl.movement_origin whenever health is < 1
1261         // used by %d print in say/say_team messages if cl_locs_enable is on
1262         vec3_t lastdeathorigin;
1263
1264         // processing buffer used by R_BuildLightMap, reallocated as needed,
1265         // freed on each level change
1266         size_t buildlightmapmemorysize;
1267         unsigned char *buildlightmapmemory;
1268
1269         // used by EntityState5_ReadUpdate
1270         skeleton_t *engineskeletonobjects;
1271 }
1272 client_state_t;
1273
1274 //
1275 // cvars
1276 //
1277 extern cvar_t cl_name;
1278 extern cvar_t cl_color;
1279 extern cvar_t cl_rate;
1280 extern cvar_t cl_pmodel;
1281 extern cvar_t cl_playermodel;
1282 extern cvar_t cl_playerskin;
1283
1284 extern cvar_t rcon_password;
1285 extern cvar_t rcon_address;
1286
1287 extern cvar_t cl_upspeed;
1288 extern cvar_t cl_forwardspeed;
1289 extern cvar_t cl_backspeed;
1290 extern cvar_t cl_sidespeed;
1291
1292 extern cvar_t cl_movespeedkey;
1293
1294 extern cvar_t cl_yawspeed;
1295 extern cvar_t cl_pitchspeed;
1296
1297 extern cvar_t cl_anglespeedkey;
1298
1299 extern cvar_t cl_autofire;
1300
1301 extern cvar_t cl_shownet;
1302 extern cvar_t cl_nolerp;
1303 extern cvar_t cl_nettimesyncfactor;
1304 extern cvar_t cl_nettimesyncboundmode;
1305 extern cvar_t cl_nettimesyncboundtolerance;
1306
1307 extern cvar_t cl_pitchdriftspeed;
1308 extern cvar_t lookspring;
1309 extern cvar_t lookstrafe;
1310 extern cvar_t sensitivity;
1311
1312 extern cvar_t freelook;
1313
1314 extern cvar_t m_pitch;
1315 extern cvar_t m_yaw;
1316 extern cvar_t m_forward;
1317 extern cvar_t m_side;
1318
1319 extern cvar_t cl_autodemo;
1320 extern cvar_t cl_autodemo_nameformat;
1321 extern cvar_t cl_autodemo_delete;
1322
1323 extern cvar_t r_draweffects;
1324
1325 extern cvar_t cl_explosions_alpha_start;
1326 extern cvar_t cl_explosions_alpha_end;
1327 extern cvar_t cl_explosions_size_start;
1328 extern cvar_t cl_explosions_size_end;
1329 extern cvar_t cl_explosions_lifetime;
1330 extern cvar_t cl_stainmaps;
1331 extern cvar_t cl_stainmaps_clearonload;
1332
1333 extern cvar_t cl_prydoncursor;
1334 extern cvar_t cl_prydoncursor_notrace;
1335
1336 extern cvar_t cl_locs_enable;
1337
1338 extern client_state_t cl;
1339
1340 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);
1341
1342 cl_locnode_t *CL_Locs_FindNearest(const vec3_t point);
1343 void CL_Locs_FindLocationName(char *buffer, size_t buffersize, vec3_t point);
1344
1345 //=============================================================================
1346
1347 //
1348 // cl_main
1349 //
1350
1351 void CL_Shutdown (void);
1352 void CL_Init (void);
1353
1354 void CL_EstablishConnection(const char *host, int firstarg);
1355
1356 void CL_Disconnect (void);
1357 void CL_Disconnect_f (void);
1358
1359 void CL_UpdateRenderEntity(entity_render_t *ent);
1360 void CL_SetEntityColormapColors(entity_render_t *ent, int colormap);
1361 void CL_UpdateViewEntities(void);
1362
1363 //
1364 // cl_input
1365 //
1366 typedef struct kbutton_s
1367 {
1368         int             down[2];                // key nums holding it down
1369         int             state;                  // low bit is down state
1370 }
1371 kbutton_t;
1372
1373 extern  kbutton_t       in_mlook, in_klook;
1374 extern  kbutton_t       in_strafe;
1375 extern  kbutton_t       in_speed;
1376
1377 void CL_InitInput (void);
1378 void CL_SendMove (void);
1379
1380 void CL_ValidateState(entity_state_t *s);
1381 void CL_MoveLerpEntityStates(entity_t *ent);
1382 void CL_LerpUpdate(entity_t *e);
1383 void CL_ParseTEnt (void);
1384 void CL_NewBeam (int ent, vec3_t start, vec3_t end, dp_model_t *m, int lightning);
1385 void CL_RelinkBeams (void);
1386 void CL_Beam_CalculatePositions (const beam_t *b, vec3_t start, vec3_t end);
1387 void CL_ClientMovement_Replay(void);
1388
1389 void CL_ClearTempEntities (void);
1390 entity_render_t *CL_NewTempEntity (double shadertime);
1391
1392 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
1393
1394 void CL_ClearState (void);
1395 void CL_ExpandEntities(int num);
1396 void CL_ExpandCSQCRenderEntities(int num);
1397 void CL_SetInfo(const char *key, const char *value, qboolean send, qboolean allowstarkey, qboolean allowmodel, qboolean quiet);
1398
1399
1400 void CL_UpdateWorld (void);
1401 void CL_WriteToServer (void);
1402 void CL_Input (void);
1403 extern int cl_ignoremousemoves;
1404
1405
1406 float CL_KeyState (kbutton_t *key);
1407 const char *Key_KeynumToString (int keynum);
1408 int Key_StringToKeynum (const char *str);
1409
1410 //
1411 // cl_demo.c
1412 //
1413 void CL_StopPlayback(void);
1414 void CL_ReadDemoMessage(void);
1415 void CL_WriteDemoMessage(sizebuf_t *mesage);
1416
1417 void CL_CutDemo(unsigned char **buf, fs_offset_t *filesize);
1418 void CL_PasteDemo(unsigned char **buf, fs_offset_t *filesize);
1419
1420 void CL_NextDemo(void);
1421 void CL_Stop_f(void);
1422 void CL_Record_f(void);
1423 void CL_PlayDemo_f(void);
1424 void CL_TimeDemo_f(void);
1425
1426 //
1427 // cl_parse.c
1428 //
1429 void CL_Parse_Init(void);
1430 void CL_Parse_Shutdown(void);
1431 void CL_ParseServerMessage(void);
1432 void CL_Parse_DumpPacket(void);
1433 void CL_Parse_ErrorCleanUp(void);
1434 void QW_CL_StartUpload(unsigned char *data, int size);
1435 extern cvar_t qport;
1436 void CL_KeepaliveMessage(qboolean readmessages); // call this during loading of large content
1437
1438 //
1439 // view
1440 //
1441 void V_StartPitchDrift (void);
1442 void V_StopPitchDrift (void);
1443
1444 void V_Init (void);
1445 float V_CalcRoll (vec3_t angles, vec3_t velocity);
1446 void V_UpdateBlends (void);
1447 void V_ParseDamage (void);
1448
1449 //
1450 // cl_part
1451 //
1452
1453 extern cvar_t cl_particles;
1454 extern cvar_t cl_particles_quality;
1455 extern cvar_t cl_particles_size;
1456 extern cvar_t cl_particles_quake;
1457 extern cvar_t cl_particles_blood;
1458 extern cvar_t cl_particles_blood_alpha;
1459 extern cvar_t cl_particles_blood_decal_alpha;
1460 extern cvar_t cl_particles_blood_decal_scalemin;
1461 extern cvar_t cl_particles_blood_decal_scalemax;
1462 extern cvar_t cl_particles_blood_bloodhack;
1463 extern cvar_t cl_particles_bulletimpacts;
1464 extern cvar_t cl_particles_explosions_sparks;
1465 extern cvar_t cl_particles_explosions_shell;
1466 extern cvar_t cl_particles_rain;
1467 extern cvar_t cl_particles_snow;
1468 extern cvar_t cl_particles_smoke;
1469 extern cvar_t cl_particles_smoke_alpha;
1470 extern cvar_t cl_particles_smoke_alphafade;
1471 extern cvar_t cl_particles_sparks;
1472 extern cvar_t cl_particles_bubbles;
1473 extern cvar_t cl_decals;
1474 extern cvar_t cl_decals_time;
1475 extern cvar_t cl_decals_fadetime;
1476
1477 void CL_Particles_Clear(void);
1478 void CL_Particles_Init(void);
1479 void CL_Particles_Shutdown(void);
1480 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]);
1481
1482 typedef enum effectnameindex_s
1483 {
1484         EFFECT_NONE,
1485         EFFECT_TE_GUNSHOT,
1486         EFFECT_TE_GUNSHOTQUAD,
1487         EFFECT_TE_SPIKE,
1488         EFFECT_TE_SPIKEQUAD,
1489         EFFECT_TE_SUPERSPIKE,
1490         EFFECT_TE_SUPERSPIKEQUAD,
1491         EFFECT_TE_WIZSPIKE,
1492         EFFECT_TE_KNIGHTSPIKE,
1493         EFFECT_TE_EXPLOSION,
1494         EFFECT_TE_EXPLOSIONQUAD,
1495         EFFECT_TE_TAREXPLOSION,
1496         EFFECT_TE_TELEPORT,
1497         EFFECT_TE_LAVASPLASH,
1498         EFFECT_TE_SMALLFLASH,
1499         EFFECT_TE_FLAMEJET,
1500         EFFECT_EF_FLAME,
1501         EFFECT_TE_BLOOD,
1502         EFFECT_TE_SPARK,
1503         EFFECT_TE_PLASMABURN,
1504         EFFECT_TE_TEI_G3,
1505         EFFECT_TE_TEI_SMOKE,
1506         EFFECT_TE_TEI_BIGEXPLOSION,
1507         EFFECT_TE_TEI_PLASMAHIT,
1508         EFFECT_EF_STARDUST,
1509         EFFECT_TR_ROCKET,
1510         EFFECT_TR_GRENADE,
1511         EFFECT_TR_BLOOD,
1512         EFFECT_TR_WIZSPIKE,
1513         EFFECT_TR_SLIGHTBLOOD,
1514         EFFECT_TR_KNIGHTSPIKE,
1515         EFFECT_TR_VORESPIKE,
1516         EFFECT_TR_NEHAHRASMOKE,
1517         EFFECT_TR_NEXUIZPLASMA,
1518         EFFECT_TR_GLOWTRAIL,
1519         EFFECT_SVC_PARTICLE,
1520         EFFECT_TOTAL
1521 }
1522 effectnameindex_t;
1523
1524 int CL_ParticleEffectIndexForName(const char *name);
1525 const char *CL_ParticleEffectNameForIndex(int i);
1526 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);
1527 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]);
1528 void CL_ParseParticleEffect (void);
1529 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);
1530 void CL_ParticleRain (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, int type);
1531 void CL_EntityParticles (const entity_t *ent);
1532 void CL_ParticleExplosion (const vec3_t org);
1533 void CL_ParticleExplosion2 (const vec3_t org, int colorStart, int colorLength);
1534 void R_NewExplosion(const vec3_t org);
1535
1536 void Debug_PolygonBegin(const char *picname, int flags);
1537 void Debug_PolygonVertex(float x, float y, float z, float s, float t, float r, float g, float b, float a);
1538 void Debug_PolygonEnd(void);
1539
1540 #include "cl_screen.h"
1541
1542 extern qboolean sb_showscores;
1543
1544 float RSurf_FogVertex(const vec3_t p);
1545 float RSurf_FogPoint(const vec3_t p);
1546
1547 typedef struct r_refdef_stats_s
1548 {
1549         int renders;
1550         int entities;
1551         int entities_surfaces;
1552         int entities_triangles;
1553         int world_leafs;
1554         int world_portals;
1555         int world_surfaces;
1556         int world_triangles;
1557         int lightmapupdates;
1558         int lightmapupdatepixels;
1559         int particles;
1560         int drawndecals;
1561         int totaldecals;
1562         int draws;
1563         int draws_vertices;
1564         int draws_elements;
1565         int lights;
1566         int lights_clears;
1567         int lights_scissored;
1568         int lights_lighttriangles;
1569         int lights_shadowtriangles;
1570         int lights_dynamicshadowtriangles;
1571         int bouncegrid_lights;
1572         int bouncegrid_particles;
1573         int bouncegrid_traces;
1574         int bouncegrid_hits;
1575         int bouncegrid_splats;
1576         int bouncegrid_bounces;
1577         int collisioncache_animated;
1578         int collisioncache_cached;
1579         int collisioncache_traced;
1580         int bloom;
1581         int bloom_copypixels;
1582         int bloom_drawpixels;
1583         int indexbufferuploadcount;
1584         int indexbufferuploadsize;
1585         int vertexbufferuploadcount;
1586         int vertexbufferuploadsize;
1587         int framedatacurrent;
1588         int framedatasize;
1589 }
1590 r_refdef_stats_t;
1591
1592 typedef enum r_viewport_type_e
1593 {
1594         R_VIEWPORTTYPE_ORTHO,
1595         R_VIEWPORTTYPE_PERSPECTIVE,
1596         R_VIEWPORTTYPE_PERSPECTIVE_INFINITEFARCLIP,
1597         R_VIEWPORTTYPE_PERSPECTIVECUBESIDE,
1598         R_VIEWPORTTYPE_TOTAL
1599 }
1600 r_viewport_type_t;
1601
1602 typedef struct r_viewport_s
1603 {
1604         matrix4x4_t cameramatrix; // from entity (transforms from camera entity to world)
1605         matrix4x4_t viewmatrix; // actual matrix for rendering (transforms to viewspace)
1606         matrix4x4_t projectmatrix; // actual projection matrix (transforms from viewspace to screen)
1607         int x;
1608         int y;
1609         int z;
1610         int width;
1611         int height;
1612         int depth;
1613         r_viewport_type_t type;
1614         float screentodepth[2]; // used by deferred renderer to calculate linear depth from device depth coordinates
1615 }
1616 r_viewport_t;
1617
1618 typedef struct r_refdef_view_s
1619 {
1620         // view information (changes multiple times per frame)
1621         // if any of these variables change then r_refdef.viewcache must be regenerated
1622         // by calling R_View_Update
1623         // (which also updates viewport, scissor, colormask)
1624
1625         // it is safe and expected to copy this into a structure on the stack and
1626         // call the renderer recursively, then restore from the stack afterward
1627         // (as long as R_View_Update is called)
1628
1629         // eye position information
1630         matrix4x4_t matrix, inverse_matrix;
1631         vec3_t origin;
1632         vec3_t forward;
1633         vec3_t left;
1634         vec3_t right;
1635         vec3_t up;
1636         int numfrustumplanes;
1637         mplane_t frustum[6];
1638         qboolean useclipplane;
1639         qboolean usecustompvs; // uses r_refdef.viewcache.pvsbits as-is rather than computing it
1640         mplane_t clipplane;
1641         float frustum_x, frustum_y;
1642         vec3_t frustumcorner[4];
1643         // if turned off it renders an ortho view
1644         int useperspective;
1645         float ortho_x, ortho_y;
1646
1647         // screen area to render in
1648         int x;
1649         int y;
1650         int z;
1651         int width;
1652         int height;
1653         int depth;
1654         r_viewport_t viewport; // note: if r_viewscale is used, the viewport.width and viewport.height may be less than width and height
1655
1656         // which color components to allow (for anaglyph glasses)
1657         int colormask[4];
1658
1659         // global RGB color multiplier for rendering, this is required by HDR
1660         float colorscale;
1661
1662         // whether to call R_ClearScreen before rendering stuff
1663         qboolean clear;
1664         // if true, don't clear or do any post process effects (bloom, etc)
1665         qboolean isoverlay;
1666
1667         // whether to draw r_showtris and such, this is only true for the main
1668         // view render, all secondary renders (HDR, mirrors, portals, cameras,
1669         // distortion effects, etc) omit such debugging information
1670         qboolean showdebug;
1671
1672         // these define which values to use in GL_CullFace calls to request frontface or backface culling
1673         int cullface_front;
1674         int cullface_back;
1675
1676         // render quality (0 to 1) - affects r_drawparticles_drawdistance and others
1677         float quality;
1678 }
1679 r_refdef_view_t;
1680
1681 typedef struct r_refdef_viewcache_s
1682 {
1683         // updated by gl_main_newmap()
1684         int maxentities;
1685         int world_numclusters;
1686         int world_numclusterbytes;
1687         int world_numleafs;
1688         int world_numsurfaces;
1689
1690         // these properties are generated by R_View_Update()
1691
1692         // which entities are currently visible for this viewpoint
1693         // (the used range is 0...r_refdef.scene.numentities)
1694         unsigned char *entityvisible;
1695
1696         // flag arrays used for visibility checking on world model
1697         // (all other entities have no per-surface/per-leaf visibility checks)
1698         unsigned char *world_pvsbits;
1699         unsigned char *world_leafvisible;
1700         unsigned char *world_surfacevisible;
1701         // if true, the view is currently in a leaf without pvs data
1702         qboolean world_novis;
1703 }
1704 r_refdef_viewcache_t;
1705
1706 // TODO: really think about which fields should go into scene and which one should stay in refdef [1/7/2008 Black]
1707 // maybe also refactor some of the functions to support different setting sources (ie. fogenabled, etc.) for different scenes
1708 typedef struct r_refdef_scene_s {
1709         // whether to call S_ExtraUpdate during render to reduce sound chop
1710         qboolean extraupdate;
1711
1712         // (client gameworld) time for rendering time based effects
1713         double time;
1714
1715         // the world
1716         entity_render_t *worldentity;
1717
1718         // same as worldentity->model
1719         dp_model_t *worldmodel;
1720
1721         // renderable entities (excluding world)
1722         entity_render_t **entities;
1723         int numentities;
1724         int maxentities;
1725
1726         // field of temporary entities that is reset each (client) frame
1727         entity_render_t *tempentities;
1728         int numtempentities;
1729         int maxtempentities;
1730         qboolean expandtempentities;
1731
1732         // renderable dynamic lights
1733         rtlight_t *lights[MAX_DLIGHTS];
1734         rtlight_t templights[MAX_DLIGHTS];
1735         int numlights;
1736
1737         // intensities for light styles right now, controls rtlights
1738         float rtlightstylevalue[MAX_LIGHTSTYLES];       // float fraction of base light value
1739         // 8.8bit fixed point intensities for light styles
1740         // controls intensity lightmap layers
1741         unsigned short lightstylevalue[MAX_LIGHTSTYLES];        // 8.8 fraction of base light value
1742
1743         float ambient;
1744
1745         qboolean rtworld;
1746         qboolean rtworldshadows;
1747         qboolean rtdlight;
1748         qboolean rtdlightshadows;
1749 } r_refdef_scene_t;
1750
1751 typedef struct r_refdef_s
1752 {
1753         // these fields define the basic rendering information for the world
1754         // but not the view, which could change multiple times in one rendered
1755         // frame (for example when rendering textures for certain effects)
1756
1757         // these are set for water warping before
1758         // frustum_x/frustum_y are calculated
1759         float frustumscale_x, frustumscale_y;
1760
1761         // current view settings (these get reset a few times during rendering because of water rendering, reflections, etc)
1762         r_refdef_view_t view;
1763         r_refdef_viewcache_t viewcache;
1764
1765         // minimum visible distance (pixels closer than this disappear)
1766         double nearclip;
1767         // maximum visible distance (pixels further than this disappear in 16bpp modes,
1768         // in 32bpp an infinite-farclip matrix is used instead)
1769         double farclip;
1770
1771         // fullscreen color blend
1772         float viewblend[4];
1773
1774         r_refdef_scene_t scene;
1775
1776         float fogplane[4];
1777         float fogplaneviewdist;
1778         qboolean fogplaneviewabove;
1779         float fogheightfade;
1780         float fogcolor[3];
1781         float fogrange;
1782         float fograngerecip;
1783         float fogmasktabledistmultiplier;
1784 #define FOGMASKTABLEWIDTH 1024
1785         float fogmasktable[FOGMASKTABLEWIDTH];
1786         float fogmasktable_start, fogmasktable_alpha, fogmasktable_range, fogmasktable_density;
1787         float fog_density;
1788         float fog_red;
1789         float fog_green;
1790         float fog_blue;
1791         float fog_alpha;
1792         float fog_start;
1793         float fog_end;
1794         float fog_height;
1795         float fog_fadedepth;
1796         qboolean fogenabled;
1797         qboolean oldgl_fogenable;
1798
1799         // new flexible texture height fog (overrides normal fog)
1800         char fog_height_texturename[64]; // note: must be 64 for the sscanf code
1801         unsigned char *fog_height_table1d;
1802         unsigned char *fog_height_table2d;
1803         int fog_height_tablesize; // enable
1804         float fog_height_tablescale;
1805         float fog_height_texcoordscale;
1806         char fogheighttexturename[64]; // detects changes to active fog height texture
1807
1808         int draw2dstage; // 0 = no, 1 = yes, other value = needs setting up again
1809
1810         // true during envmap command capture
1811         qboolean envmap;
1812
1813         // brightness of world lightmaps and related lighting
1814         // (often reduced when world rtlights are enabled)
1815         float lightmapintensity;
1816         // whether to draw world lights realtime, dlights realtime, and their shadows
1817         float polygonfactor;
1818         float polygonoffset;
1819         float shadowpolygonfactor;
1820         float shadowpolygonoffset;
1821
1822         // how long R_RenderView took on the previous frame
1823         double lastdrawscreentime;
1824
1825         // rendering stats for r_speeds display
1826         // (these are incremented in many places)
1827         r_refdef_stats_t stats;
1828 }
1829 r_refdef_t;
1830
1831 extern r_refdef_t r_refdef;
1832
1833 // warpzone prediction hack (CSQC builtin)
1834 void CL_RotateMoves(const matrix4x4_t *m);
1835
1836 #endif
1837