client.h

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