client.h

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