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