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