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: this struct is intended for the renderer but some fields are
  98 // used by the client.
  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         // interpolated animation
 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         float 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         int linkframe;
 161
 162         vec3_t trail_origin;
 163
 164         // particle trail
 165         float trail_time;
 166
 167         // muzzleflash fading
 168         float muzzleflash;
 169
 170         // interpolated movement
 171
 172         // start time of move
 173         float lerpstarttime;
 174         // time difference from start to end of move
 175         float lerpdeltatime;
 176         // the move itself, start and end
 177         float oldorigin[3];
 178         float oldangles[3];
 179         float neworigin[3];
 180         float newangles[3];
 181 }
 182 entity_persistent_t;
 183
 184 typedef struct entity_s
 185 {
 186         // baseline state (default values)
 187         entity_state_t state_baseline;
 188         // previous state (interpolating from this)
 189         entity_state_t state_previous;
 190         // current state (interpolating to this)
 191         entity_state_t state_current;
 192
 193         // used for regenerating parts of render
 194         entity_persistent_t persistent;
 195
 196         // the only data the renderer should know about
 197         entity_render_t render;
 198 }
 199 entity_t;
 200
 201 typedef struct
 202 {
 203         vec3_t  viewangles;
 204
 205 // intended velocities
 206         float   forwardmove;
 207         float   sidemove;
 208         float   upmove;
 209 } usercmd_t;
 210
 211 typedef struct
 212 {
 213         int             length;
 214         char    map[MAX_STYLESTRING];
 215 } lightstyle_t;
 216
 217 typedef struct
 218 {
 219         char    name[MAX_SCOREBOARDNAME];
 220         int             frags;
 221         int             colors; // two 4 bit fields
 222 } scoreboard_t;
 223
 224 typedef struct
 225 {
 226         int             destcolor[3];
 227         int             percent;                // 0-256
 228 } cshift_t;
 229
 230 #define CSHIFT_CONTENTS 0
 231 #define CSHIFT_DAMAGE   1
 232 #define CSHIFT_BONUS    2
 233 #define CSHIFT_POWERUP  3
 234 #define NUM_CSHIFTS             4
 235
 236 #define NAME_LENGTH     64
 237
 238
 239 //
 240 // client_state_t should hold all pieces of the client state
 241 //
 242
 243 #define SIGNONS         4                       // signon messages to receive before connected
 244
 245 #define MAX_DEMOS               8
 246 #define MAX_DEMONAME    16
 247
 248 typedef enum
 249 {
 250         ca_dedicated,           // a dedicated server with no ability to start a client
 251         ca_disconnected,        // full screen console with no connection
 252         ca_connected            // valid netcon, talking to a server
 253 }
 254 cactive_t;
 255
 256 //
 257 // the client_static_t structure is persistent through an arbitrary number
 258 // of server connections
 259 //
 260 typedef struct
 261 {
 262         cactive_t state;
 263
 264 // demo loop control
 265         // -1 = don't play demos
 266         int demonum;
 267         // list of demos in loop
 268         char demos[MAX_DEMOS][MAX_DEMONAME];
 269
 270 // demo recording info must be here, because record is started before
 271 // entering a map (and clearing client_state_t)
 272         qboolean demorecording;
 273         qboolean demoplayback;
 274         qboolean timedemo;
 275         // -1 = use normal cd track
 276         int forcetrack;
 277         qfile_t *demofile;
 278         // to meter out one message a frame
 279         int td_lastframe;
 280         // host_framecount at start
 281         int td_startframe;
 282         // realtime at second frame of timedemo (LordHavoc: changed to double)
 283         double td_starttime;
 284         // LordHavoc: pausedemo
 285         qboolean demopaused;
 286
 287         qboolean connect_trying;
 288         int connect_remainingtries;
 289         double connect_nextsendtime;
 290         lhnetsocket_t *connect_mysocket;
 291         lhnetaddress_t connect_address;
 292
 293 // connection information
 294         // 0 to SIGNONS
 295         int signon;
 296         // network connection
 297         netconn_t *netcon;
 298         // writing buffer to send to server
 299         sizebuf_t message;
 300 }
 301 client_static_t;
 302
 303 extern client_static_t  cls;
 304
 305 //
 306 // the client_state_t structure is wiped completely at every
 307 // server signon
 308 //
 309 typedef struct
 310 {
 311         // true if playing in a local game and no one else is connected
 312         int islocalgame;
 313
 314         // when connecting to the server throw out the first couple move messages
 315         // so the player doesn't accidentally do something the first frame
 316         int movemessages;
 317
 318         // send a clc_nop periodically until connected
 319         float sendnoptime;
 320
 321         // last command sent to the server
 322         usercmd_t cmd;
 323
 324 // information for local display
 325         // health, etc
 326         int stats[MAX_CL_STATS];
 327         // inventory bit flags
 328         int items;
 329         // cl.time of acquiring item, for blinking
 330         float item_gettime[32];
 331         // cl.time of changing STAT_ACTIVEWEAPON
 332         float weapontime;
 333         // use pain anim frame if cl.time < this
 334         float faceanimtime;
 335
 336         // color shifts for damage, powerups
 337         cshift_t cshifts[NUM_CSHIFTS];
 338         // and content types
 339         cshift_t prev_cshifts[NUM_CSHIFTS];
 340
 341 // the client maintains its own idea of view angles, which are
 342 // sent to the server each frame.  The server sets punchangle when
 343 // the view is temporarily offset, and an angle reset commands at the start
 344 // of each level and after teleporting.
 345
 346         // during demo playback viewangles is lerped between these
 347         vec3_t mviewangles[2];
 348         // either client controlled, or lerped from demo mviewangles
 349         vec3_t viewangles;
 350
 351         // update by server, used for lean+bob (0 is newest)
 352         vec3_t mvelocity[2];
 353         // lerped between mvelocity[0] and [1]
 354         vec3_t velocity;
 355
 356         // temporary offset
 357         vec3_t punchangle;
 358         // LordHavoc: origin view kick
 359         vec3_t punchvector;
 360
 361 // pitch drifting vars
 362         float idealpitch;
 363         float pitchvel;
 364         qboolean nodrift;
 365         float driftmove;
 366         double laststop;
 367
 368         float viewheight;
 369         // local amount for smoothing stepups
 370         //float crouch;
 371
 372         // sent by server
 373         qboolean paused;
 374         qboolean onground;
 375         qboolean inwater;
 376
 377         // don't change view angle, full screen, etc
 378         int intermission;
 379         // latched at intermission start
 380         int completed_time;
 381
 382         // the timestamp of the last two messages
 383         double mtime[2];
 384
 385         // clients view of time, time should be between mtime[0] and mtime[1] to
 386         // generate a lerp point for other data, oldtime is the previous frame's
 387         // value of time, frametime is the difference between time and oldtime
 388         double time, oldtime, frametime;
 389
 390         // copy of realtime from last recieved message, for net trouble icon
 391         float last_received_message;
 392
 393 // information that is static for the entire time connected to a server
 394         struct model_s *model_precache[MAX_MODELS];
 395         struct sfx_s *sound_precache[MAX_SOUNDS];
 396
 397         // for display on solo scoreboard
 398         char levelname[40];
 399         // cl_entitites[cl.viewentity] = player
 400         int viewentity;
 401         // the real player entity (normally same as viewentity,
 402         // different than viewentity if mod uses chasecam or other tricks)
 403         int playerentity;
 404         // max players that can be in this game
 405         int maxclients;
 406         // type of game (deathmatch, coop, singleplayer)
 407         int gametype;
 408
 409 // refresh related state
 410
 411         // cl_entitites[0].model
 412         struct model_s *worldmodel;
 413
 414         // the gun model
 415         entity_t viewent;
 416
 417         // cd audio
 418         int cdtrack, looptrack;
 419
 420 // frag scoreboard
 421
 422         // [cl.maxclients]
 423         scoreboard_t *scores;
 424
 425         // LordHavoc: sniping zoom, QC controlled
 426         float viewzoom;
 427         // for interpolation
 428         float viewzoomold, viewzoomnew;
 429
 430         // protocol version of the server we're connected to
 431         int protocol;
 432
 433         // entity database stuff
 434         entity_database_t entitydatabase;
 435         entity_database4_t *entitydatabase4;
 436 }
 437 client_state_t;
 438
 439 extern mempool_t *cl_scores_mempool;
 440
 441 //
 442 // cvars
 443 //
 444 extern cvar_t cl_name;
 445 extern cvar_t cl_color;
 446 extern cvar_t cl_pmodel;
 447
 448 extern cvar_t cl_upspeed;
 449 extern cvar_t cl_forwardspeed;
 450 extern cvar_t cl_backspeed;
 451 extern cvar_t cl_sidespeed;
 452
 453 extern cvar_t cl_movespeedkey;
 454
 455 extern cvar_t cl_yawspeed;
 456 extern cvar_t cl_pitchspeed;
 457
 458 extern cvar_t cl_anglespeedkey;
 459
 460 extern cvar_t cl_autofire;
 461
 462 extern cvar_t cl_shownet;
 463 extern cvar_t cl_nolerp;
 464
 465 extern cvar_t cl_pitchdriftspeed;
 466 extern cvar_t lookspring;
 467 extern cvar_t lookstrafe;
 468 extern cvar_t sensitivity;
 469
 470 extern cvar_t freelook;
 471
 472 extern cvar_t m_pitch;
 473 extern cvar_t m_yaw;
 474 extern cvar_t m_forward;
 475 extern cvar_t m_side;
 476
 477 extern cvar_t r_draweffects;
 478
 479 extern cvar_t cl_explosions;
 480 extern cvar_t cl_stainmaps;
 481
 482 // these are updated by CL_ClearState
 483 extern int cl_num_entities;
 484 extern int cl_num_static_entities;
 485 extern int cl_num_temp_entities;
 486 extern int cl_num_brushmodel_entities;
 487
 488 extern entity_t *cl_entities;
 489 extern qbyte *cl_entities_active;
 490 extern entity_t *cl_static_entities;
 491 extern entity_t *cl_temp_entities;
 492 extern entity_render_t **cl_brushmodel_entities;
 493 extern cl_effect_t *cl_effects;
 494 extern beam_t *cl_beams;
 495 extern dlight_t *cl_dlights;
 496 extern lightstyle_t *cl_lightstyle;
 497
 498
 499 extern client_state_t cl;
 500
 501 extern void CL_AllocDlight (entity_render_t *ent, vec3_t org, float radius, float red, float green, float blue, float decay, float lifetime);
 502 extern void CL_DecayLights (void);
 503
 504 //=============================================================================
 505
 506 //
 507 // cl_main
 508 //
 509
 510 void CL_Init (void);
 511
 512 void CL_EstablishConnection(const char *host);
 513
 514 void CL_Disconnect (void);
 515 void CL_Disconnect_f (void);
 516
 517 void CL_BoundingBoxForEntity(entity_render_t *ent);
 518
 519 extern cvar_t cl_beams_polygons;
 520 extern cvar_t cl_beams_relative;
 521 extern cvar_t cl_beams_lightatend;
 522
 523 //
 524 // cl_input
 525 //
 526 typedef struct
 527 {
 528         int             down[2];                // key nums holding it down
 529         int             state;                  // low bit is down state
 530 }
 531 kbutton_t;
 532
 533 extern  kbutton_t       in_mlook, in_klook;
 534 extern  kbutton_t       in_strafe;
 535 extern  kbutton_t       in_speed;
 536
 537 void CL_InitInput (void);
 538 void CL_SendCmd (void);
 539 void CL_SendMove (usercmd_t *cmd);
 540
 541 void CL_LerpUpdate(entity_t *e);
 542 void CL_ParseTEnt (void);
 543 void CL_RelinkBeams (void);
 544
 545 void CL_ClearTempEntities (void);
 546 entity_t *CL_NewTempEntity (void);
 547
 548 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
 549
 550 void CL_ClearState (void);
 551
 552
 553 int  CL_ReadFromServer (void);
 554 void CL_WriteToServer (usercmd_t *cmd);
 555 void CL_BaseMove (usercmd_t *cmd);
 556
 557
 558 float CL_KeyState (kbutton_t *key);
 559 char *Key_KeynumToString (int keynum);
 560
 561 //
 562 // cl_demo.c
 563 //
 564 void CL_StopPlayback(void);
 565 void CL_ReadDemoMessage(void);
 566 void CL_WriteDemoMessage(void);
 567
 568 void CL_NextDemo(void);
 569 void CL_Stop_f(void);
 570 void CL_Record_f(void);
 571 void CL_PlayDemo_f(void);
 572 void CL_TimeDemo_f(void);
 573
 574 //
 575 // cl_parse.c
 576 //
 577 void CL_Parse_Init(void);
 578 void CL_ParseServerMessage(void);
 579 void CL_Parse_DumpPacket(void);
 580
 581 //
 582 // view
 583 //
 584 void V_StartPitchDrift (void);
 585 void V_StopPitchDrift (void);
 586
 587 void V_Init (void);
 588 float V_CalcRoll (vec3_t angles, vec3_t velocity);
 589 void V_UpdateBlends (void);
 590 void V_ParseDamage (void);
 591
 592
 593 //
 594 // cl_tent
 595 //
 596 void CL_InitTEnts (void);
 597
 598 //
 599 // cl_part
 600 //
 601
 602 void CL_Particles_Clear(void);
 603 void CL_Particles_Init(void);
 604
 605 void CL_ParseParticleEffect (void);
 606 void CL_RunParticleEffect (vec3_t org, vec3_t dir, int color, int count);
 607 void CL_RocketTrail (vec3_t start, vec3_t end, int type, entity_t *ent);
 608 void CL_RocketTrail2 (vec3_t start, vec3_t end, int color, entity_t *ent);
 609 void CL_SparkShower (vec3_t org, vec3_t dir, int count);
 610 void CL_PlasmaBurn (vec3_t org);
 611 void CL_BloodPuff (vec3_t org, vec3_t vel, int count);
 612 void CL_Stardust (vec3_t mins, vec3_t maxs, int count);
 613 void CL_FlameCube (vec3_t mins, vec3_t maxs, int count);
 614 void CL_Flames (vec3_t org, vec3_t vel, int count);
 615 void CL_BloodShower (vec3_t mins, vec3_t maxs, float velspeed, int count);
 616 void CL_ParticleCube (vec3_t mins, vec3_t maxs, vec3_t dir, int count, int colorbase, int gravity, int randomvel);
 617 void CL_ParticleRain (vec3_t mins, vec3_t maxs, vec3_t dir, int count, int colorbase, int type);
 618 void CL_EntityParticles (entity_t *ent);
 619 void CL_BlobExplosion (vec3_t org);
 620 void CL_ParticleExplosion (vec3_t org);
 621 void CL_ParticleExplosion2 (vec3_t org, int colorStart, int colorLength);
 622 void CL_LavaSplash (vec3_t org);
 623 void CL_TeleportSplash (vec3_t org);
 624 void CL_BeamParticle (const vec3_t start, const vec3_t end, vec_t radius, float red, float green, float blue, float alpha, float lifetime);
 625 void CL_Tei_Smoke(const vec3_t pos, const vec3_t dir, int count);
 626 void CL_Tei_PlasmaHit(const vec3_t pos, const vec3_t dir, int count);
 627 void CL_MoveParticles(void);
 628 void R_MoveExplosions(void);
 629 void R_NewExplosion(vec3_t org);
 630
 631 #include "cl_screen.h"
 632
 633 typedef struct
 634 {
 635         // area to render in
 636         int x, y, width, height;
 637         float fov_x, fov_y;
 638
 639         // view point
 640         vec3_t vieworg;
 641         vec3_t viewangles;
 642
 643         // fullscreen color blend
 644         float viewblend[4];
 645
 646         entity_render_t **entities;
 647         int numentities;
 648         int maxentities;
 649
 650         qbyte *drawqueue;
 651         int drawqueuesize;
 652         int maxdrawqueuesize;
 653 }
 654 refdef_t;
 655
 656 refdef_t r_refdef;
 657
 658 extern mempool_t *cl_refdef_mempool;
 659
 660 #include "cgamevm.h"
 661
 662 void Host_PerformSpawnServerAndLoadGame(void);
 663
 664 #endif
 665