Lag Compensation: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(cvars)
Line 3: Line 3:
[[File:Lag compensation.jpg|thumb|Historic client hitboxes (red) versus rewound server hitboxes (blue).]]
[[File:Lag compensation.jpg|thumb|Historic client hitboxes (red) versus rewound server hitboxes (blue).]]


'''Lag compensation''' is the notion of the server calculating as best it can when a [[usercmd]] was sent, and rewinding time to that point when processing it. In combination with [[prediction]], lag compensation can help to combat network latency to the point of almost eliminating it.
'''Lag compensation''' is the notion of the server using a player's latency to rewind time when processing a [[usercmd]], in order to see what the player saw when the command was sent. In combination with [[prediction]] lag compensation can help to combat network latency to the point of almost eliminating it (from the perspective of an attacker). For a more detailed explanation see the [[Source Multiplayer Networking#Lag compensation|Source Multiplayer Networking]] article.


By default only players are rewound. For a more detailed explanation, see [[Source Multiplayer Networking#Lag compensation|Source Multiplayer Networking]].
By default only players are rewound, and one second of location/animation history is kept.


{{note|<code>[[CBasePlayer]]</code> does not use lag compensation; it must be implemented by a derived class. Valve's networked player classes do this already.}}
{{note|<code>[[CBasePlayer]]</code> does not use lag compensation; it must be implemented by a derived class. Valve's networked player classes do this already.}}


{{tip|In [[Left 4 Dead 2]], [[prop_physics]] can lag compensated. Do this sparingly!}}
{{tip|In {{l4d2}} Left 4 Dead 2, [[prop_physics]] entities can lag compensated. Do this sparingly!}}
 
== Configuration ==
 
{{IO|cl_lagcompensation|param=bool|Allows clients to tell the server that they don't want their own commands lag compensated. This is ''not'' a cheat.}}
{{IO|cl_lagcomp_errorcheck|param=int|Deprecated? In theory displays error information for the given player index, in practice is not referenced anywhere.}}
{{IO|sv_lagcompensationforcerestore|param=bool|Cheat. Disabling this causes the game to check if each entity can still occupy its rewind position in the current, un-rewound world. If it can't, it is rewound to the last valid position instead of the desired one. {{todo|Why would anyone want this?}}}}
{{IO|sv_showlagcompensation|param=bool|Cheat. Displays rewound [[hitbox]]es whenever a player is lag compensated. This fills the role of the old <code>sv_showhitboxes</code> command, only without the confusion caused by the hitboxes also being shown when compensation is not in effect.}}
 
Developer server builds (those compiled with <code>ALLOW_DEVELOPMENT_CVARS</code>) have some extra commands:
 
{{IO|sv_unlag|param=bool|Enable/disable lag compensation entirely.}}
{{IO|sv_maxunlag|param=float|Number of seconds to store player positions for. Default (and maximum) is 1.}}


== Invocation ==
== Invocation ==
Line 15: Line 27:
Simply wrap whatever code you want lag compensated within two calls to the <code>lagcompensation</code> object:
Simply wrap whatever code you want lag compensated within two calls to the <code>lagcompensation</code> object:


<source lang=cpp>#ifdef GAME_DLL
<source lang=cpp>
#ifdef GAME_DLL


#include "..\server\ilagcompensationmanager.h"
#include "..\server\ilagcompensationmanager.h"
Line 31: Line 44:
lagcompensation->FinishLagCompensation( this );
lagcompensation->FinishLagCompensation( this );
}
}
#endif</source>
#endif
</source>


Time will be wound back on the call to <code>StartLagCompensation()</code>, and wound forward again on the call to <code>FinishLagCompensation()</code>.
Time will be wound back on the call to <code>StartLagCompensation()</code>, and wound forward again on the call to <code>FinishLagCompensation()</code>.
Line 50: Line 64:
== Implementation ==
== Implementation ==


{{todo}}
{{todo|Supporting lag compensation on new entities.}}


== See also ==
== See also ==

Revision as of 05:30, 19 September 2011

You may be looking for Yahn Bernier's 2001 paper on game engine networking.
Historic client hitboxes (red) versus rewound server hitboxes (blue).

Lag compensation is the notion of the server using a player's latency to rewind time when processing a usercmd, in order to see what the player saw when the command was sent. In combination with prediction lag compensation can help to combat network latency to the point of almost eliminating it (from the perspective of an attacker). For a more detailed explanation see the Source Multiplayer Networking article.

By default only players are rewound, and one second of location/animation history is kept.

Note.pngNote:CBasePlayer does not use lag compensation; it must be implemented by a derived class. Valve's networked player classes do this already.
Tip.pngTip:In Left 4 Dead 2 Left 4 Dead 2, prop_physics entities can lag compensated. Do this sparingly!

Configuration

cl_lagcompensation <booleanRedirectInput/boolean>
Allows clients to tell the server that they don't want their own commands lag compensated. This is not a cheat.
cl_lagcomp_errorcheck <integerRedirectInput/integer>
Deprecated? In theory displays error information for the given player index, in practice is not referenced anywhere.
sv_lagcompensationforcerestore <booleanRedirectInput/boolean>
Cheat. Disabling this causes the game to check if each entity can still occupy its rewind position in the current, un-rewound world. If it can't, it is rewound to the last valid position instead of the desired one.
Todo: Why would anyone want this?
sv_showlagcompensation <booleanRedirectInput/boolean>
Cheat. Displays rewound hitboxes whenever a player is lag compensated. This fills the role of the old sv_showhitboxes command, only without the confusion caused by the hitboxes also being shown when compensation is not in effect.

Developer server builds (those compiled with ALLOW_DEVELOPMENT_CVARS) have some extra commands:


sv_unlag <booleanRedirectInput/boolean>
Enable/disable lag compensation entirely.
sv_maxunlag <floatRedirectInput/float>
Number of seconds to store player positions for. Default (and maximum) is 1.

Invocation

Simply wrap whatever code you want lag compensated within two calls to the lagcompensation object: 

#ifdef GAME_DLL

#include "..\server\ilagcompensationmanager.h"

void CMyPlayer::FireBullets ( const FireBulletsInfo_t &info )
{
	// Source 2007
	lagcompensation->StartLagCompensation( this, this->GetCurrentCommand() );

	// Alien Swarm and later (see also sub-section below)
	lagcompensation->StartLagCompensation( this, LAG_COMPENSATE_HITBOXES );

	BaseClass::FireBullets(info);

	lagcompensation->FinishLagCompensation( this );
}
#endif

Time will be wound back on the call to StartLagCompensation(), and wound forward again on the call to FinishLagCompensation().

Lag Compensation Type

Starting with Alien Swarm, you can optimise lag compensation with these settings:

LAG_COMPENSATE_BOUNDS
Rewind entities' locations only, skipping animations.
LAG_COMPENSATE_HITBOXES
Rewind both locations and hitboxes. This is the standard setting.
LAG_COMPENSATE_HITBOXES_ALONG_RAY
Rewind hitboxes if an entity is hit by a ray defined by the "weaponPos" StartLagCompensation() overload. Otherwise rewind bounds only.

These setting chosen applies to all entities affected by the rewind.

Implementation

Todo: Supporting lag compensation on new entities.

See also

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Lag_Compensation&oldid=159840"