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 typedef struct effect_s
47 // these are for interpolation
57 // draw this as lightning polygons, or a model?
59 struct model_s *model;
62 // if this beam is owned by an entity, this is the beam start relative to
63 // that entity's matrix for per frame start updates
66 // indicates whether relativestart is valid
67 int relativestartvalid;
71 typedef struct rtlight_s
73 // shadow volumes are done entirely in model space, so there are no matrices for dealing with them... they just use the origin
75 // note that the world to light matrices are inversely scaled (divided) by lightradius
78 // matrix for transforming world coordinates to light filter coordinates
79 matrix4x4_t matrix_worldtolight;
80 // typically 1 1 1, can be lower (dim) or higher (overbright)
82 // size of the light (remove?)
86 // light style to monitor for brightness
88 // whether light should render shadows
90 // intensity of corona to render
92 // radius scale of corona to render (1.0 means same as light radius)
93 vec_t coronasizescale;
94 // ambient intensity to render
96 // diffuse intensity to render
98 // specular intensity to render
103 // generated properties
104 // used only for shadow volumes
111 // squared cullradius
114 // rendering properties, updated each time a light is rendered
115 // this is rtlight->color * d_lightstylevalue
117 // this is R_Shadow_Cubemap(rtlight->cubemapname)
118 rtexture_t *currentcubemap;
120 // lightmap renderer stuff (remove someday!)
121 // the size of the light
122 vec_t lightmap_cullradius;
123 // the size of the light, squared
124 vec_t lightmap_cullradius2;
125 // the brightness of the light
126 vec3_t lightmap_light;
127 // to avoid sudden brightness change at cullradius, subtract this
128 vec_t lightmap_subtract;
131 // true if this light should be compiled as a static light
133 // true if this is a compiled world light, cleared if the light changes
135 // premade shadow volumes to render for world entity
136 shadowmesh_t *static_meshchain_shadow;
137 // used for visibility testing (more exact than bbox)
139 int static_numleafpvsbytes;
140 int *static_leaflist;
141 unsigned char *static_leafpvs;
142 // surfaces seen by light
143 int static_numsurfaces;
144 int *static_surfacelist;
148 typedef struct dlight_s
150 // destroy light after this time
153 // the entity that owns this light (can be NULL)
155 struct entity_render_s *ent;
157 // (worldlight: saved to .rtlights file)
159 // worldlight orientation
161 // (worldlight: saved to .rtlights file)
163 // dlight orientation/scaling/location
167 // (worldlight: saved to .rtlights file)
169 // cubemap number to use on this light
172 // cubemap name to use on this light
174 // (worldlight: saved to .rtlights file)
175 char cubemapname[64];
176 // make light flash while selected
179 // brightness (not really radius anymore)
180 // (worldlight: saved to .rtlights file)
182 // drop radius this much each second
185 // light style which controls intensity of this light
186 // (worldlight: saved to .rtlights file)
189 // (worldlight: saved to .rtlights file)
192 // (worldlight: saved to .rtlights file)
194 // radius scale of corona to render (1.0 means same as light radius)
195 // (worldlight: saved to .rtlights file)
196 vec_t coronasizescale;
197 // ambient intensity to render
198 // (worldlight: saved to .rtlights file)
200 // diffuse intensity to render
201 // (worldlight: saved to .rtlights file)
203 // specular intensity to render
204 // (worldlight: saved to .rtlights file)
207 // (worldlight: saved to .rtlights file)
209 // linked list of world lights
211 struct dlight_s *next;
212 // embedded rtlight struct for renderer
218 typedef struct frameblend_s
225 // LordHavoc: this struct is intended for the renderer but some fields are
226 // used by the client.
227 typedef struct entity_render_s
233 // transform matrix for model to world
235 // transform matrix for world to model
236 matrix4x4_t inversematrix;
237 // opacity (alpha) of the model
239 // size the model is shown
244 // current uninterpolated animation frame (for things which do not use interpolation)
246 // entity shirt and pants colors (-1 if not colormapped)
248 // literal colors for renderer
249 vec3_t colormap_pantscolor;
250 vec3_t colormap_shirtcolor;
251 // light, particles, etc
258 // colormod tinting of models
261 // interpolated animation
263 // frame that the model is interpolating from
265 // frame that the model is interpolating to
267 // interpolation factor, usually computed from frame2time
269 // time frame1 began playing (for framegroup animations)
271 // time frame2 began playing (for framegroup animations)
274 // calculated by the renderer (but not persistent)
276 // if visframe == r_framecount, it is visible
278 // calculated during R_AddModelEntities
280 // 4 frame numbers (-1 if not used) and their blending scalers (0-1), if interpolation is not desired, use frame instead
281 frameblend_t frameblend[4];
283 // caching results of static light traces (this is semi-persistent)
284 double entlightstime;
285 vec3_t entlightsorigin;
288 unsigned short entlights[MAXENTLIGHTS];
292 typedef struct entity_persistent_s
301 // muzzleflash fading
304 // interpolated movement
306 // start time of move
308 // time difference from start to end of move
310 // the move itself, start and end
318 typedef struct entity_s
321 // baseline state (default values)
322 entity_state_t state_baseline;
323 // previous state (interpolating from this)
324 entity_state_t state_previous;
325 // current state (interpolating to this)
326 entity_state_t state_current;
328 // used for regenerating parts of render
329 entity_persistent_t persistent;
331 // the only data the renderer should know about
332 entity_render_t render;
336 typedef struct usercmd_s
340 // intended velocities
345 vec3_t cursor_screen;
348 vec3_t cursor_impact;
349 vec3_t cursor_normal;
350 vec_t cursor_fraction;
351 int cursor_entitynumber;
358 qboolean applied; // if false we're still accumulating a move
361 typedef struct lightstyle_s
364 char map[MAX_STYLESTRING];
367 typedef struct scoreboard_s
369 char name[MAX_SCOREBOARDNAME];
371 int colors; // two 4 bit fields
374 char userinfo[MAX_USERINFO_STRING];
379 // TODO: QW skin support
382 typedef struct cshift_s
385 int percent; // 0-256
388 #define CSHIFT_CONTENTS 0
389 #define CSHIFT_DAMAGE 1
390 #define CSHIFT_BONUS 2
391 #define CSHIFT_POWERUP 3
392 #define CSHIFT_VCSHIFT 4
393 #define NUM_CSHIFTS 5
395 #define NAME_LENGTH 64
399 // client_state_t should hold all pieces of the client state
402 #define SIGNONS 4 // signon messages to receive before connected
405 #define MAX_DEMONAME 16
409 ca_dedicated, // a dedicated server with no ability to start a client
410 ca_disconnected, // full screen console with no connection
411 ca_connected // valid netcon, talking to a server
416 // the client_static_t structure is persistent through an arbitrary number
417 // of server connections
419 typedef struct client_static_s
423 // value of "qport" cvar at time of connection
427 // -1 = don't play demos
429 // list of demos in loop
430 char demos[MAX_DEMOS][MAX_DEMONAME];
431 // the actively playing demo (set by CL_PlayDemo_f)
434 // demo recording info must be here, because record is started before
435 // entering a map (and clearing client_state_t)
436 qboolean demorecording;
437 qboolean demoplayback;
439 // -1 = use normal cd track
442 // to meter out one message a frame
444 // host_framecount at start
446 // realtime at second frame of timedemo (LordHavoc: changed to double)
448 // LordHavoc: for measuring maxfps
449 double td_minframetime;
450 // LordHavoc: for measuring minfps
451 double td_maxframetime;
452 // LordHavoc: pausedemo
455 qboolean connect_trying;
456 int connect_remainingtries;
457 double connect_nextsendtime;
458 lhnetsocket_t *connect_mysocket;
459 lhnetaddress_t connect_address;
460 // protocol version of the server we're connected to
461 // (kept outside client_state_t because it's used between levels)
462 protocolversion_t protocol;
464 // connection information
467 // network connection
470 // quakeworld stuff below
473 // this normally contains the following keys in quakeworld:
474 // password spectator name team skin topcolor bottomcolor rate noaim msg *ver *ip
475 char userinfo[MAX_USERINFO_STRING];
479 extern client_static_t cls;
481 typedef struct client_movementqueue_s
491 client_movementqueue_t;
497 qboolean drawenginesbar;
498 qboolean drawcrosshair;
502 // the client_state_t structure is wiped completely at every
505 typedef struct client_state_s
507 // true if playing in a local game and no one else is connected
510 // when connecting to the server throw out the first couple move messages
511 // so the player doesn't accidentally do something the first frame
514 // send a clc_nop periodically until connected
517 // current input to send to the server
520 // information for local display
522 int stats[MAX_CL_STATS];
523 // last known inventory bit flags, for blinking
525 // cl.time of acquiring item, for blinking
526 float item_gettime[32];
527 // last known STAT_ACTIVEWEAPON
529 // cl.time of changing STAT_ACTIVEWEAPON
531 // use pain anim frame if cl.time < this
534 // color shifts for damage, powerups
535 cshift_t cshifts[NUM_CSHIFTS];
537 cshift_t prev_cshifts[NUM_CSHIFTS];
539 // the client maintains its own idea of view angles, which are
540 // sent to the server each frame. The server sets punchangle when
541 // the view is temporarily offset, and an angle reset commands at the start
542 // of each level and after teleporting.
544 // mviewangles is read from demo
545 // viewangles is either client controlled or lerped from mviewangles
546 vec3_t mviewangles[2], viewangles;
547 // update by server, used by qc to do weapon recoil
548 vec3_t mpunchangle[2], punchangle;
549 // update by server, can be used by mods to kick view around
550 vec3_t mpunchvector[2], punchvector;
551 // update by server, used for lean+bob (0 is newest)
552 vec3_t mvelocity[2], velocity;
553 // update by server, can be used by mods for zooming
554 vec_t mviewzoom[2], viewzoom;
556 // client movement simulation
557 // these fields are only updated by CL_ClientMovement (called by CL_SendMove after parsing each network packet)
559 // this is set true by svc_time parsing and causes a new movement to be
560 // queued for prediction purposes
561 qboolean movement_needupdate;
562 // indicates the queue has been updated and should be replayed
563 qboolean movement_replay;
564 // simulated data (this is valid even if cl.movement is false)
565 vec3_t movement_origin;
566 vec3_t movement_oldorigin;
567 vec3_t movement_velocity;
568 // queue of proposed moves
569 int movement_numqueue;
570 client_movementqueue_t movement_queue[64];
572 int servermovesequence;
574 // pitch drifting vars
581 //[515]: added for csqc purposes
582 float sensitivityscale;
583 csqc_vidvars_t csqc_vidvars; //[515]: these parms must be set to true by default
584 qboolean csqc_wantsmousemove;
585 struct model_s *csqc_model_precache[MAX_MODELS];
587 // local amount for smoothing stepups
596 qboolean oldonground;
597 double lastongroundtime;
598 double hitgroundtime;
600 // don't change view angle, full screen, etc
602 // latched at intermission start
605 // the timestamp of the last two messages
608 // clients view of time, time should be between mtime[0] and mtime[1] to
609 // generate a lerp point for other data, oldtime is the previous frame's
610 // value of time, frametime is the difference between time and oldtime
611 double time, oldtime, frametime;
613 // copy of realtime from last recieved message, for net trouble icon
614 float last_received_message;
616 // information that is static for the entire time connected to a server
617 struct model_s *model_precache[MAX_MODELS];
618 struct sfx_s *sound_precache[MAX_SOUNDS];
620 // for display on solo scoreboard
622 // cl_entitites[cl.viewentity] = player
624 // the real player entity (normally same as viewentity,
625 // different than viewentity if mod uses chasecam or other tricks)
627 // max players that can be in this game
629 // type of game (deathmatch, coop, singleplayer)
632 // models and sounds used by engine code (particularly cl_parse.c)
634 model_t *model_bolt2;
635 model_t *model_bolt3;
638 sfx_t *sfx_knighthit;
645 // refresh related state
647 // cl_entitites[0].model
648 struct model_s *worldmodel;
654 int cdtrack, looptrack;
659 scoreboard_t *scores;
661 // local copy of the server infostring
662 char serverinfo[MAX_SERVERINFO_STRING];
664 // entity database stuff
665 // latest received entity frame numbers
666 #define LATESTFRAMENUMS 3
667 int latestframenums[LATESTFRAMENUMS];
668 entityframe_database_t *entitydatabase;
669 entityframe4_database_t *entitydatabase4;
676 extern cvar_t cl_name;
677 extern cvar_t cl_color;
678 extern cvar_t cl_rate;
679 extern cvar_t cl_pmodel;
680 extern cvar_t cl_playermodel;
681 extern cvar_t cl_playerskin;
683 extern cvar_t rcon_password;
684 extern cvar_t rcon_address;
686 extern cvar_t cl_upspeed;
687 extern cvar_t cl_forwardspeed;
688 extern cvar_t cl_backspeed;
689 extern cvar_t cl_sidespeed;
691 extern cvar_t cl_movespeedkey;
693 extern cvar_t cl_yawspeed;
694 extern cvar_t cl_pitchspeed;
696 extern cvar_t cl_anglespeedkey;
698 extern cvar_t cl_autofire;
700 extern cvar_t csqc_progname; //[515]: csqc crc check and right csprogs name according to progs.dat
701 extern cvar_t csqc_progcrc;
703 extern cvar_t cl_shownet;
704 extern cvar_t cl_nolerp;
706 extern cvar_t cl_pitchdriftspeed;
707 extern cvar_t lookspring;
708 extern cvar_t lookstrafe;
709 extern cvar_t sensitivity;
711 extern cvar_t freelook;
713 extern cvar_t m_pitch;
715 extern cvar_t m_forward;
716 extern cvar_t m_side;
718 extern cvar_t r_draweffects;
720 extern cvar_t cl_explosions_alpha_start;
721 extern cvar_t cl_explosions_alpha_end;
722 extern cvar_t cl_explosions_size_start;
723 extern cvar_t cl_explosions_size_end;
724 extern cvar_t cl_explosions_lifetime;
725 extern cvar_t cl_stainmaps;
726 extern cvar_t cl_stainmaps_clearonload;
728 extern cvar_t cl_prydoncursor;
730 extern vec3_t cl_playerstandmins;
731 extern vec3_t cl_playerstandmaxs;
732 extern vec3_t cl_playercrouchmins;
733 extern vec3_t cl_playercrouchmaxs;
735 extern mempool_t *cl_mempool;
737 extern int cl_max_entities;
738 extern int cl_max_csqcentities;
739 extern int cl_max_static_entities;
740 extern int cl_max_temp_entities;
741 extern int cl_max_effects;
742 extern int cl_max_beams;
743 extern int cl_max_dlights;
744 extern int cl_max_lightstyle;
745 extern int cl_max_brushmodel_entities;
746 extern int cl_activedlights;
748 extern entity_t *cl_entities;
749 extern entity_t *cl_csqcentities; //[515]: csqc
750 extern unsigned char *cl_entities_active;
751 extern unsigned char *cl_csqcentities_active; //[515]: csqc
752 extern entity_t *cl_static_entities;
753 extern entity_t *cl_temp_entities;
754 extern cl_effect_t *cl_effects;
755 extern beam_t *cl_beams;
756 extern dlight_t *cl_dlights;
757 extern lightstyle_t *cl_lightstyle;
758 extern int *cl_brushmodel_entities;
760 // these are updated by CL_ClearState
761 extern int cl_num_entities;
762 extern int cl_num_csqcentities; //[515]: csqc
763 extern int cl_num_static_entities;
764 extern int cl_num_temp_entities;
765 extern int cl_num_brushmodel_entities;
768 extern client_state_t cl;
770 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);
772 //=============================================================================
778 void CL_Shutdown (void);
781 void CL_EstablishConnection(const char *host);
783 void CL_Disconnect (void);
784 void CL_Disconnect_f (void);
786 void CL_BoundingBoxForEntity(entity_render_t *ent);
788 extern cvar_t cl_beams_polygons;
789 extern cvar_t cl_beams_relative;
790 extern cvar_t cl_beams_lightatend;
795 typedef struct kbutton_s
797 int down[2]; // key nums holding it down
798 int state; // low bit is down state
802 extern kbutton_t in_mlook, in_klook;
803 extern kbutton_t in_strafe;
804 extern kbutton_t in_speed;
806 void CL_InitInput (void);
807 void CL_SendMove (void);
809 void CL_ValidateState(entity_state_t *s);
810 void CL_MoveLerpEntityStates(entity_t *ent);
811 void CL_LerpUpdate(entity_t *e);
812 void CL_ParseTEnt (void);
813 void CL_RelinkBeams (void);
815 void CL_ClearTempEntities (void);
816 entity_t *CL_NewTempEntity (void);
818 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
820 void CL_ClearState (void);
821 void CL_ExpandEntities(int num);
824 int CL_ReadFromServer (void);
825 void CL_WriteToServer (void);
827 extern qboolean cl_ignoremousemove;
830 float CL_KeyState (kbutton_t *key);
831 const char *Key_KeynumToString (int keynum);
832 int Key_StringToKeynum (const char *str);
837 void CL_StopPlayback(void);
838 void CL_ReadDemoMessage(void);
839 void CL_WriteDemoMessage(void);
841 void CL_NextDemo(void);
842 void CL_Stop_f(void);
843 void CL_Record_f(void);
844 void CL_PlayDemo_f(void);
845 void CL_TimeDemo_f(void);
850 void CL_Parse_Init(void);
851 void CL_Parse_Shutdown(void);
852 void CL_ParseServerMessage(void);
853 void CL_Parse_DumpPacket(void);
859 void V_StartPitchDrift (void);
860 void V_StopPitchDrift (void);
863 float V_CalcRoll (vec3_t angles, vec3_t velocity);
864 void V_UpdateBlends (void);
865 void V_ParseDamage (void);
871 extern cvar_t cl_particles;
872 extern cvar_t cl_particles_quality;
873 extern cvar_t cl_particles_size;
874 extern cvar_t cl_particles_quake;
875 extern cvar_t cl_particles_bloodshowers;
876 extern cvar_t cl_particles_blood;
877 extern cvar_t cl_particles_blood_alpha;
878 extern cvar_t cl_particles_blood_bloodhack;
879 extern cvar_t cl_particles_bulletimpacts;
880 extern cvar_t cl_particles_explosions_bubbles;
881 extern cvar_t cl_particles_explosions_smoke;
882 extern cvar_t cl_particles_explosions_sparks;
883 extern cvar_t cl_particles_explosions_shell;
884 extern cvar_t cl_particles_smoke;
885 extern cvar_t cl_particles_smoke_alpha;
886 extern cvar_t cl_particles_smoke_alphafade;
887 extern cvar_t cl_particles_sparks;
888 extern cvar_t cl_particles_bubbles;
889 extern cvar_t cl_decals;
890 extern cvar_t cl_decals_time;
891 extern cvar_t cl_decals_fadetime;
893 void CL_Particles_Clear(void);
894 void CL_Particles_Init(void);
895 void CL_Particles_Shutdown(void);
897 void CL_ParseParticleEffect (void);
898 void CL_RunParticleEffect (vec3_t org, vec3_t dir, int color, int count);
899 void CL_RocketTrail (vec3_t start, vec3_t end, int type, int color, entity_t *ent);
900 void CL_SparkShower (vec3_t org, vec3_t dir, int count, vec_t gravityscale);
901 void CL_Smoke (vec3_t org, vec3_t dir, int count);
902 void CL_BulletMark (vec3_t org);
903 void CL_PlasmaBurn (vec3_t org);
904 void CL_BloodPuff (vec3_t org, vec3_t vel, int count);
905 void CL_Stardust (vec3_t mins, vec3_t maxs, int count);
906 void CL_FlameCube (vec3_t mins, vec3_t maxs, int count);
907 void CL_Flames (vec3_t org, vec3_t vel, int count);
908 void CL_BloodShower (vec3_t mins, vec3_t maxs, float velspeed, int count);
909 void CL_ParticleCube (vec3_t mins, vec3_t maxs, vec3_t dir, int count, int colorbase, int gravity, int randomvel);
910 void CL_ParticleRain (vec3_t mins, vec3_t maxs, vec3_t dir, int count, int colorbase, int type);
911 void CL_EntityParticles (entity_t *ent);
912 void CL_BlobExplosion (vec3_t org);
913 void CL_ParticleExplosion (vec3_t org);
914 void CL_ParticleExplosion2 (vec3_t org, int colorStart, int colorLength);
915 void CL_LavaSplash (vec3_t org);
916 void CL_TeleportSplash (vec3_t org);
917 void CL_BeamParticle (const vec3_t start, const vec3_t end, vec_t radius, float red, float green, float blue, float alpha, float lifetime);
918 void CL_Tei_Smoke(const vec3_t pos, const vec3_t dir, int count);
919 void CL_Tei_PlasmaHit(const vec3_t pos, const vec3_t dir, int count);
920 void CL_MoveParticles(void);
921 void R_MoveExplosions(void);
922 void R_NewExplosion(vec3_t org);
924 #include "cl_screen.h"
926 typedef struct refdef_s
929 int x, y, width, height;
930 float frustum_x, frustum_y;
932 // these are set for water warping before
933 // frustum_x/frustum_y are calculated
934 float frustumscale_x, frustumscale_y;
937 matrix4x4_t viewentitymatrix;
939 // which color components to allow (for anaglyph glasses)
942 // fullscreen color blend
945 // whether to call S_ExtraUpdate during render to reduce sound chop
946 qboolean extraupdate;
948 // client gameworld time for rendering time based effects
952 entity_render_t *worldentity;
954 // same as worldentity->model
957 // renderable entities (excluding world)
958 entity_render_t **entities;
962 // renderable dynamic lights
963 dlight_t *lights[MAX_DLIGHTS];
966 // 8.8bit fixed point intensities for light styles
967 // controls intensity of dynamic lights and lightmap layers
968 unsigned short lightstylevalue[256]; // 8.8 fraction of base light value
970 // 2D art drawing queue
971 // TODO: get rid of this
972 unsigned char *drawqueue;
974 int maxdrawqueuesize;
978 extern refdef_t r_refdef;