eNetGameObject Class Reference

#include <eNetGameObject.h>

Inheritance diagram for eNetGameObject:

[legend]

Collaboration diagram for eNetGameObject:

[legend]

List of all members.

Public Member Functions
virtual bool	ActionOnQuit ()
virtual void	ActionOnDelete ()
virtual void	InitAfterCreation ()
	eNetGameObject (eGrid *grid, const eCoord &pos, const eCoord &dir, ePlayerNetID *p, bool autodelete=false)
	eNetGameObject (nMessage &m)
virtual void	DoRemoveFromGame ()
	called on RemoveFromGame() after OnRemoveFromGame(). Do not call base class implementation of this function, don't expect to get called from subclasses.
virtual void	WriteCreate (nMessage &m)
virtual void	WriteSync (nMessage &m)
virtual void	ReadSync (nMessage &m)
virtual bool	ClearToTransmit (int user) const
virtual bool	SyncIsNew (nMessage &m)
virtual void	AddRef ()
	adds a reference
virtual void	Release ()
	removes a reference
virtual void	SendControl (REAL time, uActionPlayer *Act, REAL x)
virtual void	ReceiveControl (REAL time, uActionPlayer *Act, REAL x)
virtual bool	Timestep (REAL currentTime)
ePlayerNetID *	Player () const
void	clientside_action ()
virtual REAL	Lag () const
	expected average network latency
virtual REAL	LagThreshold () const
	tolerated network latency variation
Protected Member Functions
	tCHECKED_PTR (ePlayerNetID) player
virtual void	ReceiveControlNet (nMessage &m)
virtual	~eNetGameObject ()
void	SetPlayer (ePlayerNetID *player)
virtual nMachine &	DoGetMachine () const
	returns the machine this object belongs to
Protected Attributes
REAL	lastClientsideAction
REAL	lastAttemptedSyncTime
REAL	pingOverflow
REAL	laggometer
	the actual best estimate for lag
REAL	laggometerSmooth
	the lag, smoothed over time
Private Member Functions
void	MyInitAfterCreation ()
Friends
class	ePlayerNetID

---

Detailed Description

Definition at line 41 of file eNetGameObject.h.

---

Constructor & Destructor Documentation

eNetGameObject::~eNetGameObject

(

)

[protected, virtual]

Definition at line 129 of file eNetGameObject.cpp.

References NULL.

                               {
    if (player){
#ifdef DEBUG
        //con << "Player " << ePlayer->name << " controls no object.\n";
#endif
        if (player->object==this){
            player->object=NULL;
        }
    }
}

eNetGameObject::eNetGameObject	(	eGrid *	grid,
		const eCoord &	pos,
		const eCoord &	dir,
		ePlayerNetID *	p,
		bool	autodelete = false
	)

Definition at line 85 of file eNetGameObject.cpp.

References lastClientsideAction, MyInitAfterCreation(), nCLIENT, nNetObject::RequestSync(), and sn_GetNetState().

        :eGameObject(grid, pos,dir,NULL,autodelete),
nNetObject(p->Owner()),player(p){
    lastClientsideAction=0;
    if (sn_GetNetState()!=nCLIENT)
        RequestSync();
    MyInitAfterCreation();
}

Here is the call graph for this function:

eNetGameObject::eNetGameObject

(

nMessage &

m

)

Definition at line 97 of file eNetGameObject.cpp.

References eGameObject::autodelete, laggometer, laggometerSmooth, lastClientsideAction, nNetObject::Object(), pingOverflow, nMessage::Read(), and tASSERT.

        :eGameObject(eGrid::CurrentGrid(), eCoord(0,0), eCoord(0,0), NULL),
nNetObject(m){
    tASSERT(grid);

    lastClientsideAction=0;
    unsigned short pid;
    m.Read(pid);
    player=static_cast<ePlayerNetID *>(Object(pid));
    m.Read(pid);
    autodelete=pid;

    laggometerSmooth=laggometer=0;

    pingOverflow=0;
}

Here is the call graph for this function:

---

Member Function Documentation

void eNetGameObject::MyInitAfterCreation

(

void

)

[private]

Reimplemented in gCycle, and gCycleMovement.

Definition at line 69 of file eNetGameObject.cpp.

References clientside_action(), laggometer, laggometerSmooth, and pingOverflow.

Referenced by eNetGameObject(), and InitAfterCreation().

                                        {
    laggometer=laggometerSmooth=0;

    if (player){
        player->ControlObject(this);
    }
    clientside_action();

    pingOverflow=0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

eNetGameObject::tCHECKED_PTR

(

ePlayerNetID

)

[protected]

void eNetGameObject::ReceiveControlNet

(

nMessage &

m

)

[protected, virtual]

Reimplemented from nNetObject.

Definition at line 169 of file eNetGameObject.cpp.

References eGameObject::Act(), con, uActionPlayer::Find(), Lag(), MAX_PING_OVERFLOW, pingOverflow, nMessage::Read(), REAL, ReceiveControl(), se_GameTime(), sn_pingCharityServer, and x.

                                                 {
    REAL time;
    unsigned short act_id;
    REAL x;

    m >> time;
    m.Read(act_id);
    m >> x;

    REAL backdate=Lag();//sn_ping[m.SenderID()]*.5;
    if (backdate>sn_pingCharityServer*.001)
        backdate=sn_pingCharityServer*.001;

    REAL mintime=se_GameTime()-backdate*1.5-.1;
    if (time<mintime){
        con << "mintime\n";
        REAL pov_needed=mintime-time;
        if (pov_needed+pingOverflow > MAX_PING_OVERFLOW*backdate){
            pov_needed = MAX_PING_OVERFLOW*backdate-pingOverflow;
            con << "Mintime\n";
        }
        if (pov_needed<0)
            pov_needed=0;

        time=mintime-pov_needed;
        pingOverflow+=pov_needed;
    }

    if (time>se_GameTime()+1)
        time=se_GameTime()+1;

    uActionPlayer *Act=uActionPlayer::Find(act_id);

    ReceiveControl(time,Act,x);
}

Here is the call graph for this function:

void eNetGameObject::SetPlayer

(

ePlayerNetID *

player

)

[protected]

Definition at line 206 of file eNetGameObject.cpp.

References laggometer, laggometerSmooth, nCLIENT, nNetObject::Owner(), se_GetPing(), sn_GetNetState(), and tASSERT.

Referenced by gCycleMovement::CopyFrom().

{
    tASSERT( !a_player || Owner() == player->Owner() );
    player  = a_player;
    if ( laggometerSmooth == 0 && sn_GetNetState() != nCLIENT )
        laggometerSmooth = laggometer = se_GetPing( player );
}

Here is the call graph for this function:

Here is the caller graph for this function:

nMachine & eNetGameObject::DoGetMachine

(

void

)

const [protected, virtual]

returns the machine this object belongs to

Returns:

Reimplemented from nNetObject.

Definition at line 378 of file eNetGameObject.cpp.

References nNetObject::DoGetMachine(), nNetObject::GetMachine(), and Player().

{
    if ( Player() )
        return Player()->GetMachine();
    else
        return nNetObject::DoGetMachine();
}

Here is the call graph for this function:

virtual bool eNetGameObject::ActionOnQuit

(

)

[inline, virtual]

Reimplemented from nNetObject.

Reimplemented in gCycle.

Definition at line 64 of file eNetGameObject.h.

Referenced by _wrap_ENetGameObject_action_on_quit().

                               {
        //    this->Kill();
        return false;
    }

Here is the caller graph for this function:

virtual void eNetGameObject::ActionOnDelete

(

)

[inline, virtual]

Reimplemented from nNetObject.

Definition at line 69 of file eNetGameObject.h.

References eGameObject::RemoveFromGame().

                                 {
        RemoveFromGame();
    }

Here is the call graph for this function:

void eNetGameObject::InitAfterCreation

(

void

)

[virtual]

Reimplemented from nNetObject.

Reimplemented in gCycle, and gCycleMovement.

Definition at line 80 of file eNetGameObject.cpp.

References nNetObject::InitAfterCreation(), and MyInitAfterCreation().

Referenced by gCycleMovement::InitAfterCreation().

                                      {
    nNetObject::InitAfterCreation();
    MyInitAfterCreation();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eNetGameObject::DoRemoveFromGame

(

)

[virtual]

called on RemoveFromGame() after OnRemoveFromGame(). Do not call base class implementation of this function, don't expect to get called from subclasses.

Reimplemented from eGameObject.

Definition at line 114 of file eNetGameObject.cpp.

References NULL, and eGameObject::team.

                                     {
    // let the object get deleted on exit if nobody else is interested
    tControlledPTR< eNetGameObject > bounce;
    if ( this->GetRefcount() >= 0 )
        bounce = this;

    // unregister from player
    if ( player && this == player->object )
    {
        player->object = NULL;
    }

    team = NULL;
}

void eNetGameObject::WriteCreate

(

nMessage &

m

)

[virtual]

Reimplemented from nNetObject.

Reimplemented in gCycle, gZone, zShape, zShapeCircle, zShapePolygon, and zZone.

Definition at line 238 of file eNetGameObject.cpp.

References eGameObject::autodelete, nMessage::Write(), and nNetObject::WriteCreate().

Referenced by zZone::WriteCreate(), zShape::WriteCreate(), gZone::WriteCreate(), and gCycle::WriteCreate().

                                           {
    nNetObject::WriteCreate(m);
    m.Write(player->ID());
    m.Write(autodelete);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eNetGameObject::WriteSync

(

nMessage &

m

)

[virtual]

Reimplemented from nNetObject.

Reimplemented in gCycle, gZone, zShape, zShapeCircle, and zZone.

Definition at line 244 of file eNetGameObject.cpp.

References eGameObject::Direction(), eGameObject::lastTime, eGameObject::Position(), and nNetObject::WriteSync().

Referenced by zZone::WriteSync(), and gZone::WriteSync().

                                         {
    nNetObject::WriteSync(m);
    //con << lastTime << '\n';
    m << lastTime;
    m << Direction();
    m << Position();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eNetGameObject::ReadSync

(

nMessage &

m

)

[virtual]

Reimplemented from nNetObject.

Reimplemented in gCycle, gZone, zShape, zShapeCircle, and zZone.

Definition at line 252 of file eNetGameObject.cpp.

References eGameObject::dir, eGameObject::lastTime, eGameObject::pos, and nNetObject::ReadSync().

Referenced by zZone::ReadSync(), and gZone::ReadSync().

                                        {
    nNetObject::ReadSync(m);
    m >> lastTime;
    m >> dir;

    m >> pos;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool eNetGameObject::ClearToTransmit

(

int

user

)

const [virtual]

Reimplemented from nNetObject.

Definition at line 265 of file eNetGameObject.cpp.

References nNetObject::ClearToTransmit(), con, nNetObject::DoDebugPrint(), nNetObject::ID(), eTransferInhibitor::no_transfer(), and st_Breakpoint().

                                                  {
#ifdef DEBUG
    if (nNetObject::DoDebugPrint())
    {
        if (eTransferInhibitor::no_transfer(user))
        {
            con << "Not transfering eNetGameObject " << ID()
            << " for user " << user << " because of some obscure reason.\n";
            st_Breakpoint();
            eTransferInhibitor::no_transfer(user);
        }
        else if (!player)
            con << "Not transfering eNetGameObject " << ID()
            << " for user " << user << " because it has no player!\n";
        else if (!player->HasBeenTransmitted(user))
        {
            tString s;
            s << "No transfering eNetGameObject " << ID()
            << " for user " << user << " because ";
            player->PrintName(s);
            s << " has not been transmitted.\n";
            con << s;
        }
    }
#endif


    return
        nNetObject::ClearToTransmit(user) &&
        !eTransferInhibitor::no_transfer(user) &&
        (!player ||
         player->HasBeenTransmitted(user));
}

Here is the call graph for this function:

bool eNetGameObject::SyncIsNew

(

nMessage &

m

)

[virtual]

Reimplemented from nNetObject.

Reimplemented in gCycle.

Definition at line 142 of file eNetGameObject.cpp.

References con, eCoord, lastAttemptedSyncTime, lastClientsideAction, nNetObject::Owner(), sn_myNetID, and nNetObject::SyncIsNew().

Referenced by gCycle::SyncIsNew().

                                         {
    bool ret=nNetObject::SyncIsNew(m);
    m >> lastAttemptedSyncTime;

#ifdef DEBUG
    if (Owner()==::sn_myNetID && lastAttemptedSyncTime>lastClientsideAction+100){
        con << "Warning! time overflow!\n";
    }
#endif

    eCoord dummy;
    m >> dummy;
    m >> dummy;
    return (ret);       // && lastAttemptedSyncTime>lastClientsideAction); // test for time no longer needed
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eNetGameObject::AddRef

(

void

)

[virtual]

adds a reference

Implements eGameObject.

Reimplemented in gCycleMovement.

Definition at line 158 of file eNetGameObject.cpp.

References nNetObject::AddRef().

Referenced by gCycleMovement::AddRef().

{
    nNetObject::AddRef();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eNetGameObject::Release

(

)

[virtual]

removes a reference

Implements eGameObject.

Definition at line 163 of file eNetGameObject.cpp.

References nNetObject::Release().

{
    nNetObject::Release();
}

Here is the call graph for this function:

void eNetGameObject::SendControl	(	REAL	time,
		uActionPlayer *	Act,
		REAL	x
	)			[virtual]

Definition at line 214 of file eNetGameObject.cpp.

References nMessage::BroadCast(), uAction::ID(), nCLIENT, nNetObject::NewControlMessage(), nNetObject::Owner(), sn_GetNetState(), sn_myNetID, and nMessage::Write().

                                                                   {
    if (sn_GetNetState()==nCLIENT && Owner()==::sn_myNetID){
        //con << "sending control at " << time << "\n";
        nMessage *m=NewControlMessage();
        *m << time;
        m->Write(Act->ID());
        *m << x;
        m->BroadCast();
    }
}

Here is the call graph for this function:

void eNetGameObject::ReceiveControl	(	REAL	time,
		uActionPlayer *	Act,
		REAL	x
	)			[virtual]

Reimplemented in gCycle.

Definition at line 225 of file eNetGameObject.cpp.

References nCLIENT, nNetObject::RequestSync(), sn_GetNetState(), and tERR_ERROR.

Referenced by ReceiveControlNet().

                                                                      {
#ifdef DEBUG
    if (sn_GetNetState()==nCLIENT)
        tERR_ERROR("rec_cont should not be called client-side!");
#endif

    // after control is received, we better sync this object with
    // the clients:

    RequestSync();
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool eNetGameObject::Timestep

(

REAL

currentTime

)

[virtual]

Reimplemented from eGameObject.

Reimplemented in gCycle, gCycleMovement, gZone, gBaseZoneHack, and zZone.

Definition at line 299 of file eNetGameObject.cpp.

References laggometer, laggometerSmooth, eGameObject::lastTime, nSERVER, nSTANDALONE, nNetObject::Owner(), PING_OVERFLOW_TS, pingOverflow, REAL, se_GetPing(), sn_GetNetState(), and sn_myNetID.

Referenced by gCycleMovement::TimestepCore().

                                             {
    // calculate new sr_laggometer
    if (sn_GetNetState() == nSTANDALONE){
        laggometerSmooth=0;
        return false;
    }

    REAL animts=(currentTime-lastTime);
    if (animts<0)
        animts=0;

    if (sn_GetNetState() == nSERVER || Owner() == ::sn_myNetID ||
            ( player && laggometer <= 0 ) )
    {
        // calculate laggometer from ping
        laggometer = se_GetPing( player );
    }

    // legitimate, but does not look good:
    // if ( laggometerSmooth <= 0 )
    //    laggometerSmooth = laggometer;

    laggometerSmooth=(laggometerSmooth+laggometer*animts)/(1 + animts);
    lastTime=currentTime;

    // Update ping overflow
    pingOverflow/=(1+animts*PING_OVERFLOW_TS);

    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ePlayerNetID* eNetGameObject::Player

(

)

const [inline]

Definition at line 99 of file eNetGameObject.h.

Referenced by gEnemyInfluence::AddWall(), gCycleMovement::CopyFrom(), gDestination::CopyFrom(), gAIPlayer::CycleBlocksWay(), DoGetMachine(), gCycleMovement::DoTurn(), gCycle::DoTurn(), gAISensor::gAISensor(), zZone::InteractWith(), gZone::InteractWith(), zShapePolygon::isInteracting(), zShapeCircle::isInteracting(), zValidatorAllButTeamOwner::isValid(), zValidatorAllButOwner::isValid(), zValidatorOwnerTeam::isValid(), zValidatorOwner::isValid(), gCycle::KillAt(), gCycleMovement::MyInitAfterCreation(), gCycle::MyInitAfterCreation(), new_destination_handler(), gBaseZoneHack::OnEnter(), gDeathZoneHack::OnEnter(), gWinZoneHack::OnEnter(), gCycle::OnNotifyNewDestination(), gCycle::OnRoundEnd(), gCycle::PassEdge(), zSelectorAnotherNotTeammateDead::select(), zSelectorAnotherTeammateDead::select(), zSelectorAnother::select(), zSelectorAllButSelf::select(), zSelectorTeam::select(), zSelectorTeammate::select(), zSelectorSelf::select(), cCockpit::SetCycle(), sg_HoleScore(), sg_TopologyPoliceCheck(), sg_TopologyPoliceKill(), gBaseZoneHack::Timestep(), gCycleMovement::Timestep(), gCycle::Timestep(), gCamera::Timestep(), and gCycleMovement::TimestepCore().

{return player;}

Here is the caller graph for this function:

void eNetGameObject::clientside_action

(

)

[inline]

Definition at line 101 of file eNetGameObject.h.

References lastClientsideAction, and eGameObject::lastTime.

Referenced by gCycle::DoTurn(), MyInitAfterCreation(), and gCycle::SyncEnemy().

{lastClientsideAction=lastTime;}

Here is the caller graph for this function:

REAL eNetGameObject::Lag

(

)

const [virtual]

expected average network latency

Reimplemented from eGameObject.

Definition at line 330 of file eNetGameObject.cpp.

References laggometerSmooth.

Referenced by new_destination_handler(), gCycle::OnNotifyNewDestination(), gCycle::PassEdge(), ReceiveControlNet(), gCycle::Render(), gCycleMovement::Timestep(), and gCycleMovement::TimestepCore().

                              {
    return laggometerSmooth;
}

Here is the caller graph for this function:

REAL eNetGameObject::LagThreshold

(

)

const [virtual]

tolerated network latency variation

Reimplemented from eGameObject.

Definition at line 334 of file eNetGameObject.cpp.

References nSERVER, nNetObject::Owner(), sn_GetNetState(), and eLag::Threshold().

Referenced by gCycleMovement::TimestepCore().

                                       {
    // ask the lag compensation framework
    if ( sn_GetNetState() != nSERVER )
        return 0;
    if ( Owner() == 0 )
        return 0;
    return eLag::Threshold();
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

Friends And Related Function Documentation

friend class ePlayerNetID [friend]

Reimplemented from eGameObject.

Definition at line 42 of file eNetGameObject.h.

---

Member Data Documentation

REAL eNetGameObject::lastClientsideAction [protected]

Definition at line 46 of file eNetGameObject.h.

Referenced by clientside_action(), eNetGameObject(), and SyncIsNew().

REAL eNetGameObject::lastAttemptedSyncTime [protected]

Definition at line 47 of file eNetGameObject.h.

Referenced by SyncIsNew().

REAL eNetGameObject::pingOverflow [protected]

Definition at line 48 of file eNetGameObject.h.

Referenced by eNetGameObject(), MyInitAfterCreation(), ReceiveControlNet(), and Timestep().

REAL eNetGameObject::laggometer [protected]

the actual best estimate for lag

Definition at line 52 of file eNetGameObject.h.

Referenced by eNetGameObject(), MyInitAfterCreation(), SetPlayer(), gCycle::SyncEnemy(), and Timestep().

REAL eNetGameObject::laggometerSmooth [protected]

the lag, smoothed over time

Definition at line 53 of file eNetGameObject.h.

Referenced by eNetGameObject(), Lag(), MyInitAfterCreation(), SetPlayer(), gCycle::SyncEnemy(), and Timestep().

---

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

• src/engine/eNetGameObject.h
• src/engine/eNetGameObject.cpp

---