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"
28 // LordHavoc: 256 dynamic lights
29 #define MAX_DLIGHTS 256
31 // this is the maximum number of input packets that can be predicted
32 #define CL_MAX_USERCMDS 256
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;
65 typedef struct rtlight_s
67 // shadow volumes are done entirely in model space, so there are no matrices for dealing with them... they just use the origin
69 // note that the world to light matrices are inversely scaled (divided) by lightradius
72 // matrix for transforming light filter coordinates to world coordinates
73 matrix4x4_t matrix_lighttoworld;
74 // matrix for transforming world coordinates to light filter coordinates
75 matrix4x4_t matrix_worldtolight;
76 // typically 1 1 1, can be lower (dim) or higher (overbright)
78 // size of the light (remove?)
82 // light style to monitor for brightness
84 // whether light should render shadows
86 // intensity of corona to render
88 // radius scale of corona to render (1.0 means same as light radius)
89 vec_t coronasizescale;
90 // ambient intensity to render
92 // diffuse intensity to render
94 // specular intensity to render
99 // generated properties
100 // used only for shadow volumes
107 // squared cullradius
110 // rendering properties, updated each time a light is rendered
111 // this is rtlight->color * d_lightstylevalue
113 // used by corona updates, due to occlusion query
114 float corona_visibility;
115 unsigned int corona_queryindex_visiblepixels;
116 unsigned int corona_queryindex_allpixels;
117 // this is R_Shadow_Cubemap(rtlight->cubemapname)
118 rtexture_t *currentcubemap;
121 // true if this light should be compiled as a static light
123 // true if this is a compiled world light, cleared if the light changes
125 // premade shadow volumes to render for world entity
126 shadowmesh_t *static_meshchain_shadow_zpass;
127 shadowmesh_t *static_meshchain_shadow_zfail;
128 // used for visibility testing (more exact than bbox)
130 int static_numleafpvsbytes;
131 int *static_leaflist;
132 unsigned char *static_leafpvs;
133 // surfaces seen by light
134 int static_numsurfaces;
135 int *static_surfacelist;
136 // flag bits indicating which triangles of the world model should cast
137 // shadows, and which ones should be lit
139 // this avoids redundantly scanning the triangles in each surface twice
140 // for whether they should cast shadows, once in culling and once in the
141 // actual shadowmarklist production.
142 int static_numshadowtrispvsbytes;
143 unsigned char *static_shadowtrispvs;
144 // this allows the lighting batch code to skip backfaces andother culled
145 // triangles not relevant for lighting
146 // (important on big surfaces such as terrain)
147 int static_numlighttrispvsbytes;
148 unsigned char *static_lighttrispvs;
152 typedef struct dlight_s
154 // destroy light after this time
157 // the entity that owns this light (can be NULL)
159 struct entity_render_s *ent;
161 // (worldlight: saved to .rtlights file)
163 // worldlight orientation
165 // (worldlight: saved to .rtlights file)
167 // dlight orientation/scaling/location
171 // (worldlight: saved to .rtlights file)
173 // 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 intensity this much each second
185 // intensity value which is dropped over time
188 // initial values for intensity to modify
192 // light style which controls intensity of this light
193 // (worldlight: saved to .rtlights file)
196 // (worldlight: saved to .rtlights file)
199 // (worldlight: saved to .rtlights file)
201 // radius scale of corona to render (1.0 means same as light radius)
202 // (worldlight: saved to .rtlights file)
203 vec_t coronasizescale;
204 // ambient intensity to render
205 // (worldlight: saved to .rtlights file)
207 // diffuse intensity to render
208 // (worldlight: saved to .rtlights file)
210 // specular intensity to render
211 // (worldlight: saved to .rtlights file)
214 // (worldlight: saved to .rtlights file)
216 // linked list of world lights
218 struct dlight_s *next;
219 // embedded rtlight struct for renderer
225 typedef struct frameblend_s
232 // LordHavoc: this struct is intended for the renderer but some fields are
233 // used by the client.
235 // The renderer should not rely on any changes to this struct to be persistent
236 // across multiple frames because temp entities are wiped every frame, but it
237 // is acceptable to cache things in this struct that are not critical.
239 // For example the r_cullentities_trace code does such caching.
240 typedef struct entity_render_s
246 // transform matrix for model to world
248 // transform matrix for world to model
249 matrix4x4_t inversematrix;
250 // opacity (alpha) of the model
252 // size the model is shown
257 // number of the entity represents, or 0 for non-network entities
259 // literal colormap colors for renderer, if both are 0 0 0 it is not colormapped
260 vec3_t colormap_pantscolor;
261 vec3_t colormap_shirtcolor;
262 // light, particles, etc
264 // qw CTF flags and other internal-use-only effect bits
271 // colormod tinting of models
274 // interpolated animation
276 // frame that the model is interpolating from
278 // frame that the model is interpolating to
280 // interpolation factor, usually computed from frame2time
282 // time frame1 began playing (for framegroup animations)
284 // time frame2 began playing (for framegroup animations)
286 // time of last model change (for shader animations)
289 // calculated by the renderer (but not persistent)
291 // calculated during R_AddModelEntities
293 // 4 frame numbers (-1 if not used) and their blending scalers (0-1), if interpolation is not desired, use frame instead
294 frameblend_t frameblend[4];
296 // current lighting from map (updated ONLY by client code, not renderer)
297 vec3_t modellight_ambient;
298 vec3_t modellight_diffuse; // q3bsp
299 vec3_t modellight_lightdir; // q3bsp
301 // FIELDS UPDATED BY RENDERER:
302 // last time visible during trace culling
303 double last_trace_visibility;
307 typedef struct entity_persistent_s
313 qboolean trail_allowed; // set to false by teleports, true by update code, prevents bad lerps
315 // muzzleflash fading
318 // interpolated movement
320 // start time of move
322 // time difference from start to end of move
324 // the move itself, start and end
332 typedef struct entity_s
334 // baseline state (default values)
335 entity_state_t state_baseline;
336 // previous state (interpolating from this)
337 entity_state_t state_previous;
338 // current state (interpolating to this)
339 entity_state_t state_current;
341 // used for regenerating parts of render
342 entity_persistent_t persistent;
344 // the only data the renderer should know about
345 entity_render_t render;
349 typedef struct usercmd_s
353 // intended velocities
358 vec3_t cursor_screen;
361 vec3_t cursor_impact;
362 vec3_t cursor_normal;
363 vec_t cursor_fraction;
364 int cursor_entitynumber;
366 double time; // time the move is executed for (cl_movement: clienttime, non-cl_movement: receivetime)
367 double receivetime; // time the move was received at
368 double clienttime; // time to which server state the move corresponds to
369 int msec; // for predicted moves
373 qboolean applied; // if false we're still accumulating a move
374 qboolean predicted; // if true the sequence should be sent as 0
376 // derived properties
383 typedef struct lightstyle_s
386 char map[MAX_STYLESTRING];
389 typedef struct scoreboard_s
391 char name[MAX_SCOREBOARDNAME];
393 int colors; // two 4 bit fields
396 char qw_userinfo[MAX_USERINFO_STRING];
402 char qw_skin[MAX_QPATH];
405 typedef struct cshift_s
408 float percent; // 0-255
409 float alphafade; // (any speed)
412 #define CSHIFT_CONTENTS 0
413 #define CSHIFT_DAMAGE 1
414 #define CSHIFT_BONUS 2
415 #define CSHIFT_POWERUP 3
416 #define CSHIFT_VCSHIFT 4
417 #define NUM_CSHIFTS 5
419 #define NAME_LENGTH 64
423 // client_state_t should hold all pieces of the client state
426 #define SIGNONS 4 // signon messages to receive before connected
429 #define MAX_DEMONAME 16
431 typedef enum cactive_e
433 ca_uninitialized, // during early startup
434 ca_dedicated, // a dedicated server with no ability to start a client
435 ca_disconnected, // full screen console with no connection
436 ca_connected // valid netcon, talking to a server
440 typedef enum qw_downloadtype_e
450 typedef enum capturevideoformat_e
452 CAPTUREVIDEOFORMAT_AVI_I420,
453 CAPTUREVIDEOFORMAT_OGG_VORBIS_THEORA,
455 capturevideoformat_t;
457 typedef struct capturevideostate_s
459 double startrealtime;
465 capturevideoformat_t format;
472 int soundsampleframe;
473 unsigned char *screenbuffer;
474 unsigned char *outbuffer;
477 short rgbtoyuvscaletable[3][3][256];
478 unsigned char yuvnormalizetable[3][256];
480 // format specific functions
482 void (*videoframes) (int num);
483 void (*soundframe) (const portable_sampleframe_t *paintbuffer, size_t length);
485 // format specific data
486 void *formatspecific;
490 #define CL_MAX_DOWNLOADACKS 4
492 typedef struct cl_downloadack_s
498 typedef struct cl_soundstats_s
502 int latency_milliseconds;
507 // the client_static_t structure is persistent through an arbitrary number
508 // of server connections
510 typedef struct client_static_s
514 // all client memory allocations go in these pools
515 mempool_t *levelmempool;
516 mempool_t *permanentmempool;
519 // -1 = don't play demos
521 // list of demos in loop
522 char demos[MAX_DEMOS][MAX_DEMONAME];
523 // the actively playing demo (set by CL_PlayDemo_f)
524 char demoname[MAX_QPATH];
526 // demo recording info must be here, because record is started before
527 // entering a map (and clearing client_state_t)
528 qboolean demorecording;
529 fs_offset_t demo_lastcsprogssize;
530 int demo_lastcsprogscrc;
531 qboolean demoplayback;
533 // -1 = use normal cd track
536 // realtime at second frame of timedemo (LordHavoc: changed to double)
538 int td_frames; // total frames parsed
539 double td_onesecondnexttime;
540 double td_onesecondframes;
541 double td_onesecondrealtime;
542 double td_onesecondminfps;
543 double td_onesecondmaxfps;
544 double td_onesecondavgfps;
545 int td_onesecondavgcount;
546 // LordHavoc: pausedemo
549 // sound mixer statistics for showsound display
550 cl_soundstats_t soundstats;
552 qboolean connect_trying;
553 int connect_remainingtries;
554 double connect_nextsendtime;
555 lhnetsocket_t *connect_mysocket;
556 lhnetaddress_t connect_address;
557 // protocol version of the server we're connected to
558 // (kept outside client_state_t because it's used between levels)
559 protocolversion_t protocol;
561 // connection information
564 // network connection
567 // download information
568 // (note: qw_download variables are also used)
569 cl_downloadack_t dp_downloadack[CL_MAX_DOWNLOADACKS];
571 // input sequence numbers are not reset on level change, only connect
573 int servermovesequence;
575 // quakeworld stuff below
577 // value of "qport" cvar at time of connection
579 // copied from cls.netcon->qw. variables every time they change, or set by demos (which have no cls.netcon)
580 int qw_incoming_sequence;
581 int qw_outgoing_sequence;
583 // current file download buffer (only saved when file is completed)
584 char qw_downloadname[MAX_QPATH];
585 unsigned char *qw_downloadmemory;
586 int qw_downloadmemorycursize;
587 int qw_downloadmemorymaxsize;
588 int qw_downloadnumber;
589 int qw_downloadpercent;
590 qw_downloadtype_t qw_downloadtype;
591 // transfer rate display
592 double qw_downloadspeedtime;
593 int qw_downloadspeedcount;
594 int qw_downloadspeedrate;
595 qboolean qw_download_deflate;
597 // current file upload buffer (for uploading screenshots to server)
598 unsigned char *qw_uploaddata;
603 // this normally contains the following keys in quakeworld:
604 // password spectator name team skin topcolor bottomcolor rate noaim msg *ver *ip
605 char userinfo[MAX_USERINFO_STRING];
607 // video capture stuff
608 capturevideostate_t capturevideo;
612 extern client_static_t cls;
614 typedef struct client_movementqueue_s
625 client_movementqueue_t;
631 qboolean drawenginesbar;
632 qboolean drawcrosshair;
637 PARTICLE_BILLBOARD = 0,
639 PARTICLE_ORIENTED_DOUBLESIDED = 2,
641 PARTICLE_INVALID = -1
654 typedef struct particletype_s
657 porientation_t orientation;
664 pt_dead, pt_alphastatic, pt_static, pt_spark, pt_beam, pt_rain, pt_raindecal, pt_snow, pt_bubble, pt_blood, pt_smoke, pt_decal, pt_entityparticle, pt_total
668 typedef struct decal_s
670 // fields used by rendering: (40 bytes)
671 unsigned short typeindex;
672 unsigned short texnum;
676 float alpha; // 0-255
677 unsigned char color[3];
678 unsigned char unused1;
680 // fields not used by rendering: (36 bytes in 32bit, 40 bytes in 64bit)
681 float time2; // used for decal fade
682 unsigned int owner; // decal stuck to this entity
683 dp_model_t *ownermodel; // model the decal is stuck to (used to make sure the entity is still alive)
684 vec3_t relativeorigin; // decal at this location in entity's coordinate space
685 vec3_t relativenormal; // decal oriented this way relative to entity's coordinate space
689 typedef struct particle_s
691 // fields used by rendering: (40 bytes)
692 unsigned char typeindex;
694 porientation_t orientation;
695 unsigned char texnum;
697 vec3_t vel; // velocity of particle, or orientation of decal, or end point of beam
699 float alpha; // 0-255
700 unsigned char color[3];
701 unsigned char qualityreduction; // enables skipping of this particle according to r_refdef.view.qualityreduction
702 float stretch; // only for sparks
704 // fields not used by rendering: (40 bytes)
705 float sizeincrease; // rate of size change per second
706 float alphafade; // how much alpha reduces per second
707 float time2; // used for snow fluttering and decal fade
708 float bounce; // how much bounce-back from a surface the particle hits (0 = no physics, 1 = stop and slide, 2 = keep bouncing forever, 1.5 is typical)
709 float gravity; // how much gravity affects this particle (1.0 = normal gravity, 0.0 = none)
710 float airfriction; // how much air friction affects this object (objects with a low mass/size ratio tend to get more air friction)
711 float liquidfriction; // how much liquid friction affects this object (objects with a low mass/size ratio tend to get more liquid friction)
712 float delayedcollisions; // time that p->bounce becomes active
713 float delayedspawn; // time that particle appears and begins moving
714 float die; // time when this particle should be removed, regardless of alpha
718 typedef enum cl_parsingtextmode_e
720 CL_PARSETEXTMODE_NONE,
721 CL_PARSETEXTMODE_PING,
722 CL_PARSETEXTMODE_STATUS,
723 CL_PARSETEXTMODE_STATUS_PLAYERID,
724 CL_PARSETEXTMODE_STATUS_PLAYERIP
726 cl_parsingtextmode_t;
728 typedef struct cl_locnode_s
730 struct cl_locnode_s *next;
736 typedef struct showlmp_s
747 // the client_state_t structure is wiped completely at every
750 typedef struct client_state_s
752 // true if playing in a local game and no one else is connected
755 // send a clc_nop periodically until connected
758 // current input being accumulated by mouse/joystick/etc input
760 // latest moves sent to the server that have not been confirmed yet
761 usercmd_t movecmd[CL_MAX_USERCMDS];
763 // information for local display
765 int stats[MAX_CL_STATS];
766 float *statsf; // points to stats[] array
767 // last known inventory bit flags, for blinking
769 // cl.time of acquiring item, for blinking
770 float item_gettime[32];
771 // last known STAT_ACTIVEWEAPON
773 // cl.time of changing STAT_ACTIVEWEAPON
775 // use pain anim frame if cl.time < this
777 // for stair smoothing
779 double stairsmoothtime;
781 // color shifts for damage, powerups
782 cshift_t cshifts[NUM_CSHIFTS];
784 cshift_t prev_cshifts[NUM_CSHIFTS];
786 // the client maintains its own idea of view angles, which are
787 // sent to the server each frame. The server sets punchangle when
788 // the view is temporarily offset, and an angle reset commands at the start
789 // of each level and after teleporting.
791 // mviewangles is read from demo
792 // viewangles is either client controlled or lerped from mviewangles
793 vec3_t mviewangles[2], viewangles;
794 // update by server, used by qc to do weapon recoil
795 vec3_t mpunchangle[2], punchangle;
796 // update by server, can be used by mods to kick view around
797 vec3_t mpunchvector[2], punchvector;
798 // update by server, used for lean+bob (0 is newest)
799 vec3_t mvelocity[2], velocity;
800 // update by server, can be used by mods for zooming
801 vec_t mviewzoom[2], viewzoom;
802 // if true interpolation the mviewangles and other interpolation of the
803 // player is disabled until the next network packet
804 // this is used primarily by teleporters, and when spectating players
805 // special checking of the old fixangle[1] is used to differentiate
806 // between teleporting and spectating
807 qboolean fixangle[2];
809 // client movement simulation
810 // these fields are only updated by CL_ClientMovement (called by CL_SendMove after parsing each network packet)
811 // set by CL_ClientMovement_Replay functions
812 qboolean movement_predicted;
813 // if true the CL_ClientMovement_Replay function will update origin, etc
814 qboolean movement_replay;
815 // simulated data (this is valid even if cl.movement is false)
816 vec3_t movement_origin;
817 vec3_t movement_velocity;
818 // whether the replay should allow a jump at the first sequence
819 qboolean movement_replay_canjump;
821 // pitch drifting vars
828 //[515]: added for csqc purposes
829 float sensitivityscale;
830 csqc_vidvars_t csqc_vidvars; //[515]: these parms must be set to true by default
831 qboolean csqc_wantsmousemove;
832 struct model_s *csqc_model_precache[MAX_MODELS];
834 // local amount for smoothing stepups
843 qboolean oldonground;
844 double lastongroundtime;
845 double hitgroundtime;
847 // don't change view angle, full screen, etc
849 // latched at intermission start
850 double completed_time;
852 // the timestamp of the last two messages
855 // clients view of time, time should be between mtime[0] and mtime[1] to
856 // generate a lerp point for other data, oldtime is the previous frame's
857 // value of time, frametime is the difference between time and oldtime
858 // note: cl.time may be beyond cl.mtime[0] if packet loss is occuring, it
859 // is only forcefully limited when a packet is received
860 double time, oldtime;
861 // how long it has been since the previous client frame in real time
862 // (not game time, for that use cl.time - cl.oldtime)
863 double realframetime;
865 // copy of realtime from last recieved message, for net trouble icon
866 float last_received_message;
868 // information that is static for the entire time connected to a server
869 struct model_s *model_precache[MAX_MODELS];
870 struct sfx_s *sound_precache[MAX_SOUNDS];
872 // FIXME: this is a lot of memory to be keeping around, this really should be dynamically allocated and freed somehow
873 char model_name[MAX_MODELS][MAX_QPATH];
874 char sound_name[MAX_SOUNDS][MAX_QPATH];
876 // for display on solo scoreboard
878 // cl_entitites[cl.viewentity] = player
880 // the real player entity (normally same as viewentity,
881 // different than viewentity if mod uses chasecam or other tricks)
882 int realplayerentity;
883 // this is updated to match cl.viewentity whenever it is in the clients
884 // range, basically this is used in preference to cl.realplayerentity for
885 // most purposes because when spectating another player it should show
886 // their information rather than yours
888 // max players that can be in this game
890 // type of game (deathmatch, coop, singleplayer)
893 // models and sounds used by engine code (particularly cl_parse.c)
894 dp_model_t *model_bolt;
895 dp_model_t *model_bolt2;
896 dp_model_t *model_bolt3;
897 dp_model_t *model_beam;
899 sfx_t *sfx_knighthit;
905 // indicates that the file "sound/misc/talk2.wav" was found (for use by team chat messages)
906 qboolean foundtalk2wav;
908 // refresh related state
910 // cl_entitites[0].model
911 struct model_s *worldmodel;
917 int cdtrack, looptrack;
922 scoreboard_t *scores;
924 // keep track of svc_print parsing state (analyzes ping reports and status reports)
925 cl_parsingtextmode_t parsingtextmode;
926 int parsingtextplayerindex;
927 // set by scoreboard code when sending ping command, this causes the next ping results to be hidden
928 // (which could eat the wrong ping report if the player issues one
929 // manually, but they would still see a ping report, just a later one
930 // caused by the scoreboard code rather than the one they intentionally
932 int parsingtextexpectingpingforscores;
934 // entity database stuff
935 // latest received entity frame numbers
936 #define LATESTFRAMENUMS 3
937 int latestframenums[LATESTFRAMENUMS];
938 entityframe_database_t *entitydatabase;
939 entityframe4_database_t *entitydatabase4;
940 entityframeqw_database_t *entitydatabaseqw;
942 // keep track of quake entities because they need to be killed if they get stale
944 unsigned char isquakeentity[MAX_EDICTS];
946 // bounding boxes for clientside movement
947 vec3_t playerstandmins;
948 vec3_t playerstandmaxs;
949 vec3_t playercrouchmins;
950 vec3_t playercrouchmaxs;
953 int max_static_entities;
958 int max_brushmodel_entities;
964 unsigned char *entities_active;
965 entity_t *static_entities;
966 cl_effect_t *effects;
969 lightstyle_t *lightstyle;
970 int *brushmodel_entities;
971 particle_t *particles;
976 int num_static_entities;
977 int num_brushmodel_entities;
985 double particles_updatetime;
986 double decals_updatetime;
990 // cl_serverextension_download feature
991 int loadmodel_current;
992 int downloadmodel_current;
994 int loadsound_current;
995 int downloadsound_current;
997 qboolean downloadcsqc;
1000 qboolean loadfinished;
1004 // local copy of the server infostring
1005 char qw_serverinfo[MAX_SERVERINFO_STRING];
1007 // time of last qw "pings" command sent to server while showing scores
1008 double last_ping_request;
1010 // used during connect
1013 // updated from serverinfo
1016 // unused: indicates whether the player is spectating
1017 // use cl.scores[cl.playerentity-1].qw_spectator instead
1018 //qboolean qw_spectator;
1020 // last time an input packet was sent
1021 double lastpackettime;
1023 // movement parameters for client prediction
1024 float movevars_wallfriction;
1025 float movevars_waterfriction;
1026 float movevars_friction;
1027 float movevars_timescale;
1028 float movevars_gravity;
1029 float movevars_stopspeed;
1030 float movevars_maxspeed;
1031 float movevars_spectatormaxspeed;
1032 float movevars_accelerate;
1033 float movevars_airaccelerate;
1034 float movevars_wateraccelerate;
1035 float movevars_entgravity;
1036 float movevars_jumpvelocity;
1037 float movevars_edgefriction;
1038 float movevars_maxairspeed;
1039 float movevars_stepheight;
1040 float movevars_airaccel_qw;
1041 float movevars_airaccel_sideways_friction;
1043 // models used by qw protocol
1044 int qw_modelindex_spike;
1045 int qw_modelindex_player;
1046 int qw_modelindex_flag;
1047 int qw_modelindex_s_explod;
1049 vec3_t qw_intermission_origin;
1050 vec3_t qw_intermission_angles;
1052 // 255 is the most nails the QW protocol could send
1054 vec_t qw_nails[255][6];
1056 float qw_weaponkick;
1058 int qw_validsequence;
1060 int qw_deltasequence[QW_UPDATE_BACKUP];
1063 // server entity number corresponding to a clientside entity
1064 unsigned short csqc_server2csqcentitynumber[MAX_EDICTS];
1065 qboolean csqc_loaded;
1068 qboolean csqc_usecsqclistener;
1069 matrix4x4_t csqc_listenermatrix;
1070 char csqc_printtextbuf[MAX_INPUTLINE];
1072 // collision culling data
1075 // loc file stuff (points and boxes describing locations in the level)
1076 cl_locnode_t *locnodes;
1077 // this is updated to cl.movement_origin whenever health is < 1
1078 // used by %d print in say/say_team messages if cl_locs_enable is on
1079 vec3_t lastdeathorigin;
1081 // processing buffer used by R_BuildLightMap, reallocated as needed,
1082 // freed on each level change
1083 size_t buildlightmapmemorysize;
1084 unsigned char *buildlightmapmemory;
1091 extern cvar_t cl_name;
1092 extern cvar_t cl_color;
1093 extern cvar_t cl_rate;
1094 extern cvar_t cl_pmodel;
1095 extern cvar_t cl_playermodel;
1096 extern cvar_t cl_playerskin;
1098 extern cvar_t rcon_password;
1099 extern cvar_t rcon_address;
1101 extern cvar_t cl_upspeed;
1102 extern cvar_t cl_forwardspeed;
1103 extern cvar_t cl_backspeed;
1104 extern cvar_t cl_sidespeed;
1106 extern cvar_t cl_movespeedkey;
1108 extern cvar_t cl_yawspeed;
1109 extern cvar_t cl_pitchspeed;
1111 extern cvar_t cl_anglespeedkey;
1113 extern cvar_t cl_autofire;
1115 extern cvar_t cl_shownet;
1116 extern cvar_t cl_nolerp;
1117 extern cvar_t cl_nettimesyncfactor;
1118 extern cvar_t cl_nettimesyncboundmode;
1119 extern cvar_t cl_nettimesyncboundtolerance;
1121 extern cvar_t cl_pitchdriftspeed;
1122 extern cvar_t lookspring;
1123 extern cvar_t lookstrafe;
1124 extern cvar_t sensitivity;
1126 extern cvar_t freelook;
1128 extern cvar_t m_pitch;
1129 extern cvar_t m_yaw;
1130 extern cvar_t m_forward;
1131 extern cvar_t m_side;
1133 extern cvar_t cl_autodemo;
1134 extern cvar_t cl_autodemo_nameformat;
1136 extern cvar_t r_draweffects;
1138 extern cvar_t cl_explosions_alpha_start;
1139 extern cvar_t cl_explosions_alpha_end;
1140 extern cvar_t cl_explosions_size_start;
1141 extern cvar_t cl_explosions_size_end;
1142 extern cvar_t cl_explosions_lifetime;
1143 extern cvar_t cl_stainmaps;
1144 extern cvar_t cl_stainmaps_clearonload;
1146 extern cvar_t cl_prydoncursor;
1148 extern cvar_t cl_locs_enable;
1150 extern client_state_t cl;
1152 extern void CL_AllocLightFlash (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);
1154 cl_locnode_t *CL_Locs_FindNearest(const vec3_t point);
1155 void CL_Locs_FindLocationName(char *buffer, size_t buffersize, vec3_t point);
1157 //=============================================================================
1163 void CL_Shutdown (void);
1164 void CL_Init (void);
1166 void CL_EstablishConnection(const char *host);
1168 void CL_Disconnect (void);
1169 void CL_Disconnect_f (void);
1171 void CL_UpdateRenderEntity(entity_render_t *ent);
1172 void CL_SetEntityColormapColors(entity_render_t *ent, int colormap);
1173 void CL_UpdateViewEntities(void);
1178 typedef struct kbutton_s
1180 int down[2]; // key nums holding it down
1181 int state; // low bit is down state
1185 extern kbutton_t in_mlook, in_klook;
1186 extern kbutton_t in_strafe;
1187 extern kbutton_t in_speed;
1189 void CL_InitInput (void);
1190 void CL_SendMove (void);
1192 void CL_ValidateState(entity_state_t *s);
1193 void CL_MoveLerpEntityStates(entity_t *ent);
1194 void CL_LerpUpdate(entity_t *e);
1195 void CL_ParseTEnt (void);
1196 void CL_NewBeam (int ent, vec3_t start, vec3_t end, dp_model_t *m, int lightning);
1197 void CL_RelinkBeams (void);
1198 void CL_Beam_CalculatePositions (const beam_t *b, vec3_t start, vec3_t end);
1199 void CL_ClientMovement_Replay(void);
1201 void CL_ClearTempEntities (void);
1202 entity_render_t *CL_NewTempEntity (double shadertime);
1204 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
1206 void CL_ClearState (void);
1207 void CL_ExpandEntities(int num);
1208 void CL_SetInfo(const char *key, const char *value, qboolean send, qboolean allowstarkey, qboolean allowmodel, qboolean quiet);
1211 void CL_UpdateWorld (void);
1212 void CL_WriteToServer (void);
1213 void CL_Input (void);
1214 extern int cl_ignoremousemoves;
1217 float CL_KeyState (kbutton_t *key);
1218 const char *Key_KeynumToString (int keynum);
1219 int Key_StringToKeynum (const char *str);
1224 void CL_StopPlayback(void);
1225 void CL_ReadDemoMessage(void);
1226 void CL_WriteDemoMessage(sizebuf_t *mesage);
1228 void CL_CutDemo(unsigned char **buf, fs_offset_t *filesize);
1229 void CL_PasteDemo(unsigned char **buf, fs_offset_t *filesize);
1231 void CL_NextDemo(void);
1232 void CL_Stop_f(void);
1233 void CL_Record_f(void);
1234 void CL_PlayDemo_f(void);
1235 void CL_TimeDemo_f(void);
1240 void CL_Parse_Init(void);
1241 void CL_Parse_Shutdown(void);
1242 void CL_ParseServerMessage(void);
1243 void CL_Parse_DumpPacket(void);
1244 void CL_Parse_ErrorCleanUp(void);
1245 void QW_CL_StartUpload(unsigned char *data, int size);
1246 extern cvar_t qport;
1251 void V_StartPitchDrift (void);
1252 void V_StopPitchDrift (void);
1255 float V_CalcRoll (vec3_t angles, vec3_t velocity);
1256 void V_UpdateBlends (void);
1257 void V_ParseDamage (void);
1263 extern cvar_t cl_particles;
1264 extern cvar_t cl_particles_quality;
1265 extern cvar_t cl_particles_size;
1266 extern cvar_t cl_particles_quake;
1267 extern cvar_t cl_particles_blood;
1268 extern cvar_t cl_particles_blood_alpha;
1269 extern cvar_t cl_particles_blood_bloodhack;
1270 extern cvar_t cl_particles_bulletimpacts;
1271 extern cvar_t cl_particles_explosions_sparks;
1272 extern cvar_t cl_particles_explosions_shell;
1273 extern cvar_t cl_particles_rain;
1274 extern cvar_t cl_particles_snow;
1275 extern cvar_t cl_particles_smoke;
1276 extern cvar_t cl_particles_smoke_alpha;
1277 extern cvar_t cl_particles_smoke_alphafade;
1278 extern cvar_t cl_particles_sparks;
1279 extern cvar_t cl_particles_bubbles;
1280 extern cvar_t cl_decals;
1281 extern cvar_t cl_decals_time;
1282 extern cvar_t cl_decals_fadetime;
1284 void CL_Particles_Clear(void);
1285 void CL_Particles_Init(void);
1286 void CL_Particles_Shutdown(void);
1288 typedef enum effectnameindex_s
1292 EFFECT_TE_GUNSHOTQUAD,
1294 EFFECT_TE_SPIKEQUAD,
1295 EFFECT_TE_SUPERSPIKE,
1296 EFFECT_TE_SUPERSPIKEQUAD,
1298 EFFECT_TE_KNIGHTSPIKE,
1299 EFFECT_TE_EXPLOSION,
1300 EFFECT_TE_EXPLOSIONQUAD,
1301 EFFECT_TE_TAREXPLOSION,
1303 EFFECT_TE_LAVASPLASH,
1304 EFFECT_TE_SMALLFLASH,
1309 EFFECT_TE_PLASMABURN,
1311 EFFECT_TE_TEI_SMOKE,
1312 EFFECT_TE_TEI_BIGEXPLOSION,
1313 EFFECT_TE_TEI_PLASMAHIT,
1319 EFFECT_TR_SLIGHTBLOOD,
1320 EFFECT_TR_KNIGHTSPIKE,
1321 EFFECT_TR_VORESPIKE,
1322 EFFECT_TR_NEHAHRASMOKE,
1323 EFFECT_TR_NEXUIZPLASMA,
1324 EFFECT_TR_GLOWTRAIL,
1325 EFFECT_SVC_PARTICLE,
1330 int CL_ParticleEffectIndexForName(const char *name);
1331 const char *CL_ParticleEffectNameForIndex(int i);
1332 void CL_ParticleEffect(int effectindex, float pcount, const vec3_t originmins, const vec3_t originmaxs, const vec3_t velocitymins, const vec3_t velocitymaxs, entity_t *ent, int palettecolor);
1333 void CL_ParticleTrail(int effectindex, float pcount, const vec3_t originmins, const vec3_t originmaxs, const vec3_t velocitymins, const vec3_t velocitymaxs, entity_t *ent, int palettecolor, qboolean spawndlight, qboolean spawnparticles);
1334 void CL_ParseParticleEffect (void);
1335 void CL_ParticleCube (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, vec_t gravity, vec_t randomvel);
1336 void CL_ParticleRain (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, int type);
1337 void CL_EntityParticles (const entity_t *ent);
1338 void CL_ParticleExplosion (const vec3_t org);
1339 void CL_ParticleExplosion2 (const vec3_t org, int colorStart, int colorLength);
1340 void R_NewExplosion(const vec3_t org);
1342 void Debug_PolygonBegin(const char *picname, int flags);
1343 void Debug_PolygonVertex(float x, float y, float z, float s, float t, float r, float g, float b, float a);
1344 void Debug_PolygonEnd(void);
1346 #include "cl_screen.h"
1348 extern qboolean sb_showscores;
1350 float FogPoint_World(const vec3_t p);
1351 float FogPoint_Model(const vec3_t p);
1352 float FogForDistance(vec_t dist);
1354 typedef struct r_refdef_stats_s
1358 int entities_surfaces;
1359 int entities_triangles;
1363 int world_triangles;
1364 int lightmapupdates;
1365 int lightmapupdatepixels;
1369 int meshes_elements;
1372 int lights_scissored;
1373 int lights_lighttriangles;
1374 int lights_shadowtriangles;
1375 int lights_dynamicshadowtriangles;
1377 int bloom_copypixels;
1378 int bloom_drawpixels;
1382 typedef struct r_refdef_view_s
1384 // view information (changes multiple times per frame)
1385 // if any of these variables change then r_refdef.viewcache must be regenerated
1386 // by calling R_View_Update
1387 // (which also updates viewport, scissor, colormask)
1389 // it is safe and expected to copy this into a structure on the stack and
1390 // call the renderer recursively, then restore from the stack afterward
1391 // (as long as R_View_Update is called)
1393 // eye position information
1394 matrix4x4_t matrix, inverse_matrix;
1400 int numfrustumplanes;
1401 mplane_t frustum[6];
1402 qboolean useclipplane;
1403 qboolean usecustompvs; // uses r_refdef.viewcache.pvsbits as-is rather than computing it
1405 float frustum_x, frustum_y;
1406 vec3_t frustumcorner[4];
1407 // if turned off it renders an ortho view
1409 float ortho_x, ortho_y;
1411 // screen area to render in
1419 // which color components to allow (for anaglyph glasses)
1422 // global RGB color multiplier for rendering, this is required by HDR
1425 // whether to call R_ClearScreen before rendering stuff
1427 // if true, don't clear or do any post process effects (bloom, etc)
1430 // whether to draw r_showtris and such, this is only true for the main
1431 // view render, all secondary renders (HDR, mirrors, portals, cameras,
1432 // distortion effects, etc) omit such debugging information
1435 // these define which values to use in GL_CullFace calls to request frontface or backface culling
1439 // render quality (0 to 1) - affects r_drawparticles_drawdistance and others
1444 typedef struct r_refdef_viewcache_s
1446 // these properties are generated by R_View_Update()
1448 // which entities are currently visible for this viewpoint
1449 // (the used range is 0...r_refdef.scene.numentities)
1450 unsigned char entityvisible[MAX_EDICTS];
1451 // flag arrays used for visibility checking on world model
1452 // (all other entities have no per-surface/per-leaf visibility checks)
1453 // TODO: dynamic resize according to r_refdef.scene.worldmodel->brush.num_clusters
1454 unsigned char world_pvsbits[(32768+7)>>3]; // FIXME: buffer overflow on huge maps
1455 // TODO: dynamic resize according to r_refdef.scene.worldmodel->brush.num_leafs
1456 unsigned char world_leafvisible[32768]; // FIXME: buffer overflow on huge maps
1457 // TODO: dynamic resize according to r_refdef.scene.worldmodel->num_surfaces
1458 unsigned char world_surfacevisible[262144]; // FIXME: buffer overflow on huge maps
1459 // if true, the view is currently in a leaf without pvs data
1460 qboolean world_novis;
1462 r_refdef_viewcache_t;
1464 // TODO: really think about which fields should go into scene and which one should stay in refdef [1/7/2008 Black]
1465 // maybe also refactor some of the functions to support different setting sources (ie. fogenabled, etc.) for different scenes
1466 typedef struct r_refdef_scene_s {
1467 // whether to call S_ExtraUpdate during render to reduce sound chop
1468 qboolean extraupdate;
1470 // (client gameworld) time for rendering time based effects
1474 entity_render_t *worldentity;
1476 // same as worldentity->model
1477 dp_model_t *worldmodel;
1479 // renderable entities (excluding world)
1480 entity_render_t **entities;
1484 // field of temporary entities that is reset each (client) frame
1485 entity_render_t *tempentities;
1486 int numtempentities;
1487 int maxtempentities;
1489 // renderable dynamic lights
1490 rtlight_t *lights[MAX_DLIGHTS];
1491 rtlight_t templights[MAX_DLIGHTS];
1494 // intensities for light styles right now, controls rtlights
1495 float rtlightstylevalue[256]; // float fraction of base light value
1496 // 8.8bit fixed point intensities for light styles
1497 // controls intensity lightmap layers
1498 unsigned short lightstylevalue[256]; // 8.8 fraction of base light value
1503 qboolean rtworldshadows;
1505 qboolean rtdlightshadows;
1508 typedef struct r_refdef_s
1510 // these fields define the basic rendering information for the world
1511 // but not the view, which could change multiple times in one rendered
1512 // frame (for example when rendering textures for certain effects)
1514 // these are set for water warping before
1515 // frustum_x/frustum_y are calculated
1516 float frustumscale_x, frustumscale_y;
1518 // current view settings (these get reset a few times during rendering because of water rendering, reflections, etc)
1519 r_refdef_view_t view;
1520 r_refdef_viewcache_t viewcache;
1522 // minimum visible distance (pixels closer than this disappear)
1524 // maximum visible distance (pixels further than this disappear in 16bpp modes,
1525 // in 32bpp an infinite-farclip matrix is used instead)
1528 // fullscreen color blend
1531 r_refdef_scene_t scene;
1535 vec_t fograngerecip;
1536 vec_t fogmasktabledistmultiplier;
1537 #define FOGMASKTABLEWIDTH 1024
1538 float fogmasktable[FOGMASKTABLEWIDTH];
1539 float fogmasktable_start, fogmasktable_alpha, fogmasktable_range, fogmasktable_density;
1547 qboolean fogenabled;
1548 qboolean oldgl_fogenable;
1550 qboolean draw2dstage;
1552 // true during envmap command capture
1555 // brightness of world lightmaps and related lighting
1556 // (often reduced when world rtlights are enabled)
1557 float lightmapintensity;
1558 // whether to draw world lights realtime, dlights realtime, and their shadows
1559 float polygonfactor;
1560 float polygonoffset;
1561 float shadowpolygonfactor;
1562 float shadowpolygonoffset;
1564 // rendering stats for r_speeds display
1565 // (these are incremented in many places)
1566 r_refdef_stats_t stats;
1570 extern r_refdef_t r_refdef;