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 #include "snd_main.h"
  27
  28 // flags for rtlight rendering
  29 #define LIGHTFLAG_NORMALMODE 1
  30 #define LIGHTFLAG_REALTIMEMODE 2
  31
  32 typedef struct tridecal_s
  33 {
  34         // color and initial alpha value
  35         float                   texcoord2f[3][2];
  36         float                   vertex3f[3][3];
  37         unsigned char   color4ub[3][4];
  38         // how long this decal has lived so far (the actual fade begins at cl_decals_time)
  39         float                   lived;
  40         // if >= 0 this indicates the decal should follow an animated triangle
  41         int                             triangleindex;
  42         // for visibility culling
  43         int                             surfaceindex;
  44         // old decals are killed to obey cl_decals_max
  45         int                             decalsequence;
  46 }
  47 tridecal_t;
  48
  49 typedef struct decalsystem_s
  50 {
  51         dp_model_t *model;
  52         double lastupdatetime;
  53         int maxdecals;
  54         int freedecal;
  55         int numdecals;
  56         tridecal_t *decals;
  57         float *vertex3f;
  58         float *texcoord2f;
  59         float *color4f;
  60         int *element3i;
  61         unsigned short *element3s;
  62 }
  63 decalsystem_t;
  64
  65 typedef struct effect_s
  66 {
  67         int active;
  68         vec3_t origin;
  69         double starttime;
  70         float framerate;
  71         int modelindex;
  72         int startframe;
  73         int endframe;
  74         // these are for interpolation
  75         int frame;
  76         double frame1time;
  77         double frame2time;
  78 }
  79 cl_effect_t;
  80
  81 typedef struct beam_s
  82 {
  83         int             entity;
  84         // draw this as lightning polygons, or a model?
  85         int             lightning;
  86         struct model_s  *model;
  87         float   endtime;
  88         vec3_t  start, end;
  89 }
  90 beam_t;
  91
  92 typedef struct rtlight_s
  93 {
  94         // shadow volumes are done entirely in model space, so there are no matrices for dealing with them...  they just use the origin
  95
  96         // note that the world to light matrices are inversely scaled (divided) by lightradius
  97
  98         // core properties
  99         /// matrix for transforming light filter coordinates to world coordinates
 100         matrix4x4_t matrix_lighttoworld;
 101         /// matrix for transforming world coordinates to light filter coordinates
 102         matrix4x4_t matrix_worldtolight;
 103         /// typically 1 1 1, can be lower (dim) or higher (overbright)
 104         vec3_t color;
 105         /// size of the light (remove?)
 106         vec_t radius;
 107         /// light filter
 108         char cubemapname[64];
 109         /// light style to monitor for brightness
 110         int style;
 111         /// whether light should render shadows
 112         int shadow;
 113         /// intensity of corona to render
 114         vec_t corona;
 115         /// radius scale of corona to render (1.0 means same as light radius)
 116         vec_t coronasizescale;
 117         /// ambient intensity to render
 118         vec_t ambientscale;
 119         /// diffuse intensity to render
 120         vec_t diffusescale;
 121         /// specular intensity to render
 122         vec_t specularscale;
 123         /// LIGHTFLAG_* flags
 124         int flags;
 125
 126         // generated properties
 127         /// used only for shadow volumes
 128         vec3_t shadoworigin;
 129         /// culling
 130         vec3_t cullmins;
 131         vec3_t cullmaxs;
 132         // culling
 133         //vec_t cullradius;
 134         // squared cullradius
 135         //vec_t cullradius2;
 136
 137         // rendering properties, updated each time a light is rendered
 138         // this is rtlight->color * d_lightstylevalue
 139         vec3_t currentcolor;
 140         /// used by corona updates, due to occlusion query
 141         float corona_visibility;
 142         unsigned int corona_queryindex_visiblepixels;
 143         unsigned int corona_queryindex_allpixels;
 144         /// this is R_GetCubemap(rtlight->cubemapname)
 145         rtexture_t *currentcubemap;
 146         /// set by R_Shadow_PrepareLight to decide whether R_Shadow_DrawLight should draw it
 147         qboolean draw;
 148         /// these fields are set by R_Shadow_PrepareLight for later drawing
 149         int cached_numlightentities;
 150         int cached_numlightentities_noselfshadow;
 151         int cached_numshadowentities;
 152         int cached_numshadowentities_noselfshadow;
 153         int cached_numsurfaces;
 154         struct entity_render_s **cached_lightentities;
 155         struct entity_render_s **cached_lightentities_noselfshadow;
 156         struct entity_render_s **cached_shadowentities;
 157         struct entity_render_s **cached_shadowentities_noselfshadow;
 158         unsigned char *cached_shadowtrispvs;
 159         unsigned char *cached_lighttrispvs;
 160         int *cached_surfacelist;
 161         // reduced light cullbox from GetLightInfo
 162         vec3_t cached_cullmins;
 163         vec3_t cached_cullmaxs;
 164         // current shadow-caster culling planes based on view
 165         // (any geometry outside these planes can not contribute to the visible
 166         //  shadows in any way, and thus can be culled safely)
 167         int cached_numfrustumplanes;
 168         mplane_t cached_frustumplanes[5]; // see R_Shadow_ComputeShadowCasterCullingPlanes
 169
 170         /// static light info
 171         /// true if this light should be compiled as a static light
 172         int isstatic;
 173         /// true if this is a compiled world light, cleared if the light changes
 174         int compiled;
 175         /// the shadowing mode used to compile this light
 176         int shadowmode;
 177         /// premade shadow volumes to render for world entity
 178         shadowmesh_t *static_meshchain_shadow_zpass;
 179         shadowmesh_t *static_meshchain_shadow_zfail;
 180         shadowmesh_t *static_meshchain_shadow_shadowmap;
 181         /// used for visibility testing (more exact than bbox)
 182         int static_numleafs;
 183         int static_numleafpvsbytes;
 184         int *static_leaflist;
 185         unsigned char *static_leafpvs;
 186         /// surfaces seen by light
 187         int static_numsurfaces;
 188         int *static_surfacelist;
 189         /// flag bits indicating which triangles of the world model should cast
 190         /// shadows, and which ones should be lit
 191         ///
 192         /// this avoids redundantly scanning the triangles in each surface twice
 193         /// for whether they should cast shadows, once in culling and once in the
 194         /// actual shadowmarklist production.
 195         int static_numshadowtrispvsbytes;
 196         unsigned char *static_shadowtrispvs;
 197         /// this allows the lighting batch code to skip backfaces andother culled
 198         /// triangles not relevant for lighting
 199         /// (important on big surfaces such as terrain)
 200         int static_numlighttrispvsbytes;
 201         unsigned char *static_lighttrispvs;
 202         /// masks of all shadowmap sides that have any potential static receivers or casters
 203         int static_shadowmap_receivers;
 204         int static_shadowmap_casters;
 205 }
 206 rtlight_t;
 207
 208 typedef struct dlight_s
 209 {
 210         // destroy light after this time
 211         // (dlight only)
 212         vec_t die;
 213         // the entity that owns this light (can be NULL)
 214         // (dlight only)
 215         struct entity_render_s *ent;
 216         // location
 217         // (worldlight: saved to .rtlights file)
 218         vec3_t origin;
 219         // worldlight orientation
 220         // (worldlight only)
 221         // (worldlight: saved to .rtlights file)
 222         vec3_t angles;
 223         // dlight orientation/scaling/location
 224         // (dlight only)
 225         matrix4x4_t matrix;
 226         // color of light
 227         // (worldlight: saved to .rtlights file)
 228         vec3_t color;
 229         // cubemap name to use on this light
 230         // (worldlight: saved to .rtlights file)
 231         char cubemapname[64];
 232         // make light flash while selected
 233         // (worldlight only)
 234         int selected;
 235         // brightness (not really radius anymore)
 236         // (worldlight: saved to .rtlights file)
 237         vec_t radius;
 238         // drop intensity this much each second
 239         // (dlight only)
 240         vec_t decay;
 241         // intensity value which is dropped over time
 242         // (dlight only)
 243         vec_t intensity;
 244         // initial values for intensity to modify
 245         // (dlight only)
 246         vec_t initialradius;
 247         vec3_t initialcolor;
 248         // light style which controls intensity of this light
 249         // (worldlight: saved to .rtlights file)
 250         int style;
 251         // cast shadows
 252         // (worldlight: saved to .rtlights file)
 253         int shadow;
 254         // corona intensity
 255         // (worldlight: saved to .rtlights file)
 256         vec_t corona;
 257         // radius scale of corona to render (1.0 means same as light radius)
 258         // (worldlight: saved to .rtlights file)
 259         vec_t coronasizescale;
 260         // ambient intensity to render
 261         // (worldlight: saved to .rtlights file)
 262         vec_t ambientscale;
 263         // diffuse intensity to render
 264         // (worldlight: saved to .rtlights file)
 265         vec_t diffusescale;
 266         // specular intensity to render
 267         // (worldlight: saved to .rtlights file)
 268         vec_t specularscale;
 269         // LIGHTFLAG_* flags
 270         // (worldlight: saved to .rtlights file)
 271         int flags;
 272         // linked list of world lights
 273         // (worldlight only)
 274         struct dlight_s *next;
 275         // embedded rtlight struct for renderer
 276         // (worldlight only)
 277         rtlight_t rtlight;
 278 }
 279 dlight_t;
 280
 281 #define MAX_FRAMEGROUPBLENDS 4
 282 typedef struct framegroupblend_s
 283 {
 284         // animation number and blend factor
 285         // (for most models this is the frame number)
 286         int frame;
 287         float lerp;
 288         // time frame began playing (for framegroup animations)
 289         double start;
 290 }
 291 framegroupblend_t;
 292
 293 // this is derived from processing of the framegroupblend array
 294 // note: technically each framegroupblend can produce two of these, but that
 295 // never happens in practice because no one blends between more than 2
 296 // framegroups at once
 297 #define MAX_FRAMEBLENDS (MAX_FRAMEGROUPBLENDS * 2)
 298 typedef struct frameblend_s
 299 {
 300         int subframe;
 301         float lerp;
 302 }
 303 frameblend_t;
 304
 305 // LordHavoc: this struct is intended for the renderer but some fields are
 306 // used by the client.
 307 //
 308 // The renderer should not rely on any changes to this struct to be persistent
 309 // across multiple frames because temp entities are wiped every frame, but it
 310 // is acceptable to cache things in this struct that are not critical.
 311 //
 312 // For example the r_cullentities_trace code does such caching.
 313 typedef struct entity_render_s
 314 {
 315         // location
 316         //vec3_t origin;
 317         // orientation
 318         //vec3_t angles;
 319         // transform matrix for model to world
 320         matrix4x4_t matrix;
 321         // transform matrix for world to model
 322         matrix4x4_t inversematrix;
 323         // opacity (alpha) of the model
 324         float alpha;
 325         // size the model is shown
 326         float scale;
 327         // transparent sorting offset
 328         float transparent_offset;
 329
 330         // NULL = no model
 331         dp_model_t *model;
 332         // number of the entity represents, or 0 for non-network entities
 333         int entitynumber;
 334         // literal colormap colors for renderer, if both are 0 0 0 it is not colormapped
 335         vec3_t colormap_pantscolor;
 336         vec3_t colormap_shirtcolor;
 337         // light, particles, etc
 338         int effects;
 339         // qw CTF flags and other internal-use-only effect bits
 340         int internaleffects;
 341         // for Alias models
 342         int skinnum;
 343         // render flags
 344         int flags;
 345
 346         // colormod tinting of models
 347         float colormod[3];
 348         float glowmod[3];
 349
 350         // interpolated animation - active framegroups and blend factors
 351         framegroupblend_t framegroupblend[MAX_FRAMEGROUPBLENDS];
 352
 353         // time of last model change (for shader animations)
 354         double shadertime;
 355
 356         // calculated by the renderer (but not persistent)
 357
 358         // calculated during R_AddModelEntities
 359         vec3_t mins, maxs;
 360         // subframe numbers (-1 if not used) and their blending scalers (0-1), if interpolation is not desired, use subframeblend[0].subframe
 361         frameblend_t frameblend[MAX_FRAMEBLENDS];
 362         // skeletal animation data (if skeleton.relativetransforms is not NULL, it overrides frameblend)
 363         skeleton_t *skeleton;
 364
 365         // animation cache (pointers allocated using R_FrameData_Alloc)
 366         // ONLY valid during R_RenderView!  may be NULL (not cached)
 367         float *animcache_vertex3f;
 368         float *animcache_normal3f;
 369         float *animcache_svector3f;
 370         float *animcache_tvector3f;
 371
 372         // current lighting from map (updated ONLY by client code, not renderer)
 373         vec3_t modellight_ambient;
 374         vec3_t modellight_diffuse; // q3bsp
 375         vec3_t modellight_lightdir; // q3bsp
 376
 377         // storage of decals on this entity
 378         // (note: if allowdecals is set, be sure to call R_DecalSystem_Reset on removal!)
 379         int allowdecals;
 380         decalsystem_t decalsystem;
 381
 382         // FIELDS UPDATED BY RENDERER:
 383         // last time visible during trace culling
 384         double last_trace_visibility;
 385
 386         // user wavefunc parameters (from csqc)
 387         float userwavefunc_param[Q3WAVEFUNC_USER_COUNT];
 388 }
 389 entity_render_t;
 390
 391 typedef struct entity_persistent_s
 392 {
 393         vec3_t trail_origin;
 394
 395         // particle trail
 396         float trail_time;
 397         qboolean trail_allowed; // set to false by teleports, true by update code, prevents bad lerps
 398
 399         // muzzleflash fading
 400         float muzzleflash;
 401
 402         // interpolated movement
 403
 404         // start time of move
 405         float lerpstarttime;
 406         // time difference from start to end of move
 407         float lerpdeltatime;
 408         // the move itself, start and end
 409         float oldorigin[3];
 410         float oldangles[3];
 411         float neworigin[3];
 412         float newangles[3];
 413 }
 414 entity_persistent_t;
 415
 416 typedef struct entity_s
 417 {
 418         // baseline state (default values)
 419         entity_state_t state_baseline;
 420         // previous state (interpolating from this)
 421         entity_state_t state_previous;
 422         // current state (interpolating to this)
 423         entity_state_t state_current;
 424
 425         // used for regenerating parts of render
 426         entity_persistent_t persistent;
 427
 428         // the only data the renderer should know about
 429         entity_render_t render;
 430 }
 431 entity_t;
 432
 433 typedef struct usercmd_s
 434 {
 435         vec3_t  viewangles;
 436
 437 // intended velocities
 438         float   forwardmove;
 439         float   sidemove;
 440         float   upmove;
 441
 442         vec3_t  cursor_screen;
 443         vec3_t  cursor_start;
 444         vec3_t  cursor_end;
 445         vec3_t  cursor_impact;
 446         vec3_t  cursor_normal;
 447         vec_t   cursor_fraction;
 448         int             cursor_entitynumber;
 449
 450         double time; // time the move is executed for (cl_movement: clienttime, non-cl_movement: receivetime)
 451         double receivetime; // time the move was received at
 452         double clienttime; // time to which server state the move corresponds to
 453         int msec; // for predicted moves
 454         int buttons;
 455         int impulse;
 456         int sequence;
 457         qboolean applied; // if false we're still accumulating a move
 458         qboolean predicted; // if true the sequence should be sent as 0
 459
 460         // derived properties
 461         double frametime;
 462         qboolean canjump;
 463         qboolean jump;
 464         qboolean crouch;
 465 } usercmd_t;
 466
 467 typedef struct lightstyle_s
 468 {
 469         int             length;
 470         char    map[MAX_STYLESTRING];
 471 } lightstyle_t;
 472
 473 typedef struct scoreboard_s
 474 {
 475         char    name[MAX_SCOREBOARDNAME];
 476         int             frags;
 477         int             colors; // two 4 bit fields
 478         // QW fields:
 479         int             qw_userid;
 480         char    qw_userinfo[MAX_USERINFO_STRING];
 481         float   qw_entertime;
 482         int             qw_ping;
 483         int             qw_packetloss;
 484         int             qw_movementloss;
 485         int             qw_spectator;
 486         char    qw_team[8];
 487         char    qw_skin[MAX_QPATH];
 488 } scoreboard_t;
 489
 490 typedef struct cshift_s
 491 {
 492         float   destcolor[3];
 493         float   percent;                // 0-255
 494         float   alphafade;      // (any speed)
 495 } cshift_t;
 496
 497 #define CSHIFT_CONTENTS 0
 498 #define CSHIFT_DAMAGE   1
 499 #define CSHIFT_BONUS    2
 500 #define CSHIFT_POWERUP  3
 501 #define CSHIFT_VCSHIFT  4
 502 #define NUM_CSHIFTS             5
 503
 504 #define NAME_LENGTH     64
 505
 506
 507 //
 508 // client_state_t should hold all pieces of the client state
 509 //
 510
 511 #define SIGNONS         4                       // signon messages to receive before connected
 512
 513 typedef enum cactive_e
 514 {
 515         ca_uninitialized,       // during early startup
 516         ca_dedicated,           // a dedicated server with no ability to start a client
 517         ca_disconnected,        // full screen console with no connection
 518         ca_connected            // valid netcon, talking to a server
 519 }
 520 cactive_t;
 521
 522 typedef enum qw_downloadtype_e
 523 {
 524         dl_none,
 525         dl_single,
 526         dl_skin,
 527         dl_model,
 528         dl_sound
 529 }
 530 qw_downloadtype_t;
 531
 532 typedef enum capturevideoformat_e
 533 {
 534         CAPTUREVIDEOFORMAT_AVI_I420,
 535         CAPTUREVIDEOFORMAT_OGG_VORBIS_THEORA,
 536 }
 537 capturevideoformat_t;
 538
 539 typedef struct capturevideostate_s
 540 {
 541         double startrealtime;
 542         double framerate;
 543         int framestep;
 544         int framestepframe;
 545         qboolean active;
 546         qboolean realtime;
 547         qboolean error;
 548         int soundrate;
 549         int soundchannels;
 550         int frame;
 551         double starttime;
 552         double lastfpstime;
 553         int lastfpsframe;
 554         int soundsampleframe;
 555         unsigned char *screenbuffer;
 556         unsigned char *outbuffer;
 557         char basename[MAX_QPATH];
 558         int width, height;
 559
 560         // precomputed RGB to YUV tables
 561         // converts the RGB values to YUV (see cap_avi.c for how to use them)
 562         short rgbtoyuvscaletable[3][3][256];
 563         unsigned char yuvnormalizetable[3][256];
 564
 565         // precomputed gamma ramp (only needed if the capturevideo module uses RGB output)
 566         // note: to map from these values to RGB24, you have to multiply by 255.0/65535.0, then add 0.5, then cast to integer
 567         unsigned short vidramp[256 * 3];
 568
 569         // stuff to be filled in by the video format module
 570         capturevideoformat_t format;
 571         const char *formatextension;
 572         qfile_t *videofile;
 573                 // always use this:
 574                 //   cls.capturevideo.videofile = FS_OpenRealFile(va("%s.%s", cls.capturevideo.basename, cls.capturevideo.formatextension), "wb", false);
 575         void (*endvideo) (void);
 576         void (*videoframes) (int num);
 577         void (*soundframe) (const portable_sampleframe_t *paintbuffer, size_t length);
 578
 579         // format specific data
 580         void *formatspecific;
 581 }
 582 capturevideostate_t;
 583
 584 #define CL_MAX_DOWNLOADACKS 4
 585
 586 typedef struct cl_downloadack_s
 587 {
 588         int start, size;
 589 }
 590 cl_downloadack_t;
 591
 592 typedef struct cl_soundstats_s
 593 {
 594         int mixedsounds;
 595         int totalsounds;
 596         int latency_milliseconds;
 597 }
 598 cl_soundstats_t;
 599
 600 //
 601 // the client_static_t structure is persistent through an arbitrary number
 602 // of server connections
 603 //
 604 typedef struct client_static_s
 605 {
 606         cactive_t state;
 607
 608         // all client memory allocations go in these pools
 609         mempool_t *levelmempool;
 610         mempool_t *permanentmempool;
 611
 612 // demo loop control
 613         // -1 = don't play demos
 614         int demonum;
 615         // list of demos in loop
 616         char demos[MAX_DEMOS][MAX_DEMONAME];
 617         // the actively playing demo (set by CL_PlayDemo_f)
 618         char demoname[MAX_QPATH];
 619
 620 // demo recording info must be here, because record is started before
 621 // entering a map (and clearing client_state_t)
 622         qboolean demorecording;
 623         fs_offset_t demo_lastcsprogssize;
 624         int demo_lastcsprogscrc;
 625         qboolean demoplayback;
 626         qboolean timedemo;
 627         // -1 = use normal cd track
 628         int forcetrack;
 629         qfile_t *demofile;
 630         // realtime at second frame of timedemo (LordHavoc: changed to double)
 631         double td_starttime;
 632         int td_frames; // total frames parsed
 633         double td_onesecondnexttime;
 634         double td_onesecondframes;
 635         double td_onesecondrealtime;
 636         double td_onesecondminfps;
 637         double td_onesecondmaxfps;
 638         double td_onesecondavgfps;
 639         int td_onesecondavgcount;
 640         // LordHavoc: pausedemo
 641         qboolean demopaused;
 642
 643         // sound mixer statistics for showsound display
 644         cl_soundstats_t soundstats;
 645
 646         qboolean connect_trying;
 647         int connect_remainingtries;
 648         double connect_nextsendtime;
 649         lhnetsocket_t *connect_mysocket;
 650         lhnetaddress_t connect_address;
 651         // protocol version of the server we're connected to
 652         // (kept outside client_state_t because it's used between levels)
 653         protocolversion_t protocol;
 654
 655 #define MAX_RCONS 16
 656         int rcon_trying;
 657         lhnetaddress_t rcon_addresses[MAX_RCONS];
 658         char rcon_commands[MAX_RCONS][MAX_INPUTLINE];
 659         double rcon_timeout[MAX_RCONS];
 660         int rcon_ringpos;
 661
 662 // connection information
 663         // 0 to SIGNONS
 664         int signon;
 665         // network connection
 666         netconn_t *netcon;
 667
 668         // download information
 669         // (note: qw_download variables are also used)
 670         cl_downloadack_t dp_downloadack[CL_MAX_DOWNLOADACKS];
 671
 672         // input sequence numbers are not reset on level change, only connect
 673         int movesequence;
 674         int servermovesequence;
 675
 676         // quakeworld stuff below
 677
 678         // value of "qport" cvar at time of connection
 679         int qw_qport;
 680         // copied from cls.netcon->qw. variables every time they change, or set by demos (which have no cls.netcon)
 681         int qw_incoming_sequence;
 682         int qw_outgoing_sequence;
 683
 684         // current file download buffer (only saved when file is completed)
 685         char qw_downloadname[MAX_QPATH];
 686         unsigned char *qw_downloadmemory;
 687         int qw_downloadmemorycursize;
 688         int qw_downloadmemorymaxsize;
 689         int qw_downloadnumber;
 690         int qw_downloadpercent;
 691         qw_downloadtype_t qw_downloadtype;
 692         // transfer rate display
 693         double qw_downloadspeedtime;
 694         int qw_downloadspeedcount;
 695         int qw_downloadspeedrate;
 696         qboolean qw_download_deflate;
 697
 698         // current file upload buffer (for uploading screenshots to server)
 699         unsigned char *qw_uploaddata;
 700         int qw_uploadsize;
 701         int qw_uploadpos;
 702
 703         // user infostring
 704         // this normally contains the following keys in quakeworld:
 705         // password spectator name team skin topcolor bottomcolor rate noaim msg *ver *ip
 706         char userinfo[MAX_USERINFO_STRING];
 707
 708         // video capture stuff
 709         capturevideostate_t capturevideo;
 710 }
 711 client_static_t;
 712
 713 extern client_static_t  cls;
 714
 715 typedef struct client_movementqueue_s
 716 {
 717         double time;
 718         float frametime;
 719         int sequence;
 720         float viewangles[3];
 721         float move[3];
 722         qboolean jump;
 723         qboolean crouch;
 724         qboolean canjump;
 725 }
 726 client_movementqueue_t;
 727
 728 //[515]: csqc
 729 typedef struct
 730 {
 731         qboolean drawworld;
 732         qboolean drawenginesbar;
 733         qboolean drawcrosshair;
 734 }csqc_vidvars_t;
 735
 736 typedef enum
 737 {
 738         PARTICLE_BILLBOARD = 0,
 739         PARTICLE_SPARK = 1,
 740         PARTICLE_ORIENTED_DOUBLESIDED = 2,
 741         PARTICLE_VBEAM = 3,
 742         PARTICLE_HBEAM = 4,
 743         PARTICLE_INVALID = -1
 744 }
 745 porientation_t;
 746
 747 typedef enum
 748 {
 749         PBLEND_ALPHA = 0,
 750         PBLEND_ADD = 1,
 751         PBLEND_INVMOD = 2,
 752         PBLEND_INVALID = -1
 753 }
 754 pblend_t;
 755
 756 typedef struct particletype_s
 757 {
 758         pblend_t blendmode;
 759         porientation_t orientation;
 760         qboolean lighting;
 761 }
 762 particletype_t;
 763
 764 typedef enum ptype_e
 765 {
 766         pt_dead, 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
 767 }
 768 ptype_t;
 769
 770 typedef struct decal_s
 771 {
 772         // fields used by rendering:  (44 bytes)
 773         unsigned short  typeindex;
 774         unsigned short  texnum;
 775         int                             decalsequence;
 776         vec3_t                  org;
 777         vec3_t                  normal;
 778         float                   size;
 779         float                   alpha; // 0-255
 780         unsigned char   color[3];
 781         unsigned char   unused1;
 782         int                             clusterindex; // cheap culling by pvs
 783
 784         // fields not used by rendering: (36 bytes in 32bit, 40 bytes in 64bit)
 785         float                   time2; // used for decal fade
 786         unsigned int    owner; // decal stuck to this entity
 787         dp_model_t                      *ownermodel; // model the decal is stuck to (used to make sure the entity is still alive)
 788         vec3_t                  relativeorigin; // decal at this location in entity's coordinate space
 789         vec3_t                  relativenormal; // decal oriented this way relative to entity's coordinate space
 790 }
 791 decal_t;
 792
 793 typedef struct particle_s
 794 {
 795         // for faster batch rendering, particles are rendered in groups by effect (resulting in less perfect sorting but far less state changes)
 796
 797         // fields used by rendering: (48 bytes)
 798         vec3_t          sortorigin; // sort by this group origin, not particle org
 799         vec3_t          org;
 800         vec3_t          vel; // velocity of particle, or orientation of decal, or end point of beam
 801         float           size;
 802         float           alpha; // 0-255
 803         float           stretch; // only for sparks
 804
 805         // fields not used by rendering:  (44 bytes)
 806         float           stainsize;
 807         float           stainalpha;
 808         float           sizeincrease; // rate of size change per second
 809         float           alphafade; // how much alpha reduces per second
 810         float           time2; // used for snow fluttering and decal fade
 811         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)
 812         float           gravity; // how much gravity affects this particle (1.0 = normal gravity, 0.0 = none)
 813         float           airfriction; // how much air friction affects this object (objects with a low mass/size ratio tend to get more air friction)
 814         float           liquidfriction; // how much liquid friction affects this object (objects with a low mass/size ratio tend to get more liquid friction)
 815 //      float           delayedcollisions; // time that p->bounce becomes active
 816         float           delayedspawn; // time that particle appears and begins moving
 817         float           die; // time when this particle should be removed, regardless of alpha
 818
 819         // short variables grouped to save memory (4 bytes)
 820         short                   angle; // base rotation of particle
 821         short                   spin; // geometry rotation speed around the particle center normal
 822
 823         // byte variables grouped to save memory (12 bytes)
 824         unsigned char   color[3];
 825         unsigned char   qualityreduction; // enables skipping of this particle according to r_refdef.view.qualityreduction
 826         unsigned char   typeindex;
 827         unsigned char   blendmode;
 828         unsigned char   orientation;
 829         unsigned char   texnum;
 830         unsigned char   staincolor[3];
 831         signed char     staintexnum;
 832 }
 833 particle_t;
 834
 835 typedef enum cl_parsingtextmode_e
 836 {
 837         CL_PARSETEXTMODE_NONE,
 838         CL_PARSETEXTMODE_PING,
 839         CL_PARSETEXTMODE_STATUS,
 840         CL_PARSETEXTMODE_STATUS_PLAYERID,
 841         CL_PARSETEXTMODE_STATUS_PLAYERIP
 842 }
 843 cl_parsingtextmode_t;
 844
 845 typedef struct cl_locnode_s
 846 {
 847         struct cl_locnode_s *next;
 848         char *name;
 849         vec3_t mins, maxs;
 850 }
 851 cl_locnode_t;
 852
 853 typedef struct showlmp_s
 854 {
 855         qboolean        isactive;
 856         float           x;
 857         float           y;
 858         char            label[32];
 859         char            pic[128];
 860 }
 861 showlmp_t;
 862
 863 //
 864 // the client_state_t structure is wiped completely at every
 865 // server signon
 866 //
 867 typedef struct client_state_s
 868 {
 869         // true if playing in a local game and no one else is connected
 870         int islocalgame;
 871
 872         // send a clc_nop periodically until connected
 873         float sendnoptime;
 874
 875         // current input being accumulated by mouse/joystick/etc input
 876         usercmd_t cmd;
 877         // latest moves sent to the server that have not been confirmed yet
 878         usercmd_t movecmd[CL_MAX_USERCMDS];
 879
 880 // information for local display
 881         // health, etc
 882         int stats[MAX_CL_STATS];
 883         float *statsf; // points to stats[] array
 884         // last known inventory bit flags, for blinking
 885         int olditems;
 886         // cl.time of acquiring item, for blinking
 887         float item_gettime[32];
 888         // last known STAT_ACTIVEWEAPON
 889         int activeweapon;
 890         // cl.time of changing STAT_ACTIVEWEAPON
 891         float weapontime;
 892         // use pain anim frame if cl.time < this
 893         float faceanimtime;
 894         // for stair smoothing
 895         float stairsmoothz;
 896         double stairsmoothtime;
 897
 898         // color shifts for damage, powerups
 899         cshift_t cshifts[NUM_CSHIFTS];
 900         // and content types
 901         cshift_t prev_cshifts[NUM_CSHIFTS];
 902
 903 // the client maintains its own idea of view angles, which are
 904 // sent to the server each frame.  The server sets punchangle when
 905 // the view is temporarily offset, and an angle reset commands at the start
 906 // of each level and after teleporting.
 907
 908         // mviewangles is read from demo
 909         // viewangles is either client controlled or lerped from mviewangles
 910         vec3_t mviewangles[2], viewangles;
 911         // update by server, used by qc to do weapon recoil
 912         vec3_t mpunchangle[2], punchangle;
 913         // update by server, can be used by mods to kick view around
 914         vec3_t mpunchvector[2], punchvector;
 915         // update by server, used for lean+bob (0 is newest)
 916         vec3_t mvelocity[2], velocity;
 917         // update by server, can be used by mods for zooming
 918         vec_t mviewzoom[2], viewzoom;
 919         // if true interpolation the mviewangles and other interpolation of the
 920         // player is disabled until the next network packet
 921         // this is used primarily by teleporters, and when spectating players
 922         // special checking of the old fixangle[1] is used to differentiate
 923         // between teleporting and spectating
 924         qboolean fixangle[2];
 925
 926         // client movement simulation
 927         // these fields are only updated by CL_ClientMovement (called by CL_SendMove after parsing each network packet)
 928         // set by CL_ClientMovement_Replay functions
 929         qboolean movement_predicted;
 930         // if true the CL_ClientMovement_Replay function will update origin, etc
 931         qboolean movement_replay;
 932         // simulated data (this is valid even if cl.movement is false)
 933         vec3_t movement_origin;
 934         vec3_t movement_velocity;
 935         // whether the replay should allow a jump at the first sequence
 936         qboolean movement_replay_canjump;
 937
 938         // previous gun angles (for leaning effects)
 939         vec3_t gunangles_prev;
 940         vec3_t gunangles_highpass;
 941         vec3_t gunangles_adjustment_lowpass;
 942         vec3_t gunangles_adjustment_highpass;
 943         // previous gun angles (for leaning effects)
 944         vec3_t gunorg_prev;
 945         vec3_t gunorg_highpass;
 946         vec3_t gunorg_adjustment_lowpass;
 947         vec3_t gunorg_adjustment_highpass;
 948
 949 // pitch drifting vars
 950         float idealpitch;
 951         float pitchvel;
 952         qboolean nodrift;
 953         float driftmove;
 954         double laststop;
 955
 956 //[515]: added for csqc purposes
 957         float sensitivityscale;
 958         csqc_vidvars_t csqc_vidvars;    //[515]: these parms must be set to true by default
 959         qboolean csqc_wantsmousemove;
 960         qboolean csqc_paused; // vortex: int because could be flags
 961         struct model_s *csqc_model_precache[MAX_MODELS];
 962
 963         // local amount for smoothing stepups
 964         //float crouch;
 965
 966         // sent by server
 967         qboolean paused;
 968         qboolean onground;
 969         qboolean inwater;
 970
 971         // used by bob
 972         qboolean oldonground;
 973         double lastongroundtime;
 974         double hitgroundtime;
 975         float bob2_smooth;
 976         float bobfall_speed;
 977         float bobfall_swing;
 978
 979         // don't change view angle, full screen, etc
 980         int intermission;
 981         // latched at intermission start
 982         double completed_time;
 983
 984         // the timestamp of the last two messages
 985         double mtime[2];
 986
 987         // clients view of time, time should be between mtime[0] and mtime[1] to
 988         // generate a lerp point for other data, oldtime is the previous frame's
 989         // value of time, frametime is the difference between time and oldtime
 990         // note: cl.time may be beyond cl.mtime[0] if packet loss is occuring, it
 991         // is only forcefully limited when a packet is received
 992         double time, oldtime;
 993         // how long it has been since the previous client frame in real time
 994         // (not game time, for that use cl.time - cl.oldtime)
 995         double realframetime;
 996
 997         // fade var for fading while dead
 998         float deathfade;
 999
1000         // motionblur alpha level variable
1001         float motionbluralpha;
1002
1003         // copy of realtime from last recieved message, for net trouble icon
1004         float last_received_message;
1005
1006 // information that is static for the entire time connected to a server
1007         struct model_s *model_precache[MAX_MODELS];
1008         struct sfx_s *sound_precache[MAX_SOUNDS];
1009
1010         // FIXME: this is a lot of memory to be keeping around, this really should be dynamically allocated and freed somehow
1011         char model_name[MAX_MODELS][MAX_QPATH];
1012         char sound_name[MAX_SOUNDS][MAX_QPATH];
1013
1014         // for display on solo scoreboard
1015         char worldmessage[40]; // map title (not related to filename)
1016         // variants of map name
1017         char worldbasename[MAX_QPATH]; // %s
1018         char worldname[MAX_QPATH]; // maps/%s.bsp
1019         char worldnamenoextension[MAX_QPATH]; // maps/%s
1020         // cl_entitites[cl.viewentity] = player
1021         int viewentity;
1022         // the real player entity (normally same as viewentity,
1023         // different than viewentity if mod uses chasecam or other tricks)
1024         int realplayerentity;
1025         // this is updated to match cl.viewentity whenever it is in the clients
1026         // range, basically this is used in preference to cl.realplayerentity for
1027         // most purposes because when spectating another player it should show
1028         // their information rather than yours
1029         int playerentity;
1030         // max players that can be in this game
1031         int maxclients;
1032         // type of game (deathmatch, coop, singleplayer)
1033         int gametype;
1034
1035         // models and sounds used by engine code (particularly cl_parse.c)
1036         dp_model_t *model_bolt;
1037         dp_model_t *model_bolt2;
1038         dp_model_t *model_bolt3;
1039         dp_model_t *model_beam;
1040         sfx_t *sfx_wizhit;
1041         sfx_t *sfx_knighthit;
1042         sfx_t *sfx_tink1;
1043         sfx_t *sfx_ric1;
1044         sfx_t *sfx_ric2;
1045         sfx_t *sfx_ric3;
1046         sfx_t *sfx_r_exp3;
1047         // indicates that the file "sound/misc/talk2.wav" was found (for use by team chat messages)
1048         qboolean foundtalk2wav;
1049
1050 // refresh related state
1051
1052         // cl_entitites[0].model
1053         struct model_s *worldmodel;
1054
1055         // the gun model
1056         entity_t viewent;
1057
1058         // cd audio
1059         int cdtrack, looptrack;
1060
1061 // frag scoreboard
1062
1063         // [cl.maxclients]
1064         scoreboard_t *scores;
1065
1066         // keep track of svc_print parsing state (analyzes ping reports and status reports)
1067         cl_parsingtextmode_t parsingtextmode;
1068         int parsingtextplayerindex;
1069         // set by scoreboard code when sending ping command, this causes the next ping results to be hidden
1070         // (which could eat the wrong ping report if the player issues one
1071         //  manually, but they would still see a ping report, just a later one
1072         //  caused by the scoreboard code rather than the one they intentionally
1073         //  issued)
1074         int parsingtextexpectingpingforscores;
1075
1076         // entity database stuff
1077         // latest received entity frame numbers
1078 #define LATESTFRAMENUMS 32
1079         int latestframenumsposition;
1080         int latestframenums[LATESTFRAMENUMS];
1081         int latestsendnums[LATESTFRAMENUMS];
1082         entityframe_database_t *entitydatabase;
1083         entityframe4_database_t *entitydatabase4;
1084         entityframeqw_database_t *entitydatabaseqw;
1085
1086         // keep track of quake entities because they need to be killed if they get stale
1087         int lastquakeentity;
1088         unsigned char isquakeentity[MAX_EDICTS];
1089
1090         // bounding boxes for clientside movement
1091         vec3_t playerstandmins;
1092         vec3_t playerstandmaxs;
1093         vec3_t playercrouchmins;
1094         vec3_t playercrouchmaxs;
1095
1096         // old decals are killed based on this
1097         int decalsequence;
1098
1099         int max_entities;
1100         int max_csqcrenderentities;
1101         int max_static_entities;
1102         int max_effects;
1103         int max_beams;
1104         int max_dlights;
1105         int max_lightstyle;
1106         int max_brushmodel_entities;
1107         int max_particles;
1108         int max_decals;
1109         int max_showlmps;
1110
1111         entity_t *entities;
1112         entity_render_t *csqcrenderentities;
1113         unsigned char *entities_active;
1114         entity_t *static_entities;
1115         cl_effect_t *effects;
1116         beam_t *beams;
1117         dlight_t *dlights;
1118         lightstyle_t *lightstyle;
1119         int *brushmodel_entities;
1120         particle_t *particles;
1121         decal_t *decals;
1122         showlmp_t *showlmps;
1123
1124         int num_entities;
1125         int num_static_entities;
1126         int num_brushmodel_entities;
1127         int num_effects;
1128         int num_beams;
1129         int num_dlights;
1130         int num_particles;
1131         int num_decals;
1132         int num_showlmps;
1133
1134         double particles_updatetime;
1135         double decals_updatetime;
1136         int free_particle;
1137         int free_decal;
1138
1139         // cl_serverextension_download feature
1140         int loadmodel_current;
1141         int downloadmodel_current;
1142         int loadmodel_total;
1143         int loadsound_current;
1144         int downloadsound_current;
1145         int loadsound_total;
1146         qboolean downloadcsqc;
1147         qboolean loadcsqc;
1148         qboolean loadbegun;
1149         qboolean loadfinished;
1150
1151         // quakeworld stuff
1152
1153         // local copy of the server infostring
1154         char qw_serverinfo[MAX_SERVERINFO_STRING];
1155
1156         // time of last qw "pings" command sent to server while showing scores
1157         double last_ping_request;
1158
1159         // used during connect
1160         int qw_servercount;
1161
1162         // updated from serverinfo
1163         int qw_teamplay;
1164
1165         // unused: indicates whether the player is spectating
1166         // use cl.scores[cl.playerentity-1].qw_spectator instead
1167         //qboolean qw_spectator;
1168
1169         // last time an input packet was sent
1170         double lastpackettime;
1171
1172         // movement parameters for client prediction
1173         unsigned int moveflags;
1174         float movevars_wallfriction;
1175         float movevars_waterfriction;
1176         float movevars_friction;
1177         float movevars_timescale;
1178         float movevars_gravity;
1179         float movevars_stopspeed;
1180         float movevars_maxspeed;
1181         float movevars_spectatormaxspeed;
1182         float movevars_accelerate;
1183         float movevars_airaccelerate;
1184         float movevars_wateraccelerate;
1185         float movevars_entgravity;
1186         float movevars_jumpvelocity;
1187         float movevars_edgefriction;
1188         float movevars_maxairspeed;
1189         float movevars_stepheight;
1190         float movevars_airaccel_qw;
1191         float movevars_airaccel_sideways_friction;
1192         float movevars_airstopaccelerate;
1193         float movevars_airstrafeaccelerate;
1194         float movevars_maxairstrafespeed;
1195         float movevars_airstrafeaccel_qw;
1196         float movevars_aircontrol;
1197         float movevars_aircontrol_power;
1198         float movevars_warsowbunny_airforwardaccel;
1199         float movevars_warsowbunny_accel;
1200         float movevars_warsowbunny_topspeed;
1201         float movevars_warsowbunny_turnaccel;
1202         float movevars_warsowbunny_backtosideratio;
1203         float movevars_ticrate;
1204         float movevars_airspeedlimit_nonqw;
1205
1206         // models used by qw protocol
1207         int qw_modelindex_spike;
1208         int qw_modelindex_player;
1209         int qw_modelindex_flag;
1210         int qw_modelindex_s_explod;
1211
1212         vec3_t qw_intermission_origin;
1213         vec3_t qw_intermission_angles;
1214
1215         // 255 is the most nails the QW protocol could send
1216         int qw_num_nails;
1217         vec_t qw_nails[255][6];
1218
1219         float qw_weaponkick;
1220
1221         int qw_validsequence;
1222
1223         int qw_deltasequence[QW_UPDATE_BACKUP];
1224
1225         // csqc stuff:
1226         // server entity number corresponding to a clientside entity
1227         unsigned short csqc_server2csqcentitynumber[MAX_EDICTS];
1228         qboolean csqc_loaded;
1229         vec3_t csqc_origin;
1230         vec3_t csqc_angles;
1231         qboolean csqc_usecsqclistener;
1232         matrix4x4_t csqc_listenermatrix;
1233         char csqc_printtextbuf[MAX_INPUTLINE];
1234
1235         // collision culling data
1236         world_t world;
1237
1238         // loc file stuff (points and boxes describing locations in the level)
1239         cl_locnode_t *locnodes;
1240         // this is updated to cl.movement_origin whenever health is < 1
1241         // used by %d print in say/say_team messages if cl_locs_enable is on
1242         vec3_t lastdeathorigin;
1243
1244         // processing buffer used by R_BuildLightMap, reallocated as needed,
1245         // freed on each level change
1246         size_t buildlightmapmemorysize;
1247         unsigned char *buildlightmapmemory;
1248 }
1249 client_state_t;
1250
1251 //
1252 // cvars
1253 //
1254 extern cvar_t cl_name;
1255 extern cvar_t cl_color;
1256 extern cvar_t cl_rate;
1257 extern cvar_t cl_pmodel;
1258 extern cvar_t cl_playermodel;
1259 extern cvar_t cl_playerskin;
1260
1261 extern cvar_t rcon_password;
1262 extern cvar_t rcon_address;
1263
1264 extern cvar_t cl_upspeed;
1265 extern cvar_t cl_forwardspeed;
1266 extern cvar_t cl_backspeed;
1267 extern cvar_t cl_sidespeed;
1268
1269 extern cvar_t cl_movespeedkey;
1270
1271 extern cvar_t cl_yawspeed;
1272 extern cvar_t cl_pitchspeed;
1273
1274 extern cvar_t cl_anglespeedkey;
1275
1276 extern cvar_t cl_autofire;
1277
1278 extern cvar_t cl_shownet;
1279 extern cvar_t cl_nolerp;
1280 extern cvar_t cl_nettimesyncfactor;
1281 extern cvar_t cl_nettimesyncboundmode;
1282 extern cvar_t cl_nettimesyncboundtolerance;
1283
1284 extern cvar_t cl_pitchdriftspeed;
1285 extern cvar_t lookspring;
1286 extern cvar_t lookstrafe;
1287 extern cvar_t sensitivity;
1288
1289 extern cvar_t freelook;
1290
1291 extern cvar_t m_pitch;
1292 extern cvar_t m_yaw;
1293 extern cvar_t m_forward;
1294 extern cvar_t m_side;
1295
1296 extern cvar_t cl_autodemo;
1297 extern cvar_t cl_autodemo_nameformat;
1298 extern cvar_t cl_autodemo_delete;
1299
1300 extern cvar_t r_draweffects;
1301
1302 extern cvar_t cl_explosions_alpha_start;
1303 extern cvar_t cl_explosions_alpha_end;
1304 extern cvar_t cl_explosions_size_start;
1305 extern cvar_t cl_explosions_size_end;
1306 extern cvar_t cl_explosions_lifetime;
1307 extern cvar_t cl_stainmaps;
1308 extern cvar_t cl_stainmaps_clearonload;
1309
1310 extern cvar_t cl_prydoncursor;
1311 extern cvar_t cl_prydoncursor_notrace;
1312
1313 extern cvar_t cl_locs_enable;
1314
1315 extern client_state_t cl;
1316
1317 extern void CL_AllocLightFlash (entity_render_t *ent, matrix4x4_t *matrix, float radius, float red, float green, float blue, float decay, float lifetime, int cubemapnum, int style, int shadowenable, vec_t corona, vec_t coronasizescale, vec_t ambientscale, vec_t diffusescale, vec_t specularscale, int flags);
1318
1319 cl_locnode_t *CL_Locs_FindNearest(const vec3_t point);
1320 void CL_Locs_FindLocationName(char *buffer, size_t buffersize, vec3_t point);
1321
1322 //=============================================================================
1323
1324 //
1325 // cl_main
1326 //
1327
1328 void CL_Shutdown (void);
1329 void CL_Init (void);
1330
1331 void CL_EstablishConnection(const char *host);
1332
1333 void CL_Disconnect (void);
1334 void CL_Disconnect_f (void);
1335
1336 void CL_UpdateRenderEntity(entity_render_t *ent);
1337 void CL_SetEntityColormapColors(entity_render_t *ent, int colormap);
1338 void CL_UpdateViewEntities(void);
1339
1340 //
1341 // cl_input
1342 //
1343 typedef struct kbutton_s
1344 {
1345         int             down[2];                // key nums holding it down
1346         int             state;                  // low bit is down state
1347 }
1348 kbutton_t;
1349
1350 extern  kbutton_t       in_mlook, in_klook;
1351 extern  kbutton_t       in_strafe;
1352 extern  kbutton_t       in_speed;
1353
1354 void CL_InitInput (void);
1355 void CL_SendMove (void);
1356
1357 void CL_ValidateState(entity_state_t *s);
1358 void CL_MoveLerpEntityStates(entity_t *ent);
1359 void CL_LerpUpdate(entity_t *e);
1360 void CL_ParseTEnt (void);
1361 void CL_NewBeam (int ent, vec3_t start, vec3_t end, dp_model_t *m, int lightning);
1362 void CL_RelinkBeams (void);
1363 void CL_Beam_CalculatePositions (const beam_t *b, vec3_t start, vec3_t end);
1364 void CL_ClientMovement_Replay(void);
1365
1366 void CL_ClearTempEntities (void);
1367 entity_render_t *CL_NewTempEntity (double shadertime);
1368
1369 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
1370
1371 void CL_ClearState (void);
1372 void CL_ExpandEntities(int num);
1373 void CL_ExpandCSQCRenderEntities(int num);
1374 void CL_SetInfo(const char *key, const char *value, qboolean send, qboolean allowstarkey, qboolean allowmodel, qboolean quiet);
1375
1376
1377 void CL_UpdateWorld (void);
1378 void CL_WriteToServer (void);
1379 void CL_Input (void);
1380 extern int cl_ignoremousemoves;
1381
1382
1383 float CL_KeyState (kbutton_t *key);
1384 const char *Key_KeynumToString (int keynum);
1385 int Key_StringToKeynum (const char *str);
1386
1387 //
1388 // cl_demo.c
1389 //
1390 void CL_StopPlayback(void);
1391 void CL_ReadDemoMessage(void);
1392 void CL_WriteDemoMessage(sizebuf_t *mesage);
1393
1394 void CL_CutDemo(unsigned char **buf, fs_offset_t *filesize);
1395 void CL_PasteDemo(unsigned char **buf, fs_offset_t *filesize);
1396
1397 void CL_NextDemo(void);
1398 void CL_Stop_f(void);
1399 void CL_Record_f(void);
1400 void CL_PlayDemo_f(void);
1401 void CL_TimeDemo_f(void);
1402
1403 //
1404 // cl_parse.c
1405 //
1406 void CL_Parse_Init(void);
1407 void CL_Parse_Shutdown(void);
1408 void CL_ParseServerMessage(void);
1409 void CL_Parse_DumpPacket(void);
1410 void CL_Parse_ErrorCleanUp(void);
1411 void QW_CL_StartUpload(unsigned char *data, int size);
1412 extern cvar_t qport;
1413 void CL_KeepaliveMessage(qboolean readmessages); // call this during loading of large content
1414
1415 //
1416 // view
1417 //
1418 void V_StartPitchDrift (void);
1419 void V_StopPitchDrift (void);
1420
1421 void V_Init (void);
1422 float V_CalcRoll (vec3_t angles, vec3_t velocity);
1423 void V_UpdateBlends (void);
1424 void V_ParseDamage (void);
1425
1426 //
1427 // cl_part
1428 //
1429
1430 extern cvar_t cl_particles;
1431 extern cvar_t cl_particles_quality;
1432 extern cvar_t cl_particles_size;
1433 extern cvar_t cl_particles_quake;
1434 extern cvar_t cl_particles_blood;
1435 extern cvar_t cl_particles_blood_alpha;
1436 extern cvar_t cl_particles_blood_decal_alpha;
1437 extern cvar_t cl_particles_blood_decal_scalemin;
1438 extern cvar_t cl_particles_blood_decal_scalemax;
1439 extern cvar_t cl_particles_blood_bloodhack;
1440 extern cvar_t cl_particles_bulletimpacts;
1441 extern cvar_t cl_particles_explosions_sparks;
1442 extern cvar_t cl_particles_explosions_shell;
1443 extern cvar_t cl_particles_rain;
1444 extern cvar_t cl_particles_snow;
1445 extern cvar_t cl_particles_smoke;
1446 extern cvar_t cl_particles_smoke_alpha;
1447 extern cvar_t cl_particles_smoke_alphafade;
1448 extern cvar_t cl_particles_sparks;
1449 extern cvar_t cl_particles_bubbles;
1450 extern cvar_t cl_decals;
1451 extern cvar_t cl_decals_time;
1452 extern cvar_t cl_decals_fadetime;
1453
1454 void CL_Particles_Clear(void);
1455 void CL_Particles_Init(void);
1456 void CL_Particles_Shutdown(void);
1457 particle_t *CL_NewParticle(const vec3_t sortorigin, unsigned short ptypeindex, int pcolor1, int pcolor2, int ptex, float psize, float psizeincrease, float palpha, float palphafade, float pgravity, float pbounce, float px, float py, float pz, float pvx, float pvy, float pvz, float pairfriction, float pliquidfriction, float originjitter, float velocityjitter, qboolean pqualityreduction, float lifetime, float stretch, pblend_t blendmode, porientation_t orientation, int staincolor1, int staincolor2, int staintex, float stainalpha, float stainsize, float angle, float spin, float tint[4]);
1458
1459 typedef enum effectnameindex_s
1460 {
1461         EFFECT_NONE,
1462         EFFECT_TE_GUNSHOT,
1463         EFFECT_TE_GUNSHOTQUAD,
1464         EFFECT_TE_SPIKE,
1465         EFFECT_TE_SPIKEQUAD,
1466         EFFECT_TE_SUPERSPIKE,
1467         EFFECT_TE_SUPERSPIKEQUAD,
1468         EFFECT_TE_WIZSPIKE,
1469         EFFECT_TE_KNIGHTSPIKE,
1470         EFFECT_TE_EXPLOSION,
1471         EFFECT_TE_EXPLOSIONQUAD,
1472         EFFECT_TE_TAREXPLOSION,
1473         EFFECT_TE_TELEPORT,
1474         EFFECT_TE_LAVASPLASH,
1475         EFFECT_TE_SMALLFLASH,
1476         EFFECT_TE_FLAMEJET,
1477         EFFECT_EF_FLAME,
1478         EFFECT_TE_BLOOD,
1479         EFFECT_TE_SPARK,
1480         EFFECT_TE_PLASMABURN,
1481         EFFECT_TE_TEI_G3,
1482         EFFECT_TE_TEI_SMOKE,
1483         EFFECT_TE_TEI_BIGEXPLOSION,
1484         EFFECT_TE_TEI_PLASMAHIT,
1485         EFFECT_EF_STARDUST,
1486         EFFECT_TR_ROCKET,
1487         EFFECT_TR_GRENADE,
1488         EFFECT_TR_BLOOD,
1489         EFFECT_TR_WIZSPIKE,
1490         EFFECT_TR_SLIGHTBLOOD,
1491         EFFECT_TR_KNIGHTSPIKE,
1492         EFFECT_TR_VORESPIKE,
1493         EFFECT_TR_NEHAHRASMOKE,
1494         EFFECT_TR_NEXUIZPLASMA,
1495         EFFECT_TR_GLOWTRAIL,
1496         EFFECT_SVC_PARTICLE,
1497         EFFECT_TOTAL
1498 }
1499 effectnameindex_t;
1500
1501 int CL_ParticleEffectIndexForName(const char *name);
1502 const char *CL_ParticleEffectNameForIndex(int i);
1503 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);
1504 void CL_ParticleTrail(int effectindex, float pcount, const vec3_t originmins, const vec3_t originmaxs, const vec3_t velocitymins, const vec3_t velocitymaxs, entity_t *ent, int palettecolor, qboolean spawndlight, qboolean spawnparticles, float tintmins[4], float tintmaxs[4]);
1505 void CL_ParseParticleEffect (void);
1506 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);
1507 void CL_ParticleRain (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, int type);
1508 void CL_EntityParticles (const entity_t *ent);
1509 void CL_ParticleExplosion (const vec3_t org);
1510 void CL_ParticleExplosion2 (const vec3_t org, int colorStart, int colorLength);
1511 void R_NewExplosion(const vec3_t org);
1512
1513 void Debug_PolygonBegin(const char *picname, int flags);
1514 void Debug_PolygonVertex(float x, float y, float z, float s, float t, float r, float g, float b, float a);
1515 void Debug_PolygonEnd(void);
1516
1517 #include "cl_screen.h"
1518
1519 extern qboolean sb_showscores;
1520
1521 float RSurf_FogVertex(const vec3_t p);
1522 float RSurf_FogPoint(const vec3_t p);
1523
1524 typedef struct r_refdef_stats_s
1525 {
1526         int renders;
1527         int entities;
1528         int entities_surfaces;
1529         int entities_triangles;
1530         int world_leafs;
1531         int world_portals;
1532         int world_surfaces;
1533         int world_triangles;
1534         int lightmapupdates;
1535         int lightmapupdatepixels;
1536         int particles;
1537         int drawndecals;
1538         int totaldecals;
1539         int meshes;
1540         int meshes_elements;
1541         int lights;
1542         int lights_clears;
1543         int lights_scissored;
1544         int lights_lighttriangles;
1545         int lights_shadowtriangles;
1546         int lights_dynamicshadowtriangles;
1547         int bloom;
1548         int bloom_copypixels;
1549         int bloom_drawpixels;
1550 }
1551 r_refdef_stats_t;
1552
1553 typedef enum r_viewport_type_e
1554 {
1555         R_VIEWPORTTYPE_ORTHO,
1556         R_VIEWPORTTYPE_PERSPECTIVE,
1557         R_VIEWPORTTYPE_PERSPECTIVE_INFINITEFARCLIP,
1558         R_VIEWPORTTYPE_PERSPECTIVECUBESIDE,
1559         R_VIEWPORTTYPE_TOTAL
1560 }
1561 r_viewport_type_t;
1562
1563 typedef struct r_viewport_s
1564 {
1565         matrix4x4_t cameramatrix; // from entity (transforms from camera entity to world)
1566         matrix4x4_t viewmatrix; // actual matrix for rendering (transforms to viewspace)
1567         matrix4x4_t projectmatrix; // actual projection matrix (transforms from viewspace to screen)
1568         int x;
1569         int y;
1570         int z;
1571         int width;
1572         int height;
1573         int depth;
1574         r_viewport_type_t type;
1575         float screentodepth[2]; // used by deferred renderer to calculate linear depth from device depth coordinates
1576 }
1577 r_viewport_t;
1578
1579 typedef struct r_refdef_view_s
1580 {
1581         // view information (changes multiple times per frame)
1582         // if any of these variables change then r_refdef.viewcache must be regenerated
1583         // by calling R_View_Update
1584         // (which also updates viewport, scissor, colormask)
1585
1586         // it is safe and expected to copy this into a structure on the stack and
1587         // call the renderer recursively, then restore from the stack afterward
1588         // (as long as R_View_Update is called)
1589
1590         // eye position information
1591         matrix4x4_t matrix, inverse_matrix;
1592         vec3_t origin;
1593         vec3_t forward;
1594         vec3_t left;
1595         vec3_t right;
1596         vec3_t up;
1597         int numfrustumplanes;
1598         mplane_t frustum[6];
1599         qboolean useclipplane;
1600         qboolean usecustompvs; // uses r_refdef.viewcache.pvsbits as-is rather than computing it
1601         mplane_t clipplane;
1602         float frustum_x, frustum_y;
1603         vec3_t frustumcorner[4];
1604         // if turned off it renders an ortho view
1605         int useperspective;
1606         float ortho_x, ortho_y;
1607
1608         // screen area to render in
1609         int x;
1610         int y;
1611         int z;
1612         int width;
1613         int height;
1614         int depth;
1615         r_viewport_t viewport;
1616
1617         // which color components to allow (for anaglyph glasses)
1618         int colormask[4];
1619
1620         // global RGB color multiplier for rendering, this is required by HDR
1621         float colorscale;
1622
1623         // whether to call R_ClearScreen before rendering stuff
1624         qboolean clear;
1625         // if true, don't clear or do any post process effects (bloom, etc)
1626         qboolean isoverlay;
1627
1628         // whether to draw r_showtris and such, this is only true for the main
1629         // view render, all secondary renders (HDR, mirrors, portals, cameras,
1630         // distortion effects, etc) omit such debugging information
1631         qboolean showdebug;
1632
1633         // these define which values to use in GL_CullFace calls to request frontface or backface culling
1634         int cullface_front;
1635         int cullface_back;
1636
1637         // render quality (0 to 1) - affects r_drawparticles_drawdistance and others
1638         float quality;
1639 }
1640 r_refdef_view_t;
1641
1642 typedef struct r_refdef_viewcache_s
1643 {
1644         // updated by gl_main_newmap()
1645         int maxentities;
1646         int world_numclusters;
1647         int world_numclusterbytes;
1648         int world_numleafs;
1649         int world_numsurfaces;
1650
1651         // these properties are generated by R_View_Update()
1652
1653         // which entities are currently visible for this viewpoint
1654         // (the used range is 0...r_refdef.scene.numentities)
1655         unsigned char *entityvisible;
1656
1657         // flag arrays used for visibility checking on world model
1658         // (all other entities have no per-surface/per-leaf visibility checks)
1659         unsigned char *world_pvsbits;
1660         unsigned char *world_leafvisible;
1661         unsigned char *world_surfacevisible;
1662         // if true, the view is currently in a leaf without pvs data
1663         qboolean world_novis;
1664 }
1665 r_refdef_viewcache_t;
1666
1667 // TODO: really think about which fields should go into scene and which one should stay in refdef [1/7/2008 Black]
1668 // maybe also refactor some of the functions to support different setting sources (ie. fogenabled, etc.) for different scenes
1669 typedef struct r_refdef_scene_s {
1670         // whether to call S_ExtraUpdate during render to reduce sound chop
1671         qboolean extraupdate;
1672
1673         // (client gameworld) time for rendering time based effects
1674         double time;
1675
1676         // the world
1677         entity_render_t *worldentity;
1678
1679         // same as worldentity->model
1680         dp_model_t *worldmodel;
1681
1682         // renderable entities (excluding world)
1683         entity_render_t **entities;
1684         int numentities;
1685         int maxentities;
1686
1687         // field of temporary entities that is reset each (client) frame
1688         entity_render_t *tempentities;
1689         int numtempentities;
1690         int maxtempentities;
1691
1692         // renderable dynamic lights
1693         rtlight_t *lights[MAX_DLIGHTS];
1694         rtlight_t templights[MAX_DLIGHTS];
1695         int numlights;
1696
1697         // intensities for light styles right now, controls rtlights
1698         float rtlightstylevalue[MAX_LIGHTSTYLES];       // float fraction of base light value
1699         // 8.8bit fixed point intensities for light styles
1700         // controls intensity lightmap layers
1701         unsigned short lightstylevalue[MAX_LIGHTSTYLES];        // 8.8 fraction of base light value
1702
1703         float ambient;
1704
1705         qboolean rtworld;
1706         qboolean rtworldshadows;
1707         qboolean rtdlight;
1708         qboolean rtdlightshadows;
1709 } r_refdef_scene_t;
1710
1711 typedef struct r_refdef_s
1712 {
1713         // these fields define the basic rendering information for the world
1714         // but not the view, which could change multiple times in one rendered
1715         // frame (for example when rendering textures for certain effects)
1716
1717         // these are set for water warping before
1718         // frustum_x/frustum_y are calculated
1719         float frustumscale_x, frustumscale_y;
1720
1721         // current view settings (these get reset a few times during rendering because of water rendering, reflections, etc)
1722         r_refdef_view_t view;
1723         r_refdef_viewcache_t viewcache;
1724
1725         // minimum visible distance (pixels closer than this disappear)
1726         double nearclip;
1727         // maximum visible distance (pixels further than this disappear in 16bpp modes,
1728         // in 32bpp an infinite-farclip matrix is used instead)
1729         double farclip;
1730
1731         // fullscreen color blend
1732         float viewblend[4];
1733
1734         r_refdef_scene_t scene;
1735
1736         float fogplane[4];
1737         float fogplaneviewdist;
1738         qboolean fogplaneviewabove;
1739         float fogheightfade;
1740         float fogcolor[3];
1741         float fogrange;
1742         float fograngerecip;
1743         float fogmasktabledistmultiplier;
1744 #define FOGMASKTABLEWIDTH 1024
1745         float fogmasktable[FOGMASKTABLEWIDTH];
1746         float fogmasktable_start, fogmasktable_alpha, fogmasktable_range, fogmasktable_density;
1747         float fog_density;
1748         float fog_red;
1749         float fog_green;
1750         float fog_blue;
1751         float fog_alpha;
1752         float fog_start;
1753         float fog_end;
1754         float fog_height;
1755         float fog_fadedepth;
1756         qboolean fogenabled;
1757         qboolean oldgl_fogenable;
1758
1759         // new flexible texture height fog (overrides normal fog)
1760         char fog_height_texturename[64]; // note: must be 64 for the sscanf code
1761         unsigned char *fog_height_table1d;
1762         unsigned char *fog_height_table2d;
1763         int fog_height_tablesize; // enable
1764         float fog_height_tablescale;
1765         float fog_height_texcoordscale;
1766         char fogheighttexturename[64]; // detects changes to active fog height texture
1767
1768         qboolean draw2dstage;
1769
1770         // true during envmap command capture
1771         qboolean envmap;
1772
1773         // brightness of world lightmaps and related lighting
1774         // (often reduced when world rtlights are enabled)
1775         float lightmapintensity;
1776         // whether to draw world lights realtime, dlights realtime, and their shadows
1777         float polygonfactor;
1778         float polygonoffset;
1779         float shadowpolygonfactor;
1780         float shadowpolygonoffset;
1781
1782         // rendering stats for r_speeds display
1783         // (these are incremented in many places)
1784         r_refdef_stats_t stats;
1785 }
1786 r_refdef_t;
1787
1788 extern r_refdef_t r_refdef;
1789
1790 #endif
1791