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