2 Copyright (C) 1996-1997 Id Software, Inc.
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.
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.
13 See the GNU General Public License for more details.
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.
25 #include "matrixlib.h"
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
34 // flags for rtlight rendering
35 #define LIGHTFLAG_NORMALMODE 1
36 #define LIGHTFLAG_REALTIMEMODE 2
38 extern int cl_max_entities;
39 extern int cl_max_static_entities;
40 extern int cl_max_temp_entities;
41 extern int cl_max_effects;
42 extern int cl_max_beams;
44 typedef struct effect_s
53 // these are for interpolation
63 // draw this as lightning polygons, or a model?
65 struct model_s *model;
68 // if this beam is owned by an entity, this is the beam start relative to
69 // that entity's matrix for per frame start updates
72 // indicates whether relativestart is valid
73 int relativestartvalid;
77 typedef struct rtlight_s
79 // shadow volumes are done entirely in model space, so there are no matrices for dealing with them... they just use the origin
81 // note that the world to light matrices are inversely scaled (divided) by lightradius
84 // matrix for transforming world coordinates to light filter coordinates
85 matrix4x4_t matrix_worldtolight;
86 // typically 1 1 1, can be lower (dim) or higher (overbright)
88 // size of the light (remove?)
92 // light style to monitor for brightness
94 // whether light should render shadows
96 // intensity of corona to render
98 // radius scale of corona to render (1.0 means same as light radius)
99 vec_t coronasizescale;
100 // ambient intensity to render
102 // diffuse intensity to render
104 // specular intensity to render
109 // generated properties
110 // used only for shadow volumes
117 // squared cullradius
120 // rendering properties, updated each time a light is rendered
121 // this is rtlight->color * d_lightstylevalue
123 // this is R_Shadow_Cubemap(rtlight->cubemapname)
124 rtexture_t *currentcubemap;
126 // lightmap renderer stuff (remove someday!)
127 // the size of the light
128 vec_t lightmap_cullradius;
129 // the size of the light, squared
130 vec_t lightmap_cullradius2;
131 // the brightness of the light
132 vec3_t lightmap_light;
133 // to avoid sudden brightness change at cullradius, subtract this
134 vec_t lightmap_subtract;
137 // true if this light should be compiled as a static light
139 // true if this is a compiled world light, cleared if the light changes
141 // premade shadow volumes to render for world entity
142 shadowmesh_t *static_meshchain_shadow;
143 // used for visibility testing (more exact than bbox)
145 int static_numleafpvsbytes;
146 int *static_leaflist;
147 unsigned char *static_leafpvs;
148 // surfaces seen by light
149 int static_numsurfaces;
150 int *static_surfacelist;
154 typedef struct dlight_s
156 // destroy light after this time
159 // the entity that owns this light (can be NULL)
161 struct entity_render_s *ent;
163 // (worldlight: saved to .rtlights file)
165 // worldlight orientation
167 // (worldlight: saved to .rtlights file)
169 // dlight orientation/scaling/location
173 // (worldlight: saved to .rtlights file)
175 // cubemap number to use on this light
178 // cubemap name to use on this light
180 // (worldlight: saved to .rtlights file)
181 char cubemapname[64];
182 // make light flash while selected
185 // brightness (not really radius anymore)
186 // (worldlight: saved to .rtlights file)
188 // drop radius this much each second
191 // light style which controls intensity of this light
192 // (worldlight: saved to .rtlights file)
195 // (worldlight: saved to .rtlights file)
198 // (worldlight: saved to .rtlights file)
200 // radius scale of corona to render (1.0 means same as light radius)
201 // (worldlight: saved to .rtlights file)
202 vec_t coronasizescale;
203 // ambient intensity to render
204 // (worldlight: saved to .rtlights file)
206 // diffuse intensity to render
207 // (worldlight: saved to .rtlights file)
209 // specular intensity to render
210 // (worldlight: saved to .rtlights file)
213 // (worldlight: saved to .rtlights file)
215 // linked list of world lights
217 struct dlight_s *next;
218 // embedded rtlight struct for renderer
224 typedef struct frameblend_s
231 // LordHavoc: this struct is intended for the renderer but some fields are
232 // used by the client.
233 typedef struct entity_render_s
239 // transform matrix for model to world
241 // transform matrix for world to model
242 matrix4x4_t inversematrix;
243 // opacity (alpha) of the model
245 // size the model is shown
250 // current uninterpolated animation frame (for things which do not use interpolation)
252 // entity shirt and pants colors (-1 if not colormapped)
254 // literal colors for renderer
255 vec3_t colormap_pantscolor;
256 vec3_t colormap_shirtcolor;
257 // light, particles, etc
264 // colormod tinting of models
267 // interpolated animation
269 // frame that the model is interpolating from
271 // frame that the model is interpolating to
273 // interpolation factor, usually computed from frame2time
275 // time frame1 began playing (for framegroup animations)
277 // time frame2 began playing (for framegroup animations)
280 // calculated by the renderer (but not persistent)
282 // if visframe == r_framecount, it is visible
284 // calculated during R_AddModelEntities
286 // 4 frame numbers (-1 if not used) and their blending scalers (0-1), if interpolation is not desired, use frame instead
287 frameblend_t frameblend[4];
289 // caching results of static light traces (this is semi-persistent)
290 double entlightstime;
291 vec3_t entlightsorigin;
294 unsigned short entlights[MAXENTLIGHTS];
298 typedef struct entity_persistent_s
307 // muzzleflash fading
310 // interpolated movement
312 // start time of move
314 // time difference from start to end of move
316 // the move itself, start and end
324 typedef struct entity_s
327 // baseline state (default values)
328 entity_state_t state_baseline;
329 // previous state (interpolating from this)
330 entity_state_t state_previous;
331 // current state (interpolating to this)
332 entity_state_t state_current;
334 // used for regenerating parts of render
335 entity_persistent_t persistent;
337 // the only data the renderer should know about
338 entity_render_t render;
342 typedef struct usercmd_s
346 // intended velocities
351 vec3_t cursor_screen;
354 vec3_t cursor_impact;
355 vec3_t cursor_normal;
356 vec_t cursor_fraction;
357 int cursor_entitynumber;
366 typedef struct lightstyle_s
369 char map[MAX_STYLESTRING];
372 typedef struct scoreboard_s
374 char name[MAX_SCOREBOARDNAME];
376 int colors; // two 4 bit fields
379 typedef struct cshift_s
382 int percent; // 0-256
385 #define CSHIFT_CONTENTS 0
386 #define CSHIFT_DAMAGE 1
387 #define CSHIFT_BONUS 2
388 #define CSHIFT_POWERUP 3
389 #define CSHIFT_VCSHIFT 4
390 #define NUM_CSHIFTS 5
392 #define NAME_LENGTH 64
396 // client_state_t should hold all pieces of the client state
399 #define SIGNONS 4 // signon messages to receive before connected
402 #define MAX_DEMONAME 16
406 ca_dedicated, // a dedicated server with no ability to start a client
407 ca_disconnected, // full screen console with no connection
408 ca_connected // valid netcon, talking to a server
413 // the client_static_t structure is persistent through an arbitrary number
414 // of server connections
416 typedef struct client_static_s
421 // -1 = don't play demos
423 // list of demos in loop
424 char demos[MAX_DEMOS][MAX_DEMONAME];
425 // the actively playing demo (set by CL_PlayDemo_f)
428 // demo recording info must be here, because record is started before
429 // entering a map (and clearing client_state_t)
430 qboolean demorecording;
431 qboolean demoplayback;
433 // -1 = use normal cd track
436 // to meter out one message a frame
438 // host_framecount at start
440 // realtime at second frame of timedemo (LordHavoc: changed to double)
442 // LordHavoc: for measuring maxfps
443 double td_minframetime;
444 // LordHavoc: for measuring minfps
445 double td_maxframetime;
446 // LordHavoc: pausedemo
449 qboolean connect_trying;
450 int connect_remainingtries;
451 double connect_nextsendtime;
452 lhnetsocket_t *connect_mysocket;
453 lhnetaddress_t connect_address;
455 // connection information
458 // network connection
460 // writing buffer to send to server
462 unsigned char message_buf[1024];
466 extern client_static_t cls;
468 typedef struct client_movementqueue_s
478 client_movementqueue_t;
484 qboolean drawenginesbar;
485 qboolean drawcrosshair;
489 // the client_state_t structure is wiped completely at every
492 typedef struct client_state_s
494 // true if playing in a local game and no one else is connected
497 // when connecting to the server throw out the first couple move messages
498 // so the player doesn't accidentally do something the first frame
501 // send a clc_nop periodically until connected
504 // current input to send to the server
507 // information for local display
509 int stats[MAX_CL_STATS];
510 // last known inventory bit flags, for blinking
512 // cl.time of acquiring item, for blinking
513 float item_gettime[32];
514 // last known STAT_ACTIVEWEAPON
516 // cl.time of changing STAT_ACTIVEWEAPON
518 // use pain anim frame if cl.time < this
521 // color shifts for damage, powerups
522 cshift_t cshifts[NUM_CSHIFTS];
524 cshift_t prev_cshifts[NUM_CSHIFTS];
526 // the client maintains its own idea of view angles, which are
527 // sent to the server each frame. The server sets punchangle when
528 // the view is temporarily offset, and an angle reset commands at the start
529 // of each level and after teleporting.
531 // mviewangles is read from demo
532 // viewangles is either client controlled or lerped from mviewangles
533 vec3_t mviewangles[2], viewangles;
534 // update by server, used by qc to do weapon recoil
535 vec3_t mpunchangle[2], punchangle;
536 // update by server, can be used by mods to kick view around
537 vec3_t mpunchvector[2], punchvector;
538 // update by server, used for lean+bob (0 is newest)
539 vec3_t mvelocity[2], velocity;
540 // update by server, can be used by mods for zooming
541 vec_t mviewzoom[2], viewzoom;
543 // client movement simulation
544 // these fields are only updated by CL_ClientMovement (called by CL_SendMove after parsing each network packet)
546 // indicates the queue has been updated and should be replayed
547 qboolean movement_replay;
548 // simulated data (this is valid even if cl.movement is false)
549 vec3_t movement_origin;
550 vec3_t movement_oldorigin;
551 vec3_t movement_velocity;
552 // queue of proposed moves
553 int movement_numqueue;
554 client_movementqueue_t movement_queue[64];
556 int servermovesequence;
558 // pitch drifting vars
565 //[515]: added for csqc purposes
566 float sensitivityscale;
567 csqc_vidvars_t csqc_vidvars; //[515]: these parms must be set to true by default
568 qboolean csqc_wantsmousemove;
569 struct model_s *csqc_model_precache[MAX_MODELS];
571 // local amount for smoothing stepups
580 qboolean oldonground;
581 double lastongroundtime;
582 double hitgroundtime;
584 // don't change view angle, full screen, etc
586 // latched at intermission start
589 // the timestamp of the last two messages
592 // clients view of time, time should be between mtime[0] and mtime[1] to
593 // generate a lerp point for other data, oldtime is the previous frame's
594 // value of time, frametime is the difference between time and oldtime
595 double time, oldtime, frametime;
597 // copy of realtime from last recieved message, for net trouble icon
598 float last_received_message;
600 // information that is static for the entire time connected to a server
601 struct model_s *model_precache[MAX_MODELS];
602 struct sfx_s *sound_precache[MAX_SOUNDS];
604 // for display on solo scoreboard
606 // cl_entitites[cl.viewentity] = player
608 // the real player entity (normally same as viewentity,
609 // different than viewentity if mod uses chasecam or other tricks)
611 // max players that can be in this game
613 // type of game (deathmatch, coop, singleplayer)
616 // models and sounds used by engine code (particularly cl_parse.c)
618 model_t *model_bolt2;
619 model_t *model_bolt3;
622 sfx_t *sfx_knighthit;
629 // refresh related state
631 // cl_entitites[0].model
632 struct model_s *worldmodel;
638 int cdtrack, looptrack;
643 scoreboard_t *scores;
645 // protocol version of the server we're connected to
646 protocolversion_t protocol;
648 // entity database stuff
649 // latest received entity frame numbers
650 #define LATESTFRAMENUMS 3
651 int latestframenums[LATESTFRAMENUMS];
652 entityframe_database_t *entitydatabase;
653 entityframe4_database_t *entitydatabase4;
660 extern cvar_t cl_name;
661 extern cvar_t cl_color;
662 extern cvar_t cl_rate;
663 extern cvar_t cl_pmodel;
664 extern cvar_t cl_playermodel;
665 extern cvar_t cl_playerskin;
667 extern cvar_t cl_upspeed;
668 extern cvar_t cl_forwardspeed;
669 extern cvar_t cl_backspeed;
670 extern cvar_t cl_sidespeed;
672 extern cvar_t cl_movespeedkey;
674 extern cvar_t cl_yawspeed;
675 extern cvar_t cl_pitchspeed;
677 extern cvar_t cl_anglespeedkey;
679 extern cvar_t cl_autofire;
681 extern cvar_t csqc_progname; //[515]: csqc crc check and right csprogs name according to progs.dat
682 extern cvar_t csqc_progcrc;
684 extern cvar_t cl_shownet;
685 extern cvar_t cl_nolerp;
687 extern cvar_t cl_pitchdriftspeed;
688 extern cvar_t lookspring;
689 extern cvar_t lookstrafe;
690 extern cvar_t sensitivity;
692 extern cvar_t freelook;
694 extern cvar_t m_pitch;
696 extern cvar_t m_forward;
697 extern cvar_t m_side;
699 extern cvar_t r_draweffects;
701 extern cvar_t cl_explosions_alpha_start;
702 extern cvar_t cl_explosions_alpha_end;
703 extern cvar_t cl_explosions_size_start;
704 extern cvar_t cl_explosions_size_end;
705 extern cvar_t cl_explosions_lifetime;
706 extern cvar_t cl_stainmaps;
707 extern cvar_t cl_stainmaps_clearonload;
709 extern cvar_t cl_prydoncursor;
711 extern vec3_t cl_playerstandmins;
712 extern vec3_t cl_playerstandmaxs;
713 extern vec3_t cl_playercrouchmins;
714 extern vec3_t cl_playercrouchmaxs;
716 // these are updated by CL_ClearState
717 extern int cl_num_entities;
718 extern int cl_num_csqcentities;
719 extern int cl_num_static_entities;
720 extern int cl_num_temp_entities;
721 extern int cl_num_brushmodel_entities;
723 extern mempool_t *cl_mempool;
724 extern entity_t *cl_entities;
725 extern entity_t *cl_csqcentities;
726 extern unsigned char *cl_entities_active;
727 extern unsigned char *cl_csqcentities_active;
728 extern entity_t *cl_static_entities;
729 extern entity_t *cl_temp_entities;
730 extern int *cl_brushmodel_entities;
731 extern cl_effect_t *cl_effects;
732 extern beam_t *cl_beams;
733 extern dlight_t *cl_dlights;
734 extern lightstyle_t *cl_lightstyle;
737 extern client_state_t cl;
739 extern void CL_AllocDlight (entity_render_t *ent, matrix4x4_t *matrix, float radius, float red, float green, float blue, float decay, float lifetime, int cubemapnum, int style, int shadowenable, vec_t corona, vec_t coronasizescale, vec_t ambientscale, vec_t diffusescale, vec_t specularscale, int flags);
741 //=============================================================================
747 void CL_Shutdown (void);
750 void CL_EstablishConnection(const char *host);
752 void CL_Disconnect (void);
753 void CL_Disconnect_f (void);
755 void CL_BoundingBoxForEntity(entity_render_t *ent);
757 extern cvar_t cl_beams_polygons;
758 extern cvar_t cl_beams_relative;
759 extern cvar_t cl_beams_lightatend;
764 typedef struct kbutton_s
766 int down[2]; // key nums holding it down
767 int state; // low bit is down state
771 extern kbutton_t in_mlook, in_klook;
772 extern kbutton_t in_strafe;
773 extern kbutton_t in_speed;
775 void CL_InitInput (void);
776 void CL_SendCmd (void);
777 void CL_SendMove (void);
779 void CL_ValidateState(entity_state_t *s);
780 void CL_MoveLerpEntityStates(entity_t *ent);
781 void CL_LerpUpdate(entity_t *e);
782 void CL_ParseTEnt (void);
783 void CL_RelinkBeams (void);
785 void CL_ClearTempEntities (void);
786 entity_t *CL_NewTempEntity (void);
788 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
790 void CL_ClearState (void);
791 void CL_ExpandEntities(int num);
794 int CL_ReadFromServer (void);
795 void CL_WriteToServer (void);
797 extern qboolean cl_ignoremousemove;
800 float CL_KeyState (kbutton_t *key);
801 const char *Key_KeynumToString (int keynum);
802 int Key_StringToKeynum (const char *str);
807 void CL_StopPlayback(void);
808 void CL_ReadDemoMessage(void);
809 void CL_WriteDemoMessage(void);
811 void CL_NextDemo(void);
812 void CL_Stop_f(void);
813 void CL_Record_f(void);
814 void CL_PlayDemo_f(void);
815 void CL_TimeDemo_f(void);
820 void CL_Parse_Init(void);
821 void CL_Parse_Shutdown(void);
822 void CL_ParseServerMessage(void);
823 void CL_Parse_DumpPacket(void);
828 void V_StartPitchDrift (void);
829 void V_StopPitchDrift (void);
832 float V_CalcRoll (vec3_t angles, vec3_t velocity);
833 void V_UpdateBlends (void);
834 void V_ParseDamage (void);
840 extern cvar_t cl_particles;
841 extern cvar_t cl_particles_quality;
842 extern cvar_t cl_particles_size;
843 extern cvar_t cl_particles_quake;
844 extern cvar_t cl_particles_bloodshowers;
845 extern cvar_t cl_particles_blood;
846 extern cvar_t cl_particles_blood_alpha;
847 extern cvar_t cl_particles_blood_bloodhack;
848 extern cvar_t cl_particles_bulletimpacts;
849 extern cvar_t cl_particles_explosions_bubbles;
850 extern cvar_t cl_particles_explosions_smoke;
851 extern cvar_t cl_particles_explosions_sparks;
852 extern cvar_t cl_particles_explosions_shell;
853 extern cvar_t cl_particles_smoke;
854 extern cvar_t cl_particles_smoke_alpha;
855 extern cvar_t cl_particles_smoke_alphafade;
856 extern cvar_t cl_particles_sparks;
857 extern cvar_t cl_particles_bubbles;
858 extern cvar_t cl_decals;
859 extern cvar_t cl_decals_time;
860 extern cvar_t cl_decals_fadetime;
862 void CL_Particles_Clear(void);
863 void CL_Particles_Init(void);
864 void CL_Particles_Shutdown(void);
866 void CL_ParseParticleEffect (void);
867 void CL_RunParticleEffect (vec3_t org, vec3_t dir, int color, int count);
868 void CL_RocketTrail (vec3_t start, vec3_t end, int type, int color, entity_t *ent);
869 void CL_SparkShower (vec3_t org, vec3_t dir, int count, vec_t gravityscale);
870 void CL_Smoke (vec3_t org, vec3_t dir, int count);
871 void CL_BulletMark (vec3_t org);
872 void CL_PlasmaBurn (vec3_t org);
873 void CL_BloodPuff (vec3_t org, vec3_t vel, int count);
874 void CL_Stardust (vec3_t mins, vec3_t maxs, int count);
875 void CL_FlameCube (vec3_t mins, vec3_t maxs, int count);
876 void CL_Flames (vec3_t org, vec3_t vel, int count);
877 void CL_BloodShower (vec3_t mins, vec3_t maxs, float velspeed, int count);
878 void CL_ParticleCube (vec3_t mins, vec3_t maxs, vec3_t dir, int count, int colorbase, int gravity, int randomvel);
879 void CL_ParticleRain (vec3_t mins, vec3_t maxs, vec3_t dir, int count, int colorbase, int type);
880 void CL_EntityParticles (entity_t *ent);
881 void CL_BlobExplosion (vec3_t org);
882 void CL_ParticleExplosion (vec3_t org);
883 void CL_ParticleExplosion2 (vec3_t org, int colorStart, int colorLength);
884 void CL_LavaSplash (vec3_t org);
885 void CL_TeleportSplash (vec3_t org);
886 void CL_BeamParticle (const vec3_t start, const vec3_t end, vec_t radius, float red, float green, float blue, float alpha, float lifetime);
887 void CL_Tei_Smoke(const vec3_t pos, const vec3_t dir, int count);
888 void CL_Tei_PlasmaHit(const vec3_t pos, const vec3_t dir, int count);
889 void CL_MoveParticles(void);
890 void R_MoveExplosions(void);
891 void R_NewExplosion(vec3_t org);
893 #include "cl_screen.h"
895 typedef struct refdef_s
898 int x, y, width, height;
899 float frustum_x, frustum_y;
901 // these are set for water warping before
902 // frustum_x/frustum_y are calculated
903 float frustumscale_x, frustumscale_y;
906 matrix4x4_t viewentitymatrix;
908 // which color components to allow (for anaglyph glasses)
911 // fullscreen color blend
914 // whether to call S_ExtraUpdate during render to reduce sound chop
915 qboolean extraupdate;
917 // client gameworld time for rendering time based effects
921 entity_render_t *worldentity;
923 // same as worldentity->model
926 // renderable entities (excluding world)
927 entity_render_t **entities;
931 // renderable dynamic lights
932 dlight_t *lights[MAX_DLIGHTS];
935 // 8.8bit fixed point intensities for light styles
936 // controls intensity of dynamic lights and lightmap layers
937 unsigned short lightstylevalue[256]; // 8.8 fraction of base light value
939 // 2D art drawing queue
940 // TODO: get rid of this
941 unsigned char *drawqueue;
943 int maxdrawqueuesize;
947 extern refdef_t r_refdef;