2e8349e1c7626e56dc5f08aee8bdb49e146909c7
[divverent/darkplaces.git] / 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 rtlight_s
74 {
75         // shadow volumes are done entirely in model space, so there are no matrices for dealing with them...  they just use the origin 
76
77         // note that the world to light matrices are inversely scaled (divided) by lightradius
78
79         // core properties
80         // matrix for transforming world coordinates to light filter coordinates
81         matrix4x4_t matrix_worldtolight;
82         // based on worldtolight this transforms -1 to +1 to 0 to 1 for purposes
83         // of attenuation texturing in full 3D (Z result often ignored)
84         matrix4x4_t matrix_worldtoattenuationxyz;
85         // this transforms only the Z to S, and T is always 0.5
86         matrix4x4_t matrix_worldtoattenuationz;
87         // typically 1 1 1, can be lower (dim) or higher (overbright)
88         vec3_t color;
89         // size of the light (remove?)
90         vec_t radius;
91         // light filter
92         char cubemapname[64];
93         // whether light should render shadows
94         int shadow;
95         // intensity of corona to render
96         vec_t corona;
97         // light style to monitor for brightness
98         int style;
99         
100         // generated properties
101         // used only for shadow volumes
102         vec3_t shadoworigin;
103         // culling
104         vec3_t cullmins;
105         vec3_t cullmaxs;
106         // culling
107         vec_t cullradius;
108         // squared cullradius
109         vec_t cullradius2;
110
111         // lightmap renderer stuff (remove someday!)
112         // the size of the light
113         vec_t lightmap_cullradius;
114         // the size of the light, squared
115         vec_t lightmap_cullradius2;
116         // the brightness of the light
117         vec3_t lightmap_light;
118         // to avoid sudden brightness change at cullradius, subtract this
119         vec_t lightmap_subtract;
120
121         // static light info
122         // true if this light should be compiled as a static light
123         int isstatic;
124         // true if this is a compiled world light, cleared if the light changes
125         int compiled;
126         // premade shadow volumes and lit surfaces to render for world entity
127         shadowmesh_t *static_meshchain_shadow;
128         shadowmesh_t *static_meshchain_light;
129         // used for visibility testing (more exact than bbox)
130         int static_numclusters;
131         int *static_clusterindices;
132 }
133 rtlight_t;
134
135 typedef struct dlight_s
136 {
137         // destroy light after this time
138         // (dlight only)
139         vec_t die;
140         // the entity that owns this light (can be NULL)
141         // (dlight only)
142         struct entity_render_s *ent;
143         // location
144         // (worldlight: saved to .rtlights file)
145         vec3_t origin;
146         // worldlight orientation
147         // (worldlight only)
148         // (worldlight: saved to .rtlights file)
149         vec3_t angles;
150         // dlight orientation/scaling/location
151         // (dlight only)
152         matrix4x4_t matrix;
153         // color of light
154         // (worldlight: saved to .rtlights file)
155         vec3_t color;
156         // cubemap number to use on this light
157         // (dlight only)
158         int cubemapnum;
159         // cubemap name to use on this light
160         // (worldlight only)
161         // (worldlight: saved to .rtlights file)
162         char cubemapname[64];
163         // make light flash while selected
164         // (worldlight only)
165         int selected;
166         // brightness (not really radius anymore)
167         // (worldlight: saved to .rtlights file)
168         vec_t radius;
169         // drop radius this much each second
170         // (dlight only)
171         vec_t decay;
172         // light style which controls intensity of this light
173         // (worldlight: saved to .rtlights file)
174         int style;
175         // cast shadows
176         // (worldlight: saved to .rtlights file)
177         int shadow;
178         // corona intensity
179         // (worldlight: saved to .rtlights file)
180         vec_t corona;
181         // linked list of world lights
182         // (worldlight only)
183         struct dlight_s *next;
184         // embedded rtlight struct for renderer
185         // (renderer only)      
186         rtlight_t rtlight;
187 }
188 dlight_t;
189
190 typedef struct frameblend_s
191 {
192         int frame;
193         float lerp;
194 }
195 frameblend_t;
196
197 // LordHavoc: this struct is intended for the renderer but some fields are
198 // used by the client.
199 typedef struct entity_render_s
200 {
201         // location
202         vec3_t origin;
203         // orientation
204         vec3_t angles;
205         // transform matrix for model to world
206         matrix4x4_t matrix;
207         // transform matrix for world to model
208         matrix4x4_t inversematrix;
209         // opacity (alpha) of the model
210         float alpha;
211         // size the model is shown
212         float scale;
213
214         // NULL = no model
215         model_t *model;
216         // current uninterpolated animation frame (for things which do not use interpolation)
217         int frame;
218         // entity shirt and pants colors
219         int colormap;
220         // light, particles, etc
221         int effects;
222         // for Alias models
223         int skinnum;
224         // render flags
225         int flags;
226
227         // interpolated animation
228
229         // frame that the model is interpolating from
230         int frame1;
231         // frame that the model is interpolating to
232         int frame2;
233         // interpolation factor, usually computed from frame2time
234         float framelerp;
235         // time frame1 began playing (for framegroup animations)
236         double frame1time;
237         // time frame2 began playing (for framegroup animations)
238         double frame2time;
239
240         // calculated by the renderer (but not persistent)
241
242         // if visframe == r_framecount, it is visible
243         int visframe;
244         // calculated during R_AddModelEntities
245         vec3_t mins, maxs;
246         // 4 frame numbers (-1 if not used) and their blending scalers (0-1), if interpolation is not desired, use frame instead
247         frameblend_t frameblend[4];
248
249         // caching results of static light traces (this is semi-persistent)
250         double entlightstime;
251         vec3_t entlightsorigin;
252         int entlightsframe;
253         int numentlights;
254         unsigned short entlights[MAXENTLIGHTS];
255 }
256 entity_render_t;
257
258 typedef struct entity_persistent_s
259 {
260         int linkframe;
261
262         vec3_t trail_origin;
263
264         // particle trail
265         float trail_time;
266
267         // muzzleflash fading
268         float muzzleflash;
269
270         // interpolated movement
271
272         // start time of move
273         float lerpstarttime;
274         // time difference from start to end of move
275         float lerpdeltatime;
276         // the move itself, start and end
277         float oldorigin[3];
278         float oldangles[3];
279         float neworigin[3];
280         float newangles[3];
281 }
282 entity_persistent_t;
283
284 typedef struct entity_s
285 {
286         // baseline state (default values)
287         entity_state_t state_baseline;
288         // previous state (interpolating from this)
289         entity_state_t state_previous;
290         // current state (interpolating to this)
291         entity_state_t state_current;
292
293         // used for regenerating parts of render
294         entity_persistent_t persistent;
295
296         // the only data the renderer should know about
297         entity_render_t render;
298 }
299 entity_t;
300
301 typedef struct
302 {
303         vec3_t  viewangles;
304
305 // intended velocities
306         float   forwardmove;
307         float   sidemove;
308         float   upmove;
309 } usercmd_t;
310
311 typedef struct
312 {
313         int             length;
314         char    map[MAX_STYLESTRING];
315 } lightstyle_t;
316
317 typedef struct
318 {
319         char    name[MAX_SCOREBOARDNAME];
320         int             frags;
321         int             colors; // two 4 bit fields
322 } scoreboard_t;
323
324 typedef struct
325 {
326         int             destcolor[3];
327         int             percent;                // 0-256
328 } cshift_t;
329
330 #define CSHIFT_CONTENTS 0
331 #define CSHIFT_DAMAGE   1
332 #define CSHIFT_BONUS    2
333 #define CSHIFT_POWERUP  3
334 #define CSHIFT_VCSHIFT  4
335 #define NUM_CSHIFTS             5
336
337 #define NAME_LENGTH     64
338
339
340 //
341 // client_state_t should hold all pieces of the client state
342 //
343
344 #define SIGNONS         4                       // signon messages to receive before connected
345
346 #define MAX_DEMOS               8
347 #define MAX_DEMONAME    16
348
349 typedef enum
350 {
351         ca_dedicated,           // a dedicated server with no ability to start a client
352         ca_disconnected,        // full screen console with no connection
353         ca_connected            // valid netcon, talking to a server
354 }
355 cactive_t;
356
357 //
358 // the client_static_t structure is persistent through an arbitrary number
359 // of server connections
360 //
361 typedef struct
362 {
363         cactive_t state;
364
365 // demo loop control
366         // -1 = don't play demos
367         int demonum;
368         // list of demos in loop
369         char demos[MAX_DEMOS][MAX_DEMONAME];
370
371 // demo recording info must be here, because record is started before
372 // entering a map (and clearing client_state_t)
373         qboolean demorecording;
374         qboolean demoplayback;
375         qboolean timedemo;
376         // -1 = use normal cd track
377         int forcetrack;
378         qfile_t *demofile;
379         // to meter out one message a frame
380         int td_lastframe;
381         // host_framecount at start
382         int td_startframe;
383         // realtime at second frame of timedemo (LordHavoc: changed to double)
384         double td_starttime;
385         // LordHavoc: for measuring maxfps
386         double td_minframetime;
387         // LordHavoc: for measuring minfps
388         double td_maxframetime;
389         // LordHavoc: pausedemo
390         qboolean demopaused;
391
392         qboolean connect_trying;
393         int connect_remainingtries;
394         double connect_nextsendtime;
395         lhnetsocket_t *connect_mysocket;
396         lhnetaddress_t connect_address;
397
398 // connection information
399         // 0 to SIGNONS
400         int signon;
401         // network connection
402         netconn_t *netcon;
403         // writing buffer to send to server
404         sizebuf_t message;
405 }
406 client_static_t;
407
408 extern client_static_t  cls;
409
410 //
411 // the client_state_t structure is wiped completely at every
412 // server signon
413 //
414 typedef struct
415 {
416         // true if playing in a local game and no one else is connected
417         int islocalgame;
418
419         // when connecting to the server throw out the first couple move messages
420         // so the player doesn't accidentally do something the first frame
421         int movemessages;
422
423         // send a clc_nop periodically until connected
424         float sendnoptime;
425
426         // last command sent to the server
427         usercmd_t cmd;
428
429 // information for local display
430         // health, etc
431         int stats[MAX_CL_STATS];
432         // inventory bit flags
433         int items;
434         // cl.time of acquiring item, for blinking
435         float item_gettime[32];
436         // cl.time of changing STAT_ACTIVEWEAPON
437         float weapontime;
438         // use pain anim frame if cl.time < this
439         float faceanimtime;
440
441         // color shifts for damage, powerups
442         cshift_t cshifts[NUM_CSHIFTS];
443         // and content types
444         cshift_t prev_cshifts[NUM_CSHIFTS];
445
446 // the client maintains its own idea of view angles, which are
447 // sent to the server each frame.  The server sets punchangle when
448 // the view is temporarily offset, and an angle reset commands at the start
449 // of each level and after teleporting.
450
451         // during demo playback viewangles is lerped between these
452         vec3_t mviewangles[2];
453         // either client controlled, or lerped from demo mviewangles
454         vec3_t viewangles;
455
456         // update by server, used for lean+bob (0 is newest)
457         vec3_t mvelocity[2];
458         // lerped between mvelocity[0] and [1]
459         vec3_t velocity;
460
461         // temporary offset
462         vec3_t punchangle;
463         // LordHavoc: origin view kick
464         vec3_t punchvector;
465
466 // pitch drifting vars
467         float idealpitch;
468         float pitchvel;
469         qboolean nodrift;
470         float driftmove;
471         double laststop;
472
473         float viewheight;
474         // local amount for smoothing stepups
475         //float crouch;
476
477         // sent by server
478         qboolean paused;
479         qboolean onground;
480         qboolean inwater;
481
482         // don't change view angle, full screen, etc
483         int intermission;
484         // latched at intermission start
485         int completed_time;
486
487         // the timestamp of the last two messages
488         double mtime[2];
489
490         // clients view of time, time should be between mtime[0] and mtime[1] to
491         // generate a lerp point for other data, oldtime is the previous frame's
492         // value of time, frametime is the difference between time and oldtime
493         double time, oldtime, frametime;
494
495         // copy of realtime from last recieved message, for net trouble icon
496         float last_received_message;
497
498 // information that is static for the entire time connected to a server
499         struct model_s *model_precache[MAX_MODELS];
500         struct sfx_s *sound_precache[MAX_SOUNDS];
501
502         // for display on solo scoreboard
503         char levelname[40];
504         // cl_entitites[cl.viewentity] = player
505         int viewentity;
506         // the real player entity (normally same as viewentity,
507         // different than viewentity if mod uses chasecam or other tricks)
508         int playerentity;
509         // max players that can be in this game
510         int maxclients;
511         // type of game (deathmatch, coop, singleplayer)
512         int gametype;
513
514 // refresh related state
515
516         // cl_entitites[0].model
517         struct model_s *worldmodel;
518
519         // the gun model
520         entity_t viewent;
521
522         // cd audio
523         int cdtrack, looptrack;
524
525 // frag scoreboard
526
527         // [cl.maxclients]
528         scoreboard_t *scores;
529
530         // LordHavoc: sniping zoom, QC controlled
531         float viewzoom;
532         // for interpolation
533         float viewzoomold, viewzoomnew;
534
535         // protocol version of the server we're connected to
536         int protocol;
537
538         // entity database stuff
539         entity_database_t entitydatabase;
540         entity_database4_t *entitydatabase4;
541 }
542 client_state_t;
543
544 extern mempool_t *cl_scores_mempool;
545
546 //
547 // cvars
548 //
549 extern cvar_t cl_name;
550 extern cvar_t cl_color;
551 extern cvar_t cl_rate;
552 extern cvar_t cl_pmodel;
553
554 extern cvar_t cl_upspeed;
555 extern cvar_t cl_forwardspeed;
556 extern cvar_t cl_backspeed;
557 extern cvar_t cl_sidespeed;
558
559 extern cvar_t cl_movespeedkey;
560
561 extern cvar_t cl_yawspeed;
562 extern cvar_t cl_pitchspeed;
563
564 extern cvar_t cl_anglespeedkey;
565
566 extern cvar_t cl_autofire;
567
568 extern cvar_t cl_shownet;
569 extern cvar_t cl_nolerp;
570
571 extern cvar_t cl_pitchdriftspeed;
572 extern cvar_t lookspring;
573 extern cvar_t lookstrafe;
574 extern cvar_t sensitivity;
575
576 extern cvar_t freelook;
577
578 extern cvar_t m_pitch;
579 extern cvar_t m_yaw;
580 extern cvar_t m_forward;
581 extern cvar_t m_side;
582
583 extern cvar_t r_draweffects;
584
585 extern cvar_t cl_explosions;
586 extern cvar_t cl_stainmaps;
587
588 // these are updated by CL_ClearState
589 extern int cl_num_entities;
590 extern int cl_num_static_entities;
591 extern int cl_num_temp_entities;
592 extern int cl_num_brushmodel_entities;
593
594 extern entity_t *cl_entities;
595 extern qbyte *cl_entities_active;
596 extern entity_t *cl_static_entities;
597 extern entity_t *cl_temp_entities;
598 extern entity_render_t **cl_brushmodel_entities;
599 extern cl_effect_t *cl_effects;
600 extern beam_t *cl_beams;
601 extern dlight_t *cl_dlights;
602 extern lightstyle_t *cl_lightstyle;
603
604
605 extern client_state_t cl;
606
607 extern void CL_AllocDlight (entity_render_t *ent, matrix4x4_t *matrix, float radius, float red, float green, float blue, float decay, float lifetime, int cubemapnum, int style, int shadowenable, vec_t corona);
608 extern void CL_DecayLights (void);
609
610 //=============================================================================
611
612 //
613 // cl_main
614 //
615
616 void CL_Init (void);
617
618 void CL_EstablishConnection(const char *host);
619
620 void CL_Disconnect (void);
621 void CL_Disconnect_f (void);
622
623 void CL_BoundingBoxForEntity(entity_render_t *ent);
624
625 extern cvar_t cl_beams_polygons;
626 extern cvar_t cl_beams_relative;
627 extern cvar_t cl_beams_lightatend;
628
629 //
630 // cl_input
631 //
632 typedef struct
633 {
634         int             down[2];                // key nums holding it down
635         int             state;                  // low bit is down state
636 }
637 kbutton_t;
638
639 extern  kbutton_t       in_mlook, in_klook;
640 extern  kbutton_t       in_strafe;
641 extern  kbutton_t       in_speed;
642
643 void CL_InitInput (void);
644 void CL_SendCmd (usercmd_t *cmd);
645 void CL_SendMove (usercmd_t *cmd);
646
647 void CL_LerpUpdate(entity_t *e);
648 void CL_ParseTEnt (void);
649 void CL_RelinkBeams (void);
650
651 void CL_ClearTempEntities (void);
652 entity_t *CL_NewTempEntity (void);
653
654 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
655
656 void CL_ClearState (void);
657
658
659 int  CL_ReadFromServer (void);
660 void CL_WriteToServer (usercmd_t *cmd);
661 void CL_BaseMove (usercmd_t *cmd);
662
663
664 float CL_KeyState (kbutton_t *key);
665 const char *Key_KeynumToString (int keynum);
666
667 //
668 // cl_demo.c
669 //
670 void CL_StopPlayback(void);
671 void CL_ReadDemoMessage(void);
672 void CL_WriteDemoMessage(void);
673
674 void CL_NextDemo(void);
675 void CL_Stop_f(void);
676 void CL_Record_f(void);
677 void CL_PlayDemo_f(void);
678 void CL_TimeDemo_f(void);
679
680 //
681 // cl_parse.c
682 //
683 void CL_Parse_Init(void);
684 void CL_ParseServerMessage(void);
685 void CL_Parse_DumpPacket(void);
686
687 //
688 // view
689 //
690 void V_StartPitchDrift (void);
691 void V_StopPitchDrift (void);
692
693 void V_Init (void);
694 float V_CalcRoll (vec3_t angles, vec3_t velocity);
695 void V_UpdateBlends (void);
696 void V_ParseDamage (void);
697
698
699 //
700 // cl_tent
701 //
702 void CL_InitTEnts (void);
703
704 //
705 // cl_part
706 //
707
708 void CL_Particles_Clear(void);
709 void CL_Particles_Init(void);
710
711 void CL_ParseParticleEffect (void);
712 void CL_RunParticleEffect (vec3_t org, vec3_t dir, int color, int count);
713 void CL_RocketTrail (vec3_t start, vec3_t end, int type, entity_t *ent);
714 void CL_RocketTrail2 (vec3_t start, vec3_t end, int color, entity_t *ent);
715 void CL_SparkShower (vec3_t org, vec3_t dir, int count);
716 void CL_PlasmaBurn (vec3_t org);
717 void CL_BloodPuff (vec3_t org, vec3_t vel, int count);
718 void CL_Stardust (vec3_t mins, vec3_t maxs, int count);
719 void CL_FlameCube (vec3_t mins, vec3_t maxs, int count);
720 void CL_Flames (vec3_t org, vec3_t vel, int count);
721 void CL_BloodShower (vec3_t mins, vec3_t maxs, float velspeed, int count);
722 void CL_ParticleCube (vec3_t mins, vec3_t maxs, vec3_t dir, int count, int colorbase, int gravity, int randomvel);
723 void CL_ParticleRain (vec3_t mins, vec3_t maxs, vec3_t dir, int count, int colorbase, int type);
724 void CL_EntityParticles (entity_t *ent);
725 void CL_BlobExplosion (vec3_t org);
726 void CL_ParticleExplosion (vec3_t org);
727 void CL_ParticleExplosion2 (vec3_t org, int colorStart, int colorLength);
728 void CL_LavaSplash (vec3_t org);
729 void CL_TeleportSplash (vec3_t org);
730 void CL_BeamParticle (const vec3_t start, const vec3_t end, vec_t radius, float red, float green, float blue, float alpha, float lifetime);
731 void CL_Tei_Smoke(const vec3_t pos, const vec3_t dir, int count);
732 void CL_Tei_PlasmaHit(const vec3_t pos, const vec3_t dir, int count);
733 void CL_MoveParticles(void);
734 void R_MoveExplosions(void);
735 void R_NewExplosion(vec3_t org);
736
737 #include "cl_screen.h"
738
739 typedef struct
740 {
741         // area to render in
742         int x, y, width, height;
743         float fov_x, fov_y;
744
745         // view transform
746         matrix4x4_t viewentitymatrix;
747
748         // fullscreen color blend
749         float viewblend[4];
750
751         entity_render_t **entities;
752         int numentities;
753         int maxentities;
754
755         qbyte *drawqueue;
756         int drawqueuesize;
757         int maxdrawqueuesize;
758 }
759 refdef_t;
760
761 refdef_t r_refdef;
762
763 extern mempool_t *cl_refdef_mempool;
764
765 #include "cgamevm.h"
766
767 #endif
768