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 // LordHavoc: this affects the lighting scale of the whole game
  30 #define LIGHTOFFSET 1024.0f
  31 // max lights shining on one entity
  32 #define MAXENTLIGHTS 128
  33
  34 extern int cl_max_entities;
  35 extern int cl_max_static_entities;
  36 extern int cl_max_temp_entities;
  37 extern int cl_max_effects;
  38 extern int cl_max_beams;
  39
  40 typedef struct effect_s
  41 {
  42         int active;
  43         vec3_t origin;
  44         float starttime;
  45         float framerate;
  46         int modelindex;
  47         int startframe;
  48         int endframe;
  49         // these are for interpolation
  50         int frame;
  51         double frame1time;
  52         double frame2time;
  53 }
  54 cl_effect_t;
  55
  56 typedef struct
  57 {
  58         int             entity;
  59         // draw this as lightning polygons, or a model?
  60         int             lightning;
  61         struct model_s  *model;
  62         float   endtime;
  63         vec3_t  start, end;
  64         // if this beam is owned by an entity, this is the beam start relative to
  65         // that entity's matrix for per frame start updates
  66         vec3_t  relativestart;
  67         vec3_t  relativeend;
  68         // indicates whether relativestart is valid
  69         int     relativestartvalid;
  70 }
  71 beam_t;
  72
  73 typedef struct
  74 {
  75         // location
  76         vec3_t  origin;
  77         // stop lighting after this time
  78         float   die;
  79         // color of light
  80         vec3_t  color;
  81         // brightness (not really radius anymore)
  82         float   radius;
  83         // drop this each second
  84         float   decay;
  85         // the entity that owns this light (can be NULL)
  86         struct entity_render_s *ent;
  87 }
  88 dlight_t;
  89
  90 typedef struct frameblend_s
  91 {
  92         int frame;
  93         float lerp;
  94 }
  95 frameblend_t;
  96
  97 // LordHavoc: disregard the following warning, entlights stuff is semi-persistent...
  98 // LordHavoc: nothing in this structure is persistent, it may be overwritten by the client every frame, for persistent data use entity_lerp_t.
  99 typedef struct entity_render_s
 100 {
 101         // location
 102         vec3_t origin;
 103         // orientation
 104         vec3_t angles;
 105         // transform matrix for model to world
 106         matrix4x4_t matrix;
 107         // transform matrix for world to model
 108         matrix4x4_t inversematrix;
 109         // opacity (alpha) of the model
 110         float alpha;
 111         // size the model is shown
 112         float scale;
 113
 114         // NULL = no model
 115         model_t *model;
 116         // current uninterpolated animation frame (for things which do not use interpolation)
 117         int frame;
 118         // entity shirt and pants colors
 119         int colormap;
 120         // light, particles, etc
 121         int effects;
 122         // for Alias models
 123         int skinnum;
 124         // render flags
 125         int flags;
 126
 127         // these are copied from the persistent data
 128
 129         // frame that the model is interpolating from
 130         int frame1;
 131         // frame that the model is interpolating to
 132         int frame2;
 133         // interpolation factor, usually computed from frame2time
 134         double framelerp;
 135         // time frame1 began playing (for framegroup animations)
 136         double frame1time;
 137         // time frame2 began playing (for framegroup animations)
 138         double frame2time;
 139
 140         // calculated by the renderer (but not persistent)
 141
 142         // if visframe == r_framecount, it is visible
 143         int visframe;
 144         // calculated during R_AddModelEntities
 145         vec3_t mins, maxs;
 146         // 4 frame numbers (-1 if not used) and their blending scalers (0-1), if interpolation is not desired, use frame instead
 147         frameblend_t frameblend[4];
 148
 149         // caching results of static light traces (this is semi-persistent)
 150         double entlightstime;
 151         vec3_t entlightsorigin;
 152         int entlightsframe;
 153         int numentlights;
 154         unsigned short entlights[MAXENTLIGHTS];
 155 }
 156 entity_render_t;
 157
 158 typedef struct entity_persistent_s
 159 {
 160         // particles
 161
 162         // trail rendering
 163         vec3_t trail_origin;
 164         float trail_time;
 165
 166         // effects
 167
 168         // muzzleflash fading
 169         float muzzleflash;
 170
 171         // interpolated movement
 172
 173         // start time of move
 174         float lerpstarttime;
 175         // time difference from start to end of move
 176         float lerpdeltatime;
 177         // the move itself, start and end
 178         float oldorigin[3];
 179         float oldangles[3];
 180         float neworigin[3];
 181         float newangles[3];
 182
 183         // interpolated animation
 184
 185         // lerp resets when model changes
 186         int modelindex;
 187         // frame that the model is interpolating from
 188         int frame1;
 189         // frame that the model is interpolating to
 190         int frame2;
 191         // interpolation factor, usually computed from frame2time
 192         double framelerp;
 193         // time frame1 began playing (for framegroup animations)
 194         double frame1time;
 195         // time frame2 began playing (for framegroup animations)
 196         double frame2time;
 197 }
 198 entity_persistent_t;
 199
 200 typedef struct entity_s
 201 {
 202         // baseline state (default values)
 203         entity_state_t state_baseline;
 204         // previous state (interpolating from this)
 205         entity_state_t state_previous;
 206         // current state (interpolating to this)
 207         entity_state_t state_current;
 208
 209         // used for regenerating parts of render
 210         entity_persistent_t persistent;
 211
 212         // the only data the renderer should know about
 213         entity_render_t render;
 214 }
 215 entity_t;
 216
 217 typedef struct
 218 {
 219         vec3_t  viewangles;
 220
 221 // intended velocities
 222         float   forwardmove;
 223         float   sidemove;
 224         float   upmove;
 225 } usercmd_t;
 226
 227 typedef struct
 228 {
 229         int             length;
 230         char    map[MAX_STYLESTRING];
 231 } lightstyle_t;
 232
 233 typedef struct
 234 {
 235         char    name[MAX_SCOREBOARDNAME];
 236         float   entertime;
 237         int             frags;
 238         int             colors; // two 4 bit fields
 239 } scoreboard_t;
 240
 241 typedef struct
 242 {
 243         int             destcolor[3];
 244         int             percent;                // 0-256
 245 } cshift_t;
 246
 247 #define CSHIFT_CONTENTS 0
 248 #define CSHIFT_DAMAGE   1
 249 #define CSHIFT_BONUS    2
 250 #define CSHIFT_POWERUP  3
 251 #define NUM_CSHIFTS             4
 252
 253 #define NAME_LENGTH     64
 254
 255
 256 //
 257 // client_state_t should hold all pieces of the client state
 258 //
 259
 260 #define SIGNONS         4                       // signon messages to receive before connected
 261
 262 #define MAX_DEMOS               8
 263 #define MAX_DEMONAME    16
 264
 265 typedef enum
 266 {
 267         ca_dedicated,           // a dedicated server with no ability to start a client
 268         ca_disconnected,        // full screen console with no connection
 269         ca_connected            // valid netcon, talking to a server
 270 }
 271 cactive_t;
 272
 273 //
 274 // the client_static_t structure is persistent through an arbitrary number
 275 // of server connections
 276 //
 277 typedef struct
 278 {
 279         cactive_t state;
 280
 281 // demo loop control
 282         // -1 = don't play demos
 283         int demonum;
 284         // list of demos in loop
 285         char demos[MAX_DEMOS][MAX_DEMONAME];
 286
 287 // demo recording info must be here, because record is started before
 288 // entering a map (and clearing client_state_t)
 289         qboolean demorecording;
 290         qboolean demoplayback;
 291         qboolean timedemo;
 292         // -1 = use normal cd track
 293         int forcetrack;
 294         qfile_t *demofile;
 295         // to meter out one message a frame
 296         int td_lastframe;
 297         // host_framecount at start
 298         int td_startframe;
 299         // realtime at second frame of timedemo (LordHavoc: changed to double)
 300         double td_starttime;
 301         // LordHavoc: pausedemo
 302         qboolean demopaused;
 303
 304
 305 // connection information
 306         // 0 to SIGNONS
 307         int signon;
 308         // network socket
 309         struct qsocket_s *netcon;
 310         // writing buffer to send to server
 311         sizebuf_t message;
 312 }
 313 client_static_t;
 314
 315 extern client_static_t  cls;
 316
 317 //
 318 // the client_state_t structure is wiped completely at every
 319 // server signon
 320 //
 321 typedef struct
 322 {
 323         // when connecting to the server throw out the first couple move messages
 324         // so the player doesn't accidentally do something the first frame
 325         int movemessages;
 326
 327         // send a clc_nop periodically until connected
 328         float sendnoptime;
 329
 330         // last command sent to the server
 331         usercmd_t cmd;
 332
 333 // information for local display
 334         // health, etc
 335         int stats[MAX_CL_STATS];
 336         // inventory bit flags
 337         int items;
 338         // cl.time of acquiring item, for blinking
 339         float item_gettime[32];
 340         // use pain anim frame if cl.time < this
 341         float faceanimtime;
 342
 343         // color shifts for damage, powerups
 344         cshift_t cshifts[NUM_CSHIFTS];
 345         // and content types
 346         cshift_t prev_cshifts[NUM_CSHIFTS];
 347
 348 // the client maintains its own idea of view angles, which are
 349 // sent to the server each frame.  The server sets punchangle when
 350 // the view is temporarily offset, and an angle reset commands at the start
 351 // of each level and after teleporting.
 352
 353         // during demo playback viewangles is lerped between these
 354         vec3_t mviewangles[2];
 355         // either client controlled, or lerped from demo mviewangles
 356         vec3_t viewangles;
 357
 358         // update by server, used for lean+bob (0 is newest)
 359         vec3_t mvelocity[2];
 360         // lerped between mvelocity[0] and [1]
 361         vec3_t velocity;
 362
 363         // temporary offset
 364         vec3_t punchangle;
 365         // LordHavoc: origin view kick
 366         vec3_t punchvector;
 367
 368 // pitch drifting vars
 369         float idealpitch;
 370         float pitchvel;
 371         qboolean nodrift;
 372         float driftmove;
 373         double laststop;
 374
 375         float viewheight;
 376         // local amount for smoothing stepups
 377         //float crouch;
 378
 379         // sent by server
 380         qboolean paused;
 381         qboolean onground;
 382         qboolean inwater;
 383
 384         // don't change view angle, full screen, etc
 385         int intermission;
 386         // latched at intermission start
 387         int completed_time;
 388
 389         // the timestamp of the last two messages
 390         double mtime[2];
 391
 392         // clients view of time, time should be between mtime[0] and mtime[1] to
 393         // generate a lerp point for other data, oldtime is the previous frame's
 394         // value of time, frametime is the difference between time and oldtime
 395         double time, oldtime, frametime;
 396
 397         // copy of realtime from last recieved message, for net trouble icon
 398         float last_received_message;
 399
 400 // information that is static for the entire time connected to a server
 401         struct model_s *model_precache[MAX_MODELS];
 402         struct sfx_s *sound_precache[MAX_SOUNDS];
 403
 404         // for display on solo scoreboard
 405         char levelname[40];
 406         // cl_entitites[cl.viewentity] = player
 407         int viewentity;
 408         // the real player entity (normally same as viewentity,
 409         // different than viewentity if mod uses chasecam or other tricks)
 410         int playerentity;
 411         // max players that can be in this game
 412         int maxclients;
 413         // type of game (deathmatch, coop, singleplayer)
 414         int gametype;
 415
 416 // refresh related state
 417
 418         // cl_entitites[0].model
 419         struct model_s *worldmodel;
 420
 421         // the gun model
 422         entity_t viewent;
 423
 424         // cd audio
 425         int cdtrack, looptrack;
 426
 427 // frag scoreboard
 428
 429         // [cl.maxclients]
 430         scoreboard_t *scores;
 431
 432         // LordHavoc: sniping zoom, QC controlled
 433         float viewzoom;
 434         // for interpolation
 435         float viewzoomold, viewzoomnew;
 436
 437         // entity database stuff
 438         entity_database_t entitydatabase;
 439 }
 440 client_state_t;
 441
 442 extern mempool_t *cl_scores_mempool;
 443
 444 //
 445 // cvars
 446 //
 447 extern cvar_t cl_name;
 448 extern cvar_t cl_color;
 449 extern cvar_t cl_pmodel;
 450
 451 extern cvar_t cl_upspeed;
 452 extern cvar_t cl_forwardspeed;
 453 extern cvar_t cl_backspeed;
 454 extern cvar_t cl_sidespeed;
 455
 456 extern cvar_t cl_movespeedkey;
 457
 458 extern cvar_t cl_yawspeed;
 459 extern cvar_t cl_pitchspeed;
 460
 461 extern cvar_t cl_anglespeedkey;
 462
 463 extern cvar_t cl_autofire;
 464
 465 extern cvar_t cl_shownet;
 466 extern cvar_t cl_nolerp;
 467
 468 extern cvar_t cl_pitchdriftspeed;
 469 extern cvar_t lookspring;
 470 extern cvar_t lookstrafe;
 471 extern cvar_t sensitivity;
 472
 473 extern cvar_t freelook;
 474
 475 extern cvar_t m_pitch;
 476 extern cvar_t m_yaw;
 477 extern cvar_t m_forward;
 478 extern cvar_t m_side;
 479
 480 extern cvar_t r_draweffects;
 481
 482 extern cvar_t cl_explosions;
 483 extern cvar_t cl_stainmaps;
 484
 485 // these are updated by CL_ClearState
 486 extern int cl_num_entities;
 487 extern int cl_num_static_entities;
 488 extern int cl_num_temp_entities;
 489 extern int cl_num_brushmodel_entities;
 490
 491 extern entity_t *cl_entities;
 492 extern qbyte *cl_entities_active;
 493 extern entity_t *cl_static_entities;
 494 extern entity_t *cl_temp_entities;
 495 extern entity_render_t **cl_brushmodel_entities;
 496 extern cl_effect_t *cl_effects;
 497 extern beam_t *cl_beams;
 498 extern dlight_t *cl_dlights;
 499 extern lightstyle_t *cl_lightstyle;
 500
 501
 502 extern client_state_t cl;
 503
 504 extern void CL_AllocDlight (entity_render_t *ent, vec3_t org, float radius, float red, float green, float blue, float decay, float lifetime);
 505 extern void CL_DecayLights (void);
 506
 507 //=============================================================================
 508
 509 //
 510 // cl_main
 511 //
 512
 513 void CL_Init (void);
 514
 515 void CL_EstablishConnection (char *host);
 516
 517 void CL_Disconnect (void);
 518 void CL_Disconnect_f (void);
 519
 520 void CL_BoundingBoxForEntity(entity_render_t *ent);
 521
 522 //
 523 // cl_input
 524 //
 525 typedef struct
 526 {
 527         int             down[2];                // key nums holding it down
 528         int             state;                  // low bit is down state
 529 }
 530 kbutton_t;
 531
 532 extern  kbutton_t       in_mlook, in_klook;
 533 extern  kbutton_t       in_strafe;
 534 extern  kbutton_t       in_speed;
 535
 536 void CL_InitInput (void);
 537 void CL_SendCmd (void);
 538 void CL_SendMove (usercmd_t *cmd);
 539
 540 void CL_LerpUpdate(entity_t *e);
 541 void CL_ParseTEnt (void);
 542 void CL_RelinkBeams (void);
 543
 544 void CL_ClearTempEntities (void);
 545 entity_t *CL_NewTempEntity (void);
 546
 547 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
 548
 549 void CL_ClearState (void);
 550
 551
 552 int  CL_ReadFromServer (void);
 553 void CL_WriteToServer (usercmd_t *cmd);
 554 void CL_BaseMove (usercmd_t *cmd);
 555
 556
 557 float CL_KeyState (kbutton_t *key);
 558 char *Key_KeynumToString (int keynum);
 559
 560 //
 561 // cl_demo.c
 562 //
 563 void CL_StopPlayback (void);
 564 int CL_GetMessage (void);
 565
 566 void CL_NextDemo (void);
 567 void CL_Stop_f (void);
 568 void CL_Record_f (void);
 569 void CL_PlayDemo_f (void);
 570 void CL_TimeDemo_f (void);
 571
 572 //
 573 // cl_parse.c
 574 //
 575 void CL_Parse_Init(void);
 576 void CL_ParseServerMessage(void);
 577 void CL_Parse_DumpPacket(void);
 578
 579 //
 580 // view
 581 //
 582 void V_StartPitchDrift (void);
 583 void V_StopPitchDrift (void);
 584
 585 void V_Init (void);
 586 float V_CalcRoll (vec3_t angles, vec3_t velocity);
 587 void V_UpdateBlends (void);
 588 void V_ParseDamage (void);
 589
 590
 591 //
 592 // cl_tent
 593 //
 594 void CL_InitTEnts (void);
 595
 596 //
 597 // cl_part
 598 //
 599
 600 void CL_Particles_Clear(void);
 601 void CL_Particles_Init(void);
 602
 603 void CL_ParseParticleEffect (void);
 604 void CL_RunParticleEffect (vec3_t org, vec3_t dir, int color, int count);
 605 void CL_RocketTrail (vec3_t start, vec3_t end, int type, entity_t *ent);
 606 void CL_RocketTrail2 (vec3_t start, vec3_t end, int color, entity_t *ent);
 607 void CL_SparkShower (vec3_t org, vec3_t dir, int count);
 608 void CL_PlasmaBurn (vec3_t org);
 609 void CL_BloodPuff (vec3_t org, vec3_t vel, int count);
 610 void CL_Stardust (vec3_t mins, vec3_t maxs, int count);
 611 void CL_FlameCube (vec3_t mins, vec3_t maxs, int count);
 612 void CL_Flames (vec3_t org, vec3_t vel, int count);
 613 void CL_BloodShower (vec3_t mins, vec3_t maxs, float velspeed, int count);
 614 void CL_ParticleCube (vec3_t mins, vec3_t maxs, vec3_t dir, int count, int colorbase, int gravity, int randomvel);
 615 void CL_ParticleRain (vec3_t mins, vec3_t maxs, vec3_t dir, int count, int colorbase, int type);
 616 void CL_EntityParticles (entity_t *ent);
 617 void CL_BlobExplosion (vec3_t org);
 618 void CL_ParticleExplosion (vec3_t org);
 619 void CL_ParticleExplosion2 (vec3_t org, int colorStart, int colorLength);
 620 void CL_LavaSplash (vec3_t org);
 621 void CL_TeleportSplash (vec3_t org);
 622 void CL_BeamParticle (const vec3_t start, const vec3_t end, vec_t radius, float red, float green, float blue, float alpha, float lifetime);
 623 void CL_Tei_Smoke(const vec3_t pos, const vec3_t dir, int count);
 624 void CL_Tei_PlasmaHit(const vec3_t pos, const vec3_t dir, int count);
 625 void CL_MoveParticles(void);
 626 void R_MoveExplosions(void);
 627 void R_NewExplosion(vec3_t org);
 628
 629 #include "cl_screen.h"
 630
 631 typedef struct
 632 {
 633         // area to render in
 634         int x, y, width, height;
 635         float fov_x, fov_y;
 636
 637         // view point
 638         vec3_t vieworg;
 639         vec3_t viewangles;
 640
 641         // fullscreen color blend
 642         float viewblend[4];
 643
 644         entity_render_t **entities;
 645         int numentities;
 646         int maxentities;
 647
 648         qbyte *drawqueue;
 649         int drawqueuesize;
 650         int maxdrawqueuesize;
 651 }
 652 refdef_t;
 653
 654 refdef_t r_refdef;
 655
 656 extern mempool_t *cl_refdef_mempool;
 657
 658 #include "cgamevm.h"
 659
 660 void Host_PerformSpawnServerAndLoadGame(void);
 661
 662 #endif
 663