added PRVM_64 define which upgrades the QC VM to double precision
[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 client_static_t;
723
724 extern client_static_t  cls;
725
726 typedef struct client_movementqueue_s
727 {
728         double time;
729         float frametime;
730         int sequence;
731         float viewangles[3];
732         float move[3];
733         qboolean jump;
734         qboolean crouch;
735         qboolean canjump;
736 }
737 client_movementqueue_t;
738
739 //[515]: csqc
740 typedef struct
741 {
742         qboolean drawworld;
743         qboolean drawenginesbar;
744         qboolean drawcrosshair;
745 }csqc_vidvars_t;
746
747 typedef enum
748 {
749         PARTICLE_BILLBOARD = 0,
750         PARTICLE_SPARK = 1,
751         PARTICLE_ORIENTED_DOUBLESIDED = 2,
752         PARTICLE_VBEAM = 3,
753         PARTICLE_HBEAM = 4,
754         PARTICLE_INVALID = -1
755 }
756 porientation_t;
757
758 typedef enum
759 {
760         PBLEND_ALPHA = 0,
761         PBLEND_ADD = 1,
762         PBLEND_INVMOD = 2,
763         PBLEND_INVALID = -1
764 }
765 pblend_t;
766
767 typedef struct particletype_s
768 {
769         pblend_t blendmode;
770         porientation_t orientation;
771         qboolean lighting;
772 }
773 particletype_t;
774
775 typedef enum ptype_e
776 {
777         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
778 }
779 ptype_t;
780
781 typedef struct decal_s
782 {
783         // fields used by rendering:  (44 bytes)
784         unsigned short  typeindex;
785         unsigned short  texnum;
786         int                             decalsequence;
787         vec3_t                  org;
788         vec3_t                  normal;
789         float                   size;
790         float                   alpha; // 0-255
791         unsigned char   color[3];
792         unsigned char   unused1;
793         int                             clusterindex; // cheap culling by pvs
794
795         // fields not used by rendering: (36 bytes in 32bit, 40 bytes in 64bit)
796         float                   time2; // used for decal fade
797         unsigned int    owner; // decal stuck to this entity
798         dp_model_t                      *ownermodel; // model the decal is stuck to (used to make sure the entity is still alive)
799         vec3_t                  relativeorigin; // decal at this location in entity's coordinate space
800         vec3_t                  relativenormal; // decal oriented this way relative to entity's coordinate space
801 }
802 decal_t;
803
804 typedef struct particle_s
805 {
806         // for faster batch rendering, particles are rendered in groups by effect (resulting in less perfect sorting but far less state changes)
807
808         // fields used by rendering: (48 bytes)
809         vec3_t          sortorigin; // sort by this group origin, not particle org
810         vec3_t          org;
811         vec3_t          vel; // velocity of particle, or orientation of decal, or end point of beam
812         float           size;
813         float           alpha; // 0-255
814         float           stretch; // only for sparks
815
816         // fields not used by rendering:  (44 bytes)
817         float           stainsize;
818         float           stainalpha;
819         float           sizeincrease; // rate of size change per second
820         float           alphafade; // how much alpha reduces per second
821         float           time2; // used for snow fluttering and decal fade
822         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)
823         float           gravity; // how much gravity affects this particle (1.0 = normal gravity, 0.0 = none)
824         float           airfriction; // how much air friction affects this object (objects with a low mass/size ratio tend to get more air friction)
825         float           liquidfriction; // how much liquid friction affects this object (objects with a low mass/size ratio tend to get more liquid friction)
826 //      float           delayedcollisions; // time that p->bounce becomes active
827         float           delayedspawn; // time that particle appears and begins moving
828         float           die; // time when this particle should be removed, regardless of alpha
829
830         // short variables grouped to save memory (4 bytes)
831         short                   angle; // base rotation of particle
832         short                   spin; // geometry rotation speed around the particle center normal
833
834         // byte variables grouped to save memory (12 bytes)
835         unsigned char   color[3];
836         unsigned char   qualityreduction; // enables skipping of this particle according to r_refdef.view.qualityreduction
837         unsigned char   typeindex;
838         unsigned char   blendmode;
839         unsigned char   orientation;
840         unsigned char   texnum;
841         unsigned char   staincolor[3];
842         signed char     staintexnum;
843 }
844 particle_t;
845
846 typedef enum cl_parsingtextmode_e
847 {
848         CL_PARSETEXTMODE_NONE,
849         CL_PARSETEXTMODE_PING,
850         CL_PARSETEXTMODE_STATUS,
851         CL_PARSETEXTMODE_STATUS_PLAYERID,
852         CL_PARSETEXTMODE_STATUS_PLAYERIP
853 }
854 cl_parsingtextmode_t;
855
856 typedef struct cl_locnode_s
857 {
858         struct cl_locnode_s *next;
859         char *name;
860         vec3_t mins, maxs;
861 }
862 cl_locnode_t;
863
864 typedef struct showlmp_s
865 {
866         qboolean        isactive;
867         float           x;
868         float           y;
869         char            label[32];
870         char            pic[128];
871 }
872 showlmp_t;
873
874 //
875 // the client_state_t structure is wiped completely at every
876 // server signon
877 //
878 typedef struct client_state_s
879 {
880         // true if playing in a local game and no one else is connected
881         int islocalgame;
882
883         // send a clc_nop periodically until connected
884         float sendnoptime;
885
886         // current input being accumulated by mouse/joystick/etc input
887         usercmd_t cmd;
888         // latest moves sent to the server that have not been confirmed yet
889         usercmd_t movecmd[CL_MAX_USERCMDS];
890
891 // information for local display
892         // health, etc
893         int stats[MAX_CL_STATS];
894         float *statsf; // points to stats[] array
895         // last known inventory bit flags, for blinking
896         int olditems;
897         // cl.time of acquiring item, for blinking
898         float item_gettime[32];
899         // last known STAT_ACTIVEWEAPON
900         int activeweapon;
901         // cl.time of changing STAT_ACTIVEWEAPON
902         float weapontime;
903         // use pain anim frame if cl.time < this
904         float faceanimtime;
905         // for stair smoothing
906         float stairsmoothz;
907         double stairsmoothtime;
908
909         // color shifts for damage, powerups
910         cshift_t cshifts[NUM_CSHIFTS];
911         // and content types
912         cshift_t prev_cshifts[NUM_CSHIFTS];
913
914 // the client maintains its own idea of view angles, which are
915 // sent to the server each frame.  The server sets punchangle when
916 // the view is temporarily offset, and an angle reset commands at the start
917 // of each level and after teleporting.
918
919         // mviewangles is read from demo
920         // viewangles is either client controlled or lerped from mviewangles
921         vec3_t mviewangles[2], viewangles;
922         // update by server, used by qc to do weapon recoil
923         vec3_t mpunchangle[2], punchangle;
924         // update by server, can be used by mods to kick view around
925         vec3_t mpunchvector[2], punchvector;
926         // update by server, used for lean+bob (0 is newest)
927         vec3_t mvelocity[2], velocity;
928         // update by server, can be used by mods for zooming
929         vec_t mviewzoom[2], viewzoom;
930         // if true interpolation the mviewangles and other interpolation of the
931         // player is disabled until the next network packet
932         // this is used primarily by teleporters, and when spectating players
933         // special checking of the old fixangle[1] is used to differentiate
934         // between teleporting and spectating
935         qboolean fixangle[2];
936
937         // client movement simulation
938         // these fields are only updated by CL_ClientMovement (called by CL_SendMove after parsing each network packet)
939         // set by CL_ClientMovement_Replay functions
940         qboolean movement_predicted;
941         // if true the CL_ClientMovement_Replay function will update origin, etc
942         qboolean movement_replay;
943         // simulated data (this is valid even if cl.movement is false)
944         vec3_t movement_origin;
945         vec3_t movement_velocity;
946         // whether the replay should allow a jump at the first sequence
947         qboolean movement_replay_canjump;
948
949         // previous gun angles (for leaning effects)
950         vec3_t gunangles_prev;
951         vec3_t gunangles_highpass;
952         vec3_t gunangles_adjustment_lowpass;
953         vec3_t gunangles_adjustment_highpass;
954         // previous gun angles (for leaning effects)
955         vec3_t gunorg_prev;
956         vec3_t gunorg_highpass;
957         vec3_t gunorg_adjustment_lowpass;
958         vec3_t gunorg_adjustment_highpass;
959
960 // pitch drifting vars
961         float idealpitch;
962         float pitchvel;
963         qboolean nodrift;
964         float driftmove;
965         double laststop;
966
967 //[515]: added for csqc purposes
968         float sensitivityscale;
969         csqc_vidvars_t csqc_vidvars;    //[515]: these parms must be set to true by default
970         qboolean csqc_wantsmousemove;
971         qboolean csqc_paused; // vortex: int because could be flags
972         struct model_s *csqc_model_precache[MAX_MODELS];
973
974         // local amount for smoothing stepups
975         //float crouch;
976
977         // sent by server
978         qboolean paused;
979         qboolean onground;
980         qboolean inwater;
981
982         // used by bob
983         qboolean oldonground;
984         double lastongroundtime;
985         double hitgroundtime;
986         float bob2_smooth;
987         float bobfall_speed;
988         float bobfall_swing;
989         double calcrefdef_prevtime;
990
991         // don't change view angle, full screen, etc
992         int intermission;
993         // latched at intermission start
994         double completed_time;
995
996         // the timestamp of the last two messages
997         double mtime[2];
998
999         // clients view of time, time should be between mtime[0] and mtime[1] to
1000         // generate a lerp point for other data, oldtime is the previous frame's
1001         // value of time, frametime is the difference between time and oldtime
1002         // note: cl.time may be beyond cl.mtime[0] if packet loss is occuring, it
1003         // is only forcefully limited when a packet is received
1004         double time, oldtime;
1005         // how long it has been since the previous client frame in real time
1006         // (not game time, for that use cl.time - cl.oldtime)
1007         double realframetime;
1008         
1009         // fade var for fading while dead
1010         float deathfade;
1011
1012         // motionblur alpha level variable
1013         float motionbluralpha;
1014
1015         // copy of realtime from last recieved message, for net trouble icon
1016         float last_received_message;
1017
1018 // information that is static for the entire time connected to a server
1019         struct model_s *model_precache[MAX_MODELS];
1020         struct sfx_s *sound_precache[MAX_SOUNDS];
1021
1022         // FIXME: this is a lot of memory to be keeping around, this really should be dynamically allocated and freed somehow
1023         char model_name[MAX_MODELS][MAX_QPATH];
1024         char sound_name[MAX_SOUNDS][MAX_QPATH];
1025
1026         // for display on solo scoreboard
1027         char worldmessage[40]; // map title (not related to filename)
1028         // variants of map name
1029         char worldbasename[MAX_QPATH]; // %s
1030         char worldname[MAX_QPATH]; // maps/%s.bsp
1031         char worldnamenoextension[MAX_QPATH]; // maps/%s
1032         // cl_entitites[cl.viewentity] = player
1033         int viewentity;
1034         // the real player entity (normally same as viewentity,
1035         // different than viewentity if mod uses chasecam or other tricks)
1036         int realplayerentity;
1037         // this is updated to match cl.viewentity whenever it is in the clients
1038         // range, basically this is used in preference to cl.realplayerentity for
1039         // most purposes because when spectating another player it should show
1040         // their information rather than yours
1041         int playerentity;
1042         // max players that can be in this game
1043         int maxclients;
1044         // type of game (deathmatch, coop, singleplayer)
1045         int gametype;
1046
1047         // models and sounds used by engine code (particularly cl_parse.c)
1048         dp_model_t *model_bolt;
1049         dp_model_t *model_bolt2;
1050         dp_model_t *model_bolt3;
1051         dp_model_t *model_beam;
1052         sfx_t *sfx_wizhit;
1053         sfx_t *sfx_knighthit;
1054         sfx_t *sfx_tink1;
1055         sfx_t *sfx_ric1;
1056         sfx_t *sfx_ric2;
1057         sfx_t *sfx_ric3;
1058         sfx_t *sfx_r_exp3;
1059         // indicates that the file "sound/misc/talk2.wav" was found (for use by team chat messages)
1060         qboolean foundtalk2wav;
1061
1062 // refresh related state
1063
1064         // cl_entitites[0].model
1065         struct model_s *worldmodel;
1066
1067         // the gun model
1068         entity_t viewent;
1069
1070         // cd audio
1071         int cdtrack, looptrack;
1072
1073 // frag scoreboard
1074
1075         // [cl.maxclients]
1076         scoreboard_t *scores;
1077
1078         // keep track of svc_print parsing state (analyzes ping reports and status reports)
1079         cl_parsingtextmode_t parsingtextmode;
1080         int parsingtextplayerindex;
1081         // set by scoreboard code when sending ping command, this causes the next ping results to be hidden
1082         // (which could eat the wrong ping report if the player issues one
1083         //  manually, but they would still see a ping report, just a later one
1084         //  caused by the scoreboard code rather than the one they intentionally
1085         //  issued)
1086         int parsingtextexpectingpingforscores;
1087
1088         // entity database stuff
1089         // latest received entity frame numbers
1090 #define LATESTFRAMENUMS 32
1091         int latestframenumsposition;
1092         int latestframenums[LATESTFRAMENUMS];
1093         int latestsendnums[LATESTFRAMENUMS];
1094         entityframe_database_t *entitydatabase;
1095         entityframe4_database_t *entitydatabase4;
1096         entityframeqw_database_t *entitydatabaseqw;
1097
1098         // keep track of quake entities because they need to be killed if they get stale
1099         int lastquakeentity;
1100         unsigned char isquakeentity[MAX_EDICTS];
1101
1102         // bounding boxes for clientside movement
1103         vec3_t playerstandmins;
1104         vec3_t playerstandmaxs;
1105         vec3_t playercrouchmins;
1106         vec3_t playercrouchmaxs;
1107
1108         // old decals are killed based on this
1109         int decalsequence;
1110
1111         int max_entities;
1112         int max_csqcrenderentities;
1113         int max_static_entities;
1114         int max_effects;
1115         int max_beams;
1116         int max_dlights;
1117         int max_lightstyle;
1118         int max_brushmodel_entities;
1119         int max_particles;
1120         int max_decals;
1121         int max_showlmps;
1122
1123         entity_t *entities;
1124         entity_render_t *csqcrenderentities;
1125         unsigned char *entities_active;
1126         entity_t *static_entities;
1127         cl_effect_t *effects;
1128         beam_t *beams;
1129         dlight_t *dlights;
1130         lightstyle_t *lightstyle;
1131         int *brushmodel_entities;
1132         particle_t *particles;
1133         decal_t *decals;
1134         showlmp_t *showlmps;
1135
1136         int num_entities;
1137         int num_static_entities;
1138         int num_brushmodel_entities;
1139         int num_effects;
1140         int num_beams;
1141         int num_dlights;
1142         int num_particles;
1143         int num_decals;
1144         int num_showlmps;
1145
1146         double particles_updatetime;
1147         double decals_updatetime;
1148         int free_particle;
1149         int free_decal;
1150
1151         // cl_serverextension_download feature
1152         int loadmodel_current;
1153         int downloadmodel_current;
1154         int loadmodel_total;
1155         int loadsound_current;
1156         int downloadsound_current;
1157         int loadsound_total;
1158         qboolean downloadcsqc;
1159         qboolean loadcsqc;
1160         qboolean loadbegun;
1161         qboolean loadfinished;
1162
1163         // quakeworld stuff
1164
1165         // local copy of the server infostring
1166         char qw_serverinfo[MAX_SERVERINFO_STRING];
1167
1168         // time of last qw "pings" command sent to server while showing scores
1169         double last_ping_request;
1170
1171         // used during connect
1172         int qw_servercount;
1173
1174         // updated from serverinfo
1175         int qw_teamplay;
1176
1177         // unused: indicates whether the player is spectating
1178         // use cl.scores[cl.playerentity-1].qw_spectator instead
1179         //qboolean qw_spectator;
1180
1181         // last time an input packet was sent
1182         double lastpackettime;
1183
1184         // movement parameters for client prediction
1185         unsigned int moveflags;
1186         float movevars_wallfriction;
1187         float movevars_waterfriction;
1188         float movevars_friction;
1189         float movevars_timescale;
1190         float movevars_gravity;
1191         float movevars_stopspeed;
1192         float movevars_maxspeed;
1193         float movevars_spectatormaxspeed;
1194         float movevars_accelerate;
1195         float movevars_airaccelerate;
1196         float movevars_wateraccelerate;
1197         float movevars_entgravity;
1198         float movevars_jumpvelocity;
1199         float movevars_edgefriction;
1200         float movevars_maxairspeed;
1201         float movevars_stepheight;
1202         float movevars_airaccel_qw;
1203         float movevars_airaccel_qw_stretchfactor;
1204         float movevars_airaccel_sideways_friction;
1205         float movevars_airstopaccelerate;
1206         float movevars_airstrafeaccelerate;
1207         float movevars_maxairstrafespeed;
1208         float movevars_airstrafeaccel_qw;
1209         float movevars_aircontrol;
1210         float movevars_aircontrol_power;
1211         float movevars_aircontrol_penalty;
1212         float movevars_warsowbunny_airforwardaccel;
1213         float movevars_warsowbunny_accel;
1214         float movevars_warsowbunny_topspeed;
1215         float movevars_warsowbunny_turnaccel;
1216         float movevars_warsowbunny_backtosideratio;
1217         float movevars_ticrate;
1218         float movevars_airspeedlimit_nonqw;
1219
1220         // models used by qw protocol
1221         int qw_modelindex_spike;
1222         int qw_modelindex_player;
1223         int qw_modelindex_flag;
1224         int qw_modelindex_s_explod;
1225
1226         vec3_t qw_intermission_origin;
1227         vec3_t qw_intermission_angles;
1228
1229         // 255 is the most nails the QW protocol could send
1230         int qw_num_nails;
1231         vec_t qw_nails[255][6];
1232
1233         float qw_weaponkick;
1234
1235         int qw_validsequence;
1236
1237         int qw_deltasequence[QW_UPDATE_BACKUP];
1238
1239         // csqc stuff:
1240         // server entity number corresponding to a clientside entity
1241         unsigned short csqc_server2csqcentitynumber[MAX_EDICTS];
1242         qboolean csqc_loaded;
1243         vec3_t csqc_vieworigin;
1244         vec3_t csqc_viewangles;
1245         vec3_t csqc_vieworiginfromengine;
1246         vec3_t csqc_viewanglesfromengine;
1247         matrix4x4_t csqc_viewmodelmatrixfromengine;
1248         qboolean csqc_usecsqclistener;
1249         matrix4x4_t csqc_listenermatrix;
1250         char csqc_printtextbuf[MAX_INPUTLINE];
1251
1252         // collision culling data
1253         world_t world;
1254
1255         // loc file stuff (points and boxes describing locations in the level)
1256         cl_locnode_t *locnodes;
1257         // this is updated to cl.movement_origin whenever health is < 1
1258         // used by %d print in say/say_team messages if cl_locs_enable is on
1259         vec3_t lastdeathorigin;
1260
1261         // processing buffer used by R_BuildLightMap, reallocated as needed,
1262         // freed on each level change
1263         size_t buildlightmapmemorysize;
1264         unsigned char *buildlightmapmemory;
1265
1266         // used by EntityState5_ReadUpdate
1267         skeleton_t *engineskeletonobjects;
1268 }
1269 client_state_t;
1270
1271 //
1272 // cvars
1273 //
1274 extern cvar_t cl_name;
1275 extern cvar_t cl_color;
1276 extern cvar_t cl_rate;
1277 extern cvar_t cl_pmodel;
1278 extern cvar_t cl_playermodel;
1279 extern cvar_t cl_playerskin;
1280
1281 extern cvar_t rcon_password;
1282 extern cvar_t rcon_address;
1283
1284 extern cvar_t cl_upspeed;
1285 extern cvar_t cl_forwardspeed;
1286 extern cvar_t cl_backspeed;
1287 extern cvar_t cl_sidespeed;
1288
1289 extern cvar_t cl_movespeedkey;
1290
1291 extern cvar_t cl_yawspeed;
1292 extern cvar_t cl_pitchspeed;
1293
1294 extern cvar_t cl_anglespeedkey;
1295
1296 extern cvar_t cl_autofire;
1297
1298 extern cvar_t cl_shownet;
1299 extern cvar_t cl_nolerp;
1300 extern cvar_t cl_nettimesyncfactor;
1301 extern cvar_t cl_nettimesyncboundmode;
1302 extern cvar_t cl_nettimesyncboundtolerance;
1303
1304 extern cvar_t cl_pitchdriftspeed;
1305 extern cvar_t lookspring;
1306 extern cvar_t lookstrafe;
1307 extern cvar_t sensitivity;
1308
1309 extern cvar_t freelook;
1310
1311 extern cvar_t m_pitch;
1312 extern cvar_t m_yaw;
1313 extern cvar_t m_forward;
1314 extern cvar_t m_side;
1315
1316 extern cvar_t cl_autodemo;
1317 extern cvar_t cl_autodemo_nameformat;
1318 extern cvar_t cl_autodemo_delete;
1319
1320 extern cvar_t r_draweffects;
1321
1322 extern cvar_t cl_explosions_alpha_start;
1323 extern cvar_t cl_explosions_alpha_end;
1324 extern cvar_t cl_explosions_size_start;
1325 extern cvar_t cl_explosions_size_end;
1326 extern cvar_t cl_explosions_lifetime;
1327 extern cvar_t cl_stainmaps;
1328 extern cvar_t cl_stainmaps_clearonload;
1329
1330 extern cvar_t cl_prydoncursor;
1331 extern cvar_t cl_prydoncursor_notrace;
1332
1333 extern cvar_t cl_locs_enable;
1334
1335 extern client_state_t cl;
1336
1337 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);
1338
1339 cl_locnode_t *CL_Locs_FindNearest(const vec3_t point);
1340 void CL_Locs_FindLocationName(char *buffer, size_t buffersize, vec3_t point);
1341
1342 //=============================================================================
1343
1344 //
1345 // cl_main
1346 //
1347
1348 void CL_Shutdown (void);
1349 void CL_Init (void);
1350
1351 void CL_EstablishConnection(const char *host, int firstarg);
1352
1353 void CL_Disconnect (void);
1354 void CL_Disconnect_f (void);
1355
1356 void CL_UpdateRenderEntity(entity_render_t *ent);
1357 void CL_SetEntityColormapColors(entity_render_t *ent, int colormap);
1358 void CL_UpdateViewEntities(void);
1359
1360 //
1361 // cl_input
1362 //
1363 typedef struct kbutton_s
1364 {
1365         int             down[2];                // key nums holding it down
1366         int             state;                  // low bit is down state
1367 }
1368 kbutton_t;
1369
1370 extern  kbutton_t       in_mlook, in_klook;
1371 extern  kbutton_t       in_strafe;
1372 extern  kbutton_t       in_speed;
1373
1374 void CL_InitInput (void);
1375 void CL_SendMove (void);
1376
1377 void CL_ValidateState(entity_state_t *s);
1378 void CL_MoveLerpEntityStates(entity_t *ent);
1379 void CL_LerpUpdate(entity_t *e);
1380 void CL_ParseTEnt (void);
1381 void CL_NewBeam (int ent, vec3_t start, vec3_t end, dp_model_t *m, int lightning);
1382 void CL_RelinkBeams (void);
1383 void CL_Beam_CalculatePositions (const beam_t *b, vec3_t start, vec3_t end);
1384 void CL_ClientMovement_Replay(void);
1385
1386 void CL_ClearTempEntities (void);
1387 entity_render_t *CL_NewTempEntity (double shadertime);
1388
1389 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
1390
1391 void CL_ClearState (void);
1392 void CL_ExpandEntities(int num);
1393 void CL_ExpandCSQCRenderEntities(int num);
1394 void CL_SetInfo(const char *key, const char *value, qboolean send, qboolean allowstarkey, qboolean allowmodel, qboolean quiet);
1395
1396
1397 void CL_UpdateWorld (void);
1398 void CL_WriteToServer (void);
1399 void CL_Input (void);
1400 extern int cl_ignoremousemoves;
1401
1402
1403 float CL_KeyState (kbutton_t *key);
1404 const char *Key_KeynumToString (int keynum, char *buf, size_t buflength);
1405 int Key_StringToKeynum (const char *str);
1406
1407 //
1408 // cl_demo.c
1409 //
1410 void CL_StopPlayback(void);
1411 void CL_ReadDemoMessage(void);
1412 void CL_WriteDemoMessage(sizebuf_t *mesage);
1413
1414 void CL_CutDemo(unsigned char **buf, fs_offset_t *filesize);
1415 void CL_PasteDemo(unsigned char **buf, fs_offset_t *filesize);
1416
1417 void CL_NextDemo(void);
1418 void CL_Stop_f(void);
1419 void CL_Record_f(void);
1420 void CL_PlayDemo_f(void);
1421 void CL_TimeDemo_f(void);
1422
1423 //
1424 // cl_parse.c
1425 //
1426 void CL_Parse_Init(void);
1427 void CL_Parse_Shutdown(void);
1428 void CL_ParseServerMessage(void);
1429 void CL_Parse_DumpPacket(void);
1430 void CL_Parse_ErrorCleanUp(void);
1431 void QW_CL_StartUpload(unsigned char *data, int size);
1432 extern cvar_t qport;
1433 void CL_KeepaliveMessage(qboolean readmessages); // call this during loading of large content
1434
1435 //
1436 // view
1437 //
1438 void V_StartPitchDrift (void);
1439 void V_StopPitchDrift (void);
1440
1441 void V_Init (void);
1442 float V_CalcRoll (const vec3_t angles, const vec3_t velocity);
1443 void V_UpdateBlends (void);
1444 void V_ParseDamage (void);
1445
1446 //
1447 // cl_part
1448 //
1449
1450 extern cvar_t cl_particles;
1451 extern cvar_t cl_particles_quality;
1452 extern cvar_t cl_particles_size;
1453 extern cvar_t cl_particles_quake;
1454 extern cvar_t cl_particles_blood;
1455 extern cvar_t cl_particles_blood_alpha;
1456 extern cvar_t cl_particles_blood_decal_alpha;
1457 extern cvar_t cl_particles_blood_decal_scalemin;
1458 extern cvar_t cl_particles_blood_decal_scalemax;
1459 extern cvar_t cl_particles_blood_bloodhack;
1460 extern cvar_t cl_particles_bulletimpacts;
1461 extern cvar_t cl_particles_explosions_sparks;
1462 extern cvar_t cl_particles_explosions_shell;
1463 extern cvar_t cl_particles_rain;
1464 extern cvar_t cl_particles_snow;
1465 extern cvar_t cl_particles_smoke;
1466 extern cvar_t cl_particles_smoke_alpha;
1467 extern cvar_t cl_particles_smoke_alphafade;
1468 extern cvar_t cl_particles_sparks;
1469 extern cvar_t cl_particles_bubbles;
1470 extern cvar_t cl_decals;
1471 extern cvar_t cl_decals_time;
1472 extern cvar_t cl_decals_fadetime;
1473
1474 void CL_Particles_Clear(void);
1475 void CL_Particles_Init(void);
1476 void CL_Particles_Shutdown(void);
1477 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]);
1478
1479 typedef enum effectnameindex_s
1480 {
1481         EFFECT_NONE,
1482         EFFECT_TE_GUNSHOT,
1483         EFFECT_TE_GUNSHOTQUAD,
1484         EFFECT_TE_SPIKE,
1485         EFFECT_TE_SPIKEQUAD,
1486         EFFECT_TE_SUPERSPIKE,
1487         EFFECT_TE_SUPERSPIKEQUAD,
1488         EFFECT_TE_WIZSPIKE,
1489         EFFECT_TE_KNIGHTSPIKE,
1490         EFFECT_TE_EXPLOSION,
1491         EFFECT_TE_EXPLOSIONQUAD,
1492         EFFECT_TE_TAREXPLOSION,
1493         EFFECT_TE_TELEPORT,
1494         EFFECT_TE_LAVASPLASH,
1495         EFFECT_TE_SMALLFLASH,
1496         EFFECT_TE_FLAMEJET,
1497         EFFECT_EF_FLAME,
1498         EFFECT_TE_BLOOD,
1499         EFFECT_TE_SPARK,
1500         EFFECT_TE_PLASMABURN,
1501         EFFECT_TE_TEI_G3,
1502         EFFECT_TE_TEI_SMOKE,
1503         EFFECT_TE_TEI_BIGEXPLOSION,
1504         EFFECT_TE_TEI_PLASMAHIT,
1505         EFFECT_EF_STARDUST,
1506         EFFECT_TR_ROCKET,
1507         EFFECT_TR_GRENADE,
1508         EFFECT_TR_BLOOD,
1509         EFFECT_TR_WIZSPIKE,
1510         EFFECT_TR_SLIGHTBLOOD,
1511         EFFECT_TR_KNIGHTSPIKE,
1512         EFFECT_TR_VORESPIKE,
1513         EFFECT_TR_NEHAHRASMOKE,
1514         EFFECT_TR_NEXUIZPLASMA,
1515         EFFECT_TR_GLOWTRAIL,
1516         EFFECT_SVC_PARTICLE,
1517         EFFECT_TOTAL
1518 }
1519 effectnameindex_t;
1520
1521 int CL_ParticleEffectIndexForName(const char *name);
1522 const char *CL_ParticleEffectNameForIndex(int i);
1523 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);
1524 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]);
1525 void CL_ParseParticleEffect (void);
1526 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);
1527 void CL_ParticleRain (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, int type);
1528 void CL_EntityParticles (const entity_t *ent);
1529 void CL_ParticleExplosion (const vec3_t org);
1530 void CL_ParticleExplosion2 (const vec3_t org, int colorStart, int colorLength);
1531 void R_NewExplosion(const vec3_t org);
1532
1533 void Debug_PolygonBegin(const char *picname, int flags);
1534 void Debug_PolygonVertex(float x, float y, float z, float s, float t, float r, float g, float b, float a);
1535 void Debug_PolygonEnd(void);
1536
1537 #include "cl_screen.h"
1538
1539 extern qboolean sb_showscores;
1540
1541 float RSurf_FogVertex(const vec3_t p);
1542 float RSurf_FogPoint(const vec3_t p);
1543
1544 typedef struct r_refdef_stats_s
1545 {
1546         int renders;
1547         int entities;
1548         int entities_surfaces;
1549         int entities_triangles;
1550         int world_leafs;
1551         int world_portals;
1552         int world_surfaces;
1553         int world_triangles;
1554         int lightmapupdates;
1555         int lightmapupdatepixels;
1556         int particles;
1557         int drawndecals;
1558         int totaldecals;
1559         int draws;
1560         int draws_vertices;
1561         int draws_elements;
1562         int lights;
1563         int lights_clears;
1564         int lights_scissored;
1565         int lights_lighttriangles;
1566         int lights_shadowtriangles;
1567         int lights_dynamicshadowtriangles;
1568         int bouncegrid_lights;
1569         int bouncegrid_particles;
1570         int bouncegrid_traces;
1571         int bouncegrid_hits;
1572         int bouncegrid_splats;
1573         int bouncegrid_bounces;
1574         int collisioncache_animated;
1575         int collisioncache_cached;
1576         int collisioncache_traced;
1577         int bloom;
1578         int bloom_copypixels;
1579         int bloom_drawpixels;
1580         int indexbufferuploadcount;
1581         int indexbufferuploadsize;
1582         int vertexbufferuploadcount;
1583         int vertexbufferuploadsize;
1584         int framedatacurrent;
1585         int framedatasize;
1586 }
1587 r_refdef_stats_t;
1588
1589 typedef enum r_viewport_type_e
1590 {
1591         R_VIEWPORTTYPE_ORTHO,
1592         R_VIEWPORTTYPE_PERSPECTIVE,
1593         R_VIEWPORTTYPE_PERSPECTIVE_INFINITEFARCLIP,
1594         R_VIEWPORTTYPE_PERSPECTIVECUBESIDE,
1595         R_VIEWPORTTYPE_TOTAL
1596 }
1597 r_viewport_type_t;
1598
1599 typedef struct r_viewport_s
1600 {
1601         matrix4x4_t cameramatrix; // from entity (transforms from camera entity to world)
1602         matrix4x4_t viewmatrix; // actual matrix for rendering (transforms to viewspace)
1603         matrix4x4_t projectmatrix; // actual projection matrix (transforms from viewspace to screen)
1604         int x;
1605         int y;
1606         int z;
1607         int width;
1608         int height;
1609         int depth;
1610         r_viewport_type_t type;
1611         float screentodepth[2]; // used by deferred renderer to calculate linear depth from device depth coordinates
1612 }
1613 r_viewport_t;
1614
1615 typedef struct r_refdef_view_s
1616 {
1617         // view information (changes multiple times per frame)
1618         // if any of these variables change then r_refdef.viewcache must be regenerated
1619         // by calling R_View_Update
1620         // (which also updates viewport, scissor, colormask)
1621
1622         // it is safe and expected to copy this into a structure on the stack and
1623         // call the renderer recursively, then restore from the stack afterward
1624         // (as long as R_View_Update is called)
1625
1626         // eye position information
1627         matrix4x4_t matrix, inverse_matrix;
1628         vec3_t origin;
1629         vec3_t forward;
1630         vec3_t left;
1631         vec3_t right;
1632         vec3_t up;
1633         int numfrustumplanes;
1634         mplane_t frustum[6];
1635         qboolean useclipplane;
1636         qboolean usecustompvs; // uses r_refdef.viewcache.pvsbits as-is rather than computing it
1637         mplane_t clipplane;
1638         float frustum_x, frustum_y;
1639         vec3_t frustumcorner[4];
1640         // if turned off it renders an ortho view
1641         int useperspective;
1642         float ortho_x, ortho_y;
1643
1644         // screen area to render in
1645         int x;
1646         int y;
1647         int z;
1648         int width;
1649         int height;
1650         int depth;
1651         r_viewport_t viewport; // note: if r_viewscale is used, the viewport.width and viewport.height may be less than width and height
1652
1653         // which color components to allow (for anaglyph glasses)
1654         int colormask[4];
1655
1656         // global RGB color multiplier for rendering
1657         float colorscale;
1658
1659         // whether to call R_ClearScreen before rendering stuff
1660         qboolean clear;
1661         // if true, don't clear or do any post process effects (bloom, etc)
1662         qboolean isoverlay;
1663         // 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)
1664         qboolean ismain;
1665
1666         // whether to draw r_showtris and such, this is only true for the main
1667         // view render, all secondary renders (mirrors, portals, cameras,
1668         // distortion effects, etc) omit such debugging information
1669         qboolean showdebug;
1670
1671         // these define which values to use in GL_CullFace calls to request frontface or backface culling
1672         int cullface_front;
1673         int cullface_back;
1674
1675         // render quality (0 to 1) - affects r_drawparticles_drawdistance and others
1676         float quality;
1677 }
1678 r_refdef_view_t;
1679
1680 typedef struct r_refdef_viewcache_s
1681 {
1682         // updated by gl_main_newmap()
1683         int maxentities;
1684         int world_numclusters;
1685         int world_numclusterbytes;
1686         int world_numleafs;
1687         int world_numsurfaces;
1688
1689         // these properties are generated by R_View_Update()
1690
1691         // which entities are currently visible for this viewpoint
1692         // (the used range is 0...r_refdef.scene.numentities)
1693         unsigned char *entityvisible;
1694
1695         // flag arrays used for visibility checking on world model
1696         // (all other entities have no per-surface/per-leaf visibility checks)
1697         unsigned char *world_pvsbits;
1698         unsigned char *world_leafvisible;
1699         unsigned char *world_surfacevisible;
1700         // if true, the view is currently in a leaf without pvs data
1701         qboolean world_novis;
1702 }
1703 r_refdef_viewcache_t;
1704
1705 // TODO: really think about which fields should go into scene and which one should stay in refdef [1/7/2008 Black]
1706 // maybe also refactor some of the functions to support different setting sources (ie. fogenabled, etc.) for different scenes
1707 typedef struct r_refdef_scene_s {
1708         // whether to call S_ExtraUpdate during render to reduce sound chop
1709         qboolean extraupdate;
1710
1711         // (client gameworld) time for rendering time based effects
1712         double time;
1713
1714         // the world
1715         entity_render_t *worldentity;
1716
1717         // same as worldentity->model
1718         dp_model_t *worldmodel;
1719
1720         // renderable entities (excluding world)
1721         entity_render_t **entities;
1722         int numentities;
1723         int maxentities;
1724
1725         // field of temporary entities that is reset each (client) frame
1726         entity_render_t *tempentities;
1727         int numtempentities;
1728         int maxtempentities;
1729         qboolean expandtempentities;
1730
1731         // renderable dynamic lights
1732         rtlight_t *lights[MAX_DLIGHTS];
1733         rtlight_t templights[MAX_DLIGHTS];
1734         int numlights;
1735
1736         // intensities for light styles right now, controls rtlights
1737         float rtlightstylevalue[MAX_LIGHTSTYLES];       // float fraction of base light value
1738         // 8.8bit fixed point intensities for light styles
1739         // controls intensity lightmap layers
1740         unsigned short lightstylevalue[MAX_LIGHTSTYLES];        // 8.8 fraction of base light value
1741
1742         float ambient;
1743
1744         qboolean rtworld;
1745         qboolean rtworldshadows;
1746         qboolean rtdlight;
1747         qboolean rtdlightshadows;
1748 } r_refdef_scene_t;
1749
1750 typedef struct r_refdef_s
1751 {
1752         // these fields define the basic rendering information for the world
1753         // but not the view, which could change multiple times in one rendered
1754         // frame (for example when rendering textures for certain effects)
1755
1756         // these are set for water warping before
1757         // frustum_x/frustum_y are calculated
1758         float frustumscale_x, frustumscale_y;
1759
1760         // current view settings (these get reset a few times during rendering because of water rendering, reflections, etc)
1761         r_refdef_view_t view;
1762         r_refdef_viewcache_t viewcache;
1763
1764         // minimum visible distance (pixels closer than this disappear)
1765         double nearclip;
1766         // maximum visible distance (pixels further than this disappear in 16bpp modes,
1767         // in 32bpp an infinite-farclip matrix is used instead)
1768         double farclip;
1769
1770         // fullscreen color blend
1771         float viewblend[4];
1772
1773         r_refdef_scene_t scene;
1774
1775         float fogplane[4];
1776         float fogplaneviewdist;
1777         qboolean fogplaneviewabove;
1778         float fogheightfade;
1779         float fogcolor[3];
1780         float fogrange;
1781         float fograngerecip;
1782         float fogmasktabledistmultiplier;
1783 #define FOGMASKTABLEWIDTH 1024
1784         float fogmasktable[FOGMASKTABLEWIDTH];
1785         float fogmasktable_start, fogmasktable_alpha, fogmasktable_range, fogmasktable_density;
1786         float fog_density;
1787         float fog_red;
1788         float fog_green;
1789         float fog_blue;
1790         float fog_alpha;
1791         float fog_start;
1792         float fog_end;
1793         float fog_height;
1794         float fog_fadedepth;
1795         qboolean fogenabled;
1796         qboolean oldgl_fogenable;
1797
1798         // new flexible texture height fog (overrides normal fog)
1799         char fog_height_texturename[64]; // note: must be 64 for the sscanf code
1800         unsigned char *fog_height_table1d;
1801         unsigned char *fog_height_table2d;
1802         int fog_height_tablesize; // enable
1803         float fog_height_tablescale;
1804         float fog_height_texcoordscale;
1805         char fogheighttexturename[64]; // detects changes to active fog height texture
1806
1807         int draw2dstage; // 0 = no, 1 = yes, other value = needs setting up again
1808
1809         // true during envmap command capture
1810         qboolean envmap;
1811
1812         // brightness of world lightmaps and related lighting
1813         // (often reduced when world rtlights are enabled)
1814         float lightmapintensity;
1815         // whether to draw world lights realtime, dlights realtime, and their shadows
1816         float polygonfactor;
1817         float polygonoffset;
1818         float shadowpolygonfactor;
1819         float shadowpolygonoffset;
1820
1821         // how long R_RenderView took on the previous frame
1822         double lastdrawscreentime;
1823
1824         // rendering stats for r_speeds display
1825         // (these are incremented in many places)
1826         r_refdef_stats_t stats;
1827 }
1828 r_refdef_t;
1829
1830 extern r_refdef_t r_refdef;
1831
1832 typedef enum waterlevel_e
1833 {
1834         WATERLEVEL_NONE,
1835         WATERLEVEL_WETFEET,
1836         WATERLEVEL_SWIMMING,
1837         WATERLEVEL_SUBMERGED
1838 }
1839 waterlevel_t;
1840
1841 typedef struct cl_clientmovement_state_s
1842 {
1843         // entity to be ignored for movement
1844         struct prvm_edict_s *self;
1845         // position
1846         vec3_t origin;
1847         vec3_t velocity;
1848         // current bounding box (different if crouched vs standing)
1849         vec3_t mins;
1850         vec3_t maxs;
1851         // currently on the ground
1852         qboolean onground;
1853         // currently crouching
1854         qboolean crouched;
1855         // what kind of water (SUPERCONTENTS_LAVA for instance)
1856         int watertype;
1857         // how deep
1858         waterlevel_t waterlevel;
1859         // weird hacks when jumping out of water
1860         // (this is in seconds and counts down to 0)
1861         float waterjumptime;
1862
1863         // user command
1864         usercmd_t cmd;
1865 }
1866 cl_clientmovement_state_t;
1867 void CL_ClientMovement_PlayerMove_Frame(cl_clientmovement_state_t *s);
1868
1869 // warpzone prediction hack (CSQC builtin)
1870 void CL_RotateMoves(const matrix4x4_t *m);
1871
1872 void CL_NewFrameReceived(int num);
1873 void CL_ParseEntityLump(char *entitystring);
1874 void CL_FindNonSolidLocation(const vec3_t in, vec3_t out, vec_t radius);
1875 void CL_RelinkLightFlashes(void);
1876 void Sbar_ShowFPS(void);
1877 void Sbar_ShowFPS_Update(void);
1878 void Host_SaveConfig(void);
1879 void Host_LoadConfig_f(void);
1880 void CL_UpdateMoveVars(void);
1881 void SCR_CaptureVideo_SoundFrame(const portable_sampleframe_t *paintbuffer, size_t length);
1882 void V_DriftPitch(void);
1883 void V_FadeViewFlashs(void);
1884 void V_CalcViewBlend(void);
1885 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);
1886 void V_CalcRefdef(void);
1887 void CL_Locs_Reload_f(void);
1888
1889 #endif
1890