2 * Copyright (c) 2011 Rudolf Polzer
3 * Copyright (c) 2015 Micah Talkiewicz
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to
7 * deal in the Software without restriction, including without limitation the
8 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
9 * sell copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
23 #include "cl_player.qh"
25 #include "cl_model.qh"
27 #include "interpolate.qh"
28 #include "../../client/defs.qh"
29 #include "../../client/main.qh"
30 #include "../../common/constants.qh"
31 #include "../../common/physics.qh"
32 #include "../../common/stats.qh"
33 #include "../../common/triggers/trigger/viewloc.qh"
34 #include "../../common/util.qh"
35 #include "../../common/viewloc.qh"
37 float autocvar_cl_movement_errorcompensation = 0;
38 bool autocvar_cl_movement = true;
41 float pmove_onground; // weird engine flag we shouldn't really use but have to for now
43 vector csqcplayer_origin, csqcplayer_velocity;
44 float csqcplayer_sequence;
46 float csqcplayer_moveframe;
47 vector csqcplayer_predictionerroro;
48 vector csqcplayer_predictionerrorv;
49 float csqcplayer_predictionerrortime;
50 float csqcplayer_predictionerrorfactor;
52 vector CSQCPlayer_GetPredictionErrorO()
54 if (time >= csqcplayer_predictionerrortime) return '0 0 0';
55 return csqcplayer_predictionerroro * (csqcplayer_predictionerrortime - time) * csqcplayer_predictionerrorfactor;
58 vector CSQCPlayer_GetPredictionErrorV()
60 if (time >= csqcplayer_predictionerrortime) return '0 0 0';
61 return csqcplayer_predictionerrorv * (csqcplayer_predictionerrortime - time) * csqcplayer_predictionerrorfactor;
64 void CSQCPlayer_SetPredictionError(vector o, vector v, float onground_diff)
66 // error too big to compensate, we LIKELY hit a teleport or a
67 // jumppad, or it's a jump time disagreement that'll get fixed
70 // FIXME we sometimes have disagreement in order of jump velocity. Do not act on them!
72 // commented out as this one did not help
75 printf("ONGROUND MISMATCH: %d x=%v v=%v\n", onground_diff, o, v);
79 if(vlen(o) > 32 || vlen(v) > 192)
81 //printf("TOO BIG: x=%v v=%v\n", o, v);
85 if(!autocvar_cl_movement_errorcompensation)
87 csqcplayer_predictionerrorfactor = 0;
91 csqcplayer_predictionerroro = CSQCPlayer_GetPredictionErrorO() + o;
92 csqcplayer_predictionerrorv = CSQCPlayer_GetPredictionErrorV() + v;
93 csqcplayer_predictionerrorfactor = autocvar_cl_movement_errorcompensation / ticrate;
94 csqcplayer_predictionerrortime = time + 1.0 / csqcplayer_predictionerrorfactor;
97 void CSQCPlayer_Unpredict(entity this)
99 if (csqcplayer_status == CSQCPLAYERSTATUS_UNPREDICTED) return;
100 if (csqcplayer_status != CSQCPLAYERSTATUS_PREDICTED) LOG_FATALF("Cannot unpredict in current status (%d)\n", csqcplayer_status);
101 this.origin = csqcplayer_origin;
102 this.velocity = csqcplayer_velocity;
103 csqcplayer_moveframe = csqcplayer_sequence + 1; // + 1 because the recieved frame has the move already done (server side)
104 this.flags = player_pmflags;
107 void CSQCPlayer_SetMinsMaxs(entity this)
109 if (this.flags & FL_DUCKED)
111 this.mins = PL_CROUCH_MIN;
112 this.maxs = PL_CROUCH_MAX;
113 this.view_ofs = PL_CROUCH_VIEW_OFS;
119 this.view_ofs = PL_VIEW_OFS;
123 void CSQCPlayer_SavePrediction(entity this)
125 player_pmflags = this.flags;
126 csqcplayer_origin = this.origin;
127 csqcplayer_velocity = this.velocity;
128 csqcplayer_sequence = servercommandframe;
129 csqcplayer_status = CSQCPLAYERSTATUS_PREDICTED;
132 void CSQC_ClientMovement_PlayerMove_Frame(entity this);
134 void PM_Movement_Move(entity this)
136 runstandardplayerphysics(this);
139 ((this.pmove_flags & PMF_DUCKED) ? FL_DUCKED : 0) |
140 (!(this.pmove_flags & PMF_JUMP_HELD) ? FL_JUMPRELEASED : 0) |
141 ((this.pmove_flags & PMF_ONGROUND) ? FL_ONGROUND : 0);
145 void CSQCPlayer_Physics(entity this)
147 if(autocvar_cl_movement)
148 CSQC_ClientMovement_PlayerMove_Frame(this);
151 void CSQCPlayer_PredictTo(entity this, float endframe, bool apply_error)
153 CSQCPlayer_Unpredict(this);
156 this.origin += CSQCPlayer_GetPredictionErrorO();
157 this.velocity += CSQCPlayer_GetPredictionErrorV();
159 CSQCPlayer_SetMinsMaxs(this);
161 csqcplayer_status = CSQCPLAYERSTATUS_PREDICTED;
164 // we don't need this
165 // darkplaces makes servercommandframe == 0 in these cases anyway
166 if (getstatf(STAT_HEALTH) <= 0)
168 csqcplayer_moveframe = clientcommandframe;
169 getinputstate(csqcplayer_moveframe-1);
170 LOG_INFO("the Weird code path got hit\n");
175 if (csqcplayer_moveframe >= endframe)
177 getinputstate(csqcplayer_moveframe - 1);
183 if (!getinputstate(csqcplayer_moveframe)) break;
184 CSQCPlayer_Physics(this);
185 CSQCPlayer_SetMinsMaxs(this);
186 ++csqcplayer_moveframe;
188 while (csqcplayer_moveframe < endframe);
191 // add in anything that was applied after (for low packet rate protocols)
192 input_angles = view_angles;
195 bool CSQCPlayer_IsLocalPlayer(entity this)
197 return (this == csqcplayer);
200 void CSQCPlayer_SetViewLocation()
202 viewloc_SetViewLocation();
205 /** Called once per CSQC_UpdateView() */
206 void CSQCPlayer_SetCamera()
208 const vector v0 = pmove_vel; // TRICK: pmove_vel is set by the engine when we get here. No need to network velocity
209 const float vh = getstati(STAT_VIEWHEIGHT);
210 const vector pl_viewofs = PL_VIEW_OFS;
211 const vector pl_viewofs_crouch = PL_CROUCH_VIEW_OFS;
212 const entity e = csqcplayer;
215 if (servercommandframe == 0 || clientcommandframe == 0)
217 InterpolateOrigin_Do(e);
218 e.view_ofs = '0 0 1' * vh;
220 // get crouch state from the server
221 if (vh == pl_viewofs.z) e.flags &= ~FL_DUCKED;
222 else if (vh == pl_viewofs_crouch.z) e.flags |= FL_DUCKED;
224 // get onground state from the server
225 e.flags = BITSET(e.flags, FL_ONGROUND, pmove_onground);
227 CSQCPlayer_SetMinsMaxs(e);
229 // override it back just in case
230 e.view_ofs = '0 0 1' * vh;
237 const int flg = e.iflags; e.iflags &= ~(IFLAG_ORIGIN | IFLAG_ANGLES);
238 InterpolateOrigin_Do(e);
241 if (csqcplayer_status == CSQCPLAYERSTATUS_FROMSERVER)
243 const vector o = e.origin;
244 csqcplayer_status = CSQCPLAYERSTATUS_PREDICTED;
245 CSQCPlayer_PredictTo(e, servercommandframe + 1, false);
246 CSQCPlayer_SetPredictionError(e.origin - o, e.velocity - v0, pmove_onground - boolean(e.flags & FL_ONGROUND));
250 // get crouch state from the server
251 if (vh == pl_viewofs.z) e.flags &= ~FL_DUCKED;
252 else if(vh == pl_viewofs_crouch.z) e.flags |= FL_DUCKED;
254 // get onground state from the server
255 e.flags = BITSET(e.flags, FL_ONGROUND, pmove_onground);
257 CSQCPlayer_SavePrediction(e);
259 CSQCPlayer_PredictTo(e, clientcommandframe + 1, true);
261 #ifdef CSQCMODEL_SERVERSIDE_CROUCH
262 // get crouch state from the server (LAG)
263 if (vh == pl_viewofs.z) e.flags &= ~FL_DUCKED;
264 else if (vh == pl_viewofs_crouch.z) e.flags |= FL_DUCKED;
266 CSQCPlayer_SetMinsMaxs(e);
268 e.angles_y = input_angles.y;
272 setorigin(e, e.origin);
275 const entity view = CSQCModel_server2csqc(player_localentnum - 1);
278 if (view != csqcplayer)
280 InterpolateOrigin_Do(view);
281 view.view_ofs = '0 0 1' * vh;
284 if (view.csqcmodel_teleported) refdefflags |= REFDEFFLAG_TELEPORTED;
285 if (input_buttons & BIT(1)) refdefflags |= REFDEFFLAG_JUMPING;
286 // note: these two only work in WIP2, but are harmless in WIP1
287 if (getstati(STAT_HEALTH) <= 0) refdefflags |= REFDEFFLAG_DEAD;
288 if (intermission) refdefflags |= REFDEFFLAG_INTERMISSION;
289 V_CalcRefdef(view, refdefflags);
293 // FIXME by CSQC spec we have to do this:
294 // but it breaks chase cam
296 setproperty(VF_ORIGIN, pmove_org + '0 0 1' * vh);
297 setproperty(VF_ANGLES, view_angles);
300 CSQCPLAYER_HOOK_POSTCAMERASETUP();
303 void CSQCPlayer_Remove()
306 cvar_settemp("cl_movement_replay", "1");
309 bool CSQCPlayer_PreUpdate(entity this)
311 if (this != csqcplayer) return false;
312 if (csqcplayer_status != CSQCPLAYERSTATUS_FROMSERVER) CSQCPlayer_Unpredict(this);
316 bool CSQCPlayer_PostUpdate(entity this)
318 if (this.entnum != player_localnum + 1) return false;
320 csqcplayer_status = CSQCPLAYERSTATUS_FROMSERVER;
321 cvar_settemp("cl_movement_replay", "0");
322 this.entremove = CSQCPlayer_Remove;