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