client.h

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