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