eLag Class Reference

class for lag compensation functions in the game code More...

#include <eLagCompensation.h>

List of all members.

Static Public Member Functions
static void	Report (int client, REAL lag)
	call on the server: report that a client is lagging
static REAL	TakeCredit (int client, REAL lag)
	call on the server: ask for lag credit to backdate received commands
static REAL	Credit (int client)
	call on the server: ask how much lag credit is left
static REAL	Threshold ()
	call on the server: gives the amount of lag that is always tolerated without using up credit
static REAL	Current ()
	call on the client: returns the amount of lag that is currently to be compensated by the game code
static void	Timestep (REAL dt)
	call on the client: advance time

---

Detailed Description

class for lag compensation functions in the game code

Definition at line 35 of file eLagCompensation.h.

---

Member Function Documentation

void eLag::Report	(	int	client,
		REAL	lag
	)			[static]

call on the server: report that a client is lagging

Parameters:

	client	the ID of the client the lag is happening for
	lag	the amount of lag

Returns:

the amount of lag that is allowed to be compensated by the game code

Definition at line 356 of file eLagCompensation.cpp.

References MAXCLIENTS, nServerLag::Report(), and tVERIFY.

Referenced by gCycle::OnNotifyNewDestination().

{
    tVERIFY( 1 <= client && client <= MAXCLIENTS );

    se_serverLag[client].Report( lag );
}

Here is the call graph for this function:

Here is the caller graph for this function:

REAL eLag::TakeCredit	(	int	client,
		REAL	lag
	)			[static]

call on the server: ask for lag credit to backdate received commands

Parameters:

	client	the ID of the client the lag is happening for
	lag	the amount of lag that is to be compensated

Returns:

the amount of lag that is allowed to be compensated by the game code

Definition at line 375 of file eLagCompensation.cpp.

References MAXCLIENTS, nServerLag::TakeCredit(), and tVERIFY.

Referenced by gCycle::OnNotifyNewDestination().

{
    tVERIFY( 1 <= client && client <= MAXCLIENTS );

    return se_serverLag[client].TakeCredit( lag );
}

Here is the call graph for this function:

Here is the caller graph for this function:

REAL eLag::Credit

(

int

client

)

[static]

call on the server: ask how much lag credit is left

Parameters:

client

the ID of the client the lag is happening for

Returns:

the amount of lag that is allowed to be compensated by the game code

Definition at line 394 of file eLagCompensation.cpp.

References nServerLag::CreditLeft(), MAXCLIENTS, nSERVER, REAL, se_lagCreditSingle, sn_GetNetState(), and tVERIFY.

Referenced by gCycleMovement::TimestepCore().

{
    // don't give credit on the client
    if ( sn_GetNetState() != nSERVER )
        return 0;

    tVERIFY( 1 <= client && client <= MAXCLIENTS );

    // see how much total credit is left
    REAL credit = se_serverLag[client].CreditLeft();

    // but clamp it with the maximum single credit
    return credit > se_lagCreditSingle ? se_lagCreditSingle : credit;
}

Here is the call graph for this function:

Here is the caller graph for this function:

REAL eLag::Threshold

(

void

)

[static]

call on the server: gives the amount of lag that is always tolerated without using up credit

Returns:

the amount of lag that is always tolerated

Definition at line 419 of file eLagCompensation.cpp.

References se_lagThreshold.

Referenced by eNetGameObject::LagThreshold().

{
    return se_lagThreshold;
}

Here is the caller graph for this function:

REAL eLag::Current

(

void

)

[static]

call on the client: returns the amount of lag that is currently to be compensated by the game code

Returns:

the amount of lag that needs to be compensated

Definition at line 434 of file eLagCompensation.cpp.

References se_lagOffsetClient, se_lagOffsetServer, and nClientLag::SmoothLag().

Referenced by eTimer::Time().

{
    return se_clientLag.SmoothLag() + se_lagOffsetClient + se_lagOffsetServer;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eLag::Timestep

(

REAL

dt

)

[static]

call on the client: advance time

Parameters:

dt

time passed since last call

Definition at line 449 of file eLagCompensation.cpp.

References nClientLag::Timestep().

Referenced by eTimer::SyncTime().

{
    se_clientLag.Timestep( dt );
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• src/engine/eLagCompensation.h
• src/engine/eLagCompensation.cpp

---