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