C4GameControl Class Reference

#include <C4GameControl.h>

Collaboration diagram for C4GameControl:

Public Member Functions
	C4GameControl ()
	~C4GameControl ()
bool	isLocal () const
bool	isNetwork () const
bool	isReplay () const
bool	isCtrlHost () const
bool	isRecord () const
C4Record *	GetRecord ()
int32_t	ClientID () const
bool	SyncMode () const
bool	NoInput () const
C4GameControlClient *	getClient (int32_t iID)
C4GameControlClient *	getClient (const char *szName)
bool	InitLocal (C4Client *pLocal)
bool	InitNetwork (C4Client *pLocal)
bool	InitReplay (C4Group &rGroup)
void	ChangeToLocal ()
void	Clear ()
void	Default ()
bool	StartRecord (bool fInitial, bool fStreaming)
void	StopRecord (StdStrBuf *pRecordName=nullptr, BYTE *pRecordSHA1=nullptr)
void	RequestRuntimeRecord ()
bool	IsRuntimeRecordPossible () const
bool	RecAddFile (const char *szLocalFilename, const char *szAddAs)
bool	Prepare ()
void	Execute ()
void	Ticks ()
bool	CtrlTickReached (int32_t iTick)
int32_t	getCtrlTick (int32_t iFrame) const
int32_t	getNextControlTick () const
void	AdjustControlRate (int32_t iBy)
bool	KeyAdjustControlRate (int32_t iBy)
void	SetActivated (bool fActivated)
void	DoInput (C4PacketType eCtrlType, C4ControlPacket *pPkt, C4ControlDeliveryType eDelivery)
void	DbgRec (C4RecordChunkType eType, const uint8_t *pData=nullptr, size_t iSize=0)
C4ControlDeliveryType	DecideControlDelivery ()
void	DoSyncCheck ()
void	ExecControl (const C4Control &rCtrl)
void	ExecControlPacket (C4PacketType eCtrlType, class C4ControlPacket *pPkt)
void	OnGameSynchronizing ()

Public Attributes
C4Control	Input
C4GameControlNetwork	Network
int32_t	ControlRate
int32_t	ControlTick
int32_t	SyncRate
bool	DoSync

Protected Member Functions
C4ControlSyncCheck *	GetSyncCheck (int32_t iTick)
void	RemoveOldSyncChecks ()
void	PrepareInput ()

Protected Attributes
C4ControlMode	eMode
bool	fInitComplete
bool	fHost
bool	fActivated
bool	fRecordNeeded
int32_t	iClientID
C4Record *	pRecord
C4Playback *	pPlayback
C4Control	SyncChecks
C4GameControlClient *	pClients
C4Control *	pExecutingControl

Friends
class	C4ControlSyncCheck
class	C4GameControlNetwork

Detailed Description

Definition at line 57 of file C4GameControl.h.

Constructor & Destructor Documentation

C4GameControl()

C4GameControl::C4GameControl

(

)

Definition at line 36 of file C4GameControl.cpp.

        : Network(this)
{
    Default();
}

References Default().

Here is the call graph for this function:

~C4GameControl()

C4GameControl::~C4GameControl

(

)

Definition at line 42 of file C4GameControl.cpp.

{
    Clear();
}

References Clear().

Here is the call graph for this function:

Member Function Documentation

AdjustControlRate()

void C4GameControl::AdjustControlRate

(

int32_t

iBy

)

Definition at line 368 of file C4GameControl.cpp.

{
    // control host only
    if (isCtrlHost())
        ::Control.DoInput(CID_Set, new C4ControlSet(C4CVT_ControlRate, iBy), CDT_Decide);
}

References C4CVT_ControlRate, CDT_Decide, CID_Set, Control, DoInput(), and isCtrlHost().

Referenced by KeyAdjustControlRate().

Here is the call graph for this function:

Here is the caller graph for this function:

ChangeToLocal()

void C4GameControl::ChangeToLocal

(

)

Definition at line 91 of file C4GameControl.cpp.

{
    // changes from any given mode to local
    // (emergency - think of network disconnect)
 
    // remove all non-local clients
    Game.Clients.RemoveRemote();
    // activate local client
    if (Game.Clients.getLocal())
        Game.Clients.getLocal()->SetActivated(true);
 
    // network: clear network
    if (eMode == CM_Network)
    {
        Network.Clear();
        if (::Network.isEnabled())
            ::Network.Clear();
    }
    // replay: close playback
    else if (eMode == CM_Replay)
        { delete pPlayback; pPlayback = nullptr; }
 
    // we're now managing our own player info list; make sure counter works
    Game.PlayerInfos.FixIDCounter();
 
    // start the game, if we're not in the game over dialog
    // (otherwise, clients start game when host disconnected!)
    if (!C4GameOverDlg::IsShown()) Game.HaltCount = 0;
 
    // set status
    eMode = CM_Local; fHost = true;
    ControlRate = 1;
}

References C4GameControlNetwork::Clear(), C4Game::Clients, CM_Local, CM_Network, CM_Replay, ControlRate, eMode, fHost, C4PlayerInfoList::FixIDCounter(), Game, C4ClientList::getLocal(), C4Game::HaltCount, C4GameOverDlg::IsShown(), Network, C4Game::PlayerInfos, pPlayback, C4ClientList::RemoveRemote(), and C4Client::SetActivated().

Referenced by Clear(), C4Network2::Clear(), and Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

Clear()

void C4GameControl::Clear

(

)

Definition at line 203 of file C4GameControl.cpp.

{
    StopRecord();
    ChangeToLocal();
    Default();
}

References ChangeToLocal(), Default(), and StopRecord().

Referenced by C4Game::Clear(), Execute(), and ~C4GameControl().

Here is the call graph for this function:

Here is the caller graph for this function:

ClientID()

int32_t C4GameControl::ClientID ( ) const

inline

Definition at line 102 of file C4GameControl.h.

{ return iClientID; }

References iClientID.

Referenced by C4Game::Abort(), C4ClientPlayerInfos::C4ClientPlayerInfos(), C4PlayerList::GetAtRemoteClient(), C4ControlPacket::LocalControl(), C4PlayerInfoList::LocalJoinUnjoinedPlayersInQueue(), C4Network2::OpenVoteDialog(), C4PlayerInfoList::RecreatePlayers(), and C4Network2::Vote().

Here is the caller graph for this function:

CtrlTickReached()

bool C4GameControl::CtrlTickReached

(

int32_t

iTick

)

Definition at line 345 of file C4GameControl.cpp.

{
    // 1. control tick reached?
    if (ControlTick < iTick) return false;
    // 2. control tick?
    if (Game.FrameCounter % ControlRate) return false;
    // ok then
    return true;
}

References ControlRate, ControlTick, C4Game::FrameCounter, and Game.

Referenced by C4Network2::CheckStatusReached().

Here is the caller graph for this function:

DbgRec()

void C4GameControl::DbgRec	(	C4RecordChunkType	eType,
		const uint8_t *	pData = nullptr,
		size_t	iSize = 0
	)

Definition at line 416 of file C4GameControl.cpp.

{
    if (Config.General.DebugRec)
    {
        if (DoNoDebugRec>0) return;
        // record data
        if (pRecord)
        {
            C4PktDebugRec dr(eType, StdBuf(pData, iSize));
            pRecord->Rec(Game.FrameCounter, DecompileToBuf<StdCompilerBinWrite>(dr), eType);
        }
        // check against playback
        if (pPlayback)
            pPlayback->Check(eType, pData, iSize);
    }
}

References C4Playback::Check(), Config, C4ConfigGeneral::DebugRec, DoNoDebugRec, C4Game::FrameCounter, Game, C4Config::General, iSize, pPlayback, pRecord, and C4Record::Rec().

Referenced by AddDbgRec().

Here is the call graph for this function:

Here is the caller graph for this function:

DecideControlDelivery()

C4ControlDeliveryType C4GameControl::DecideControlDelivery

(

)

Definition at line 433 of file C4GameControl.cpp.

{
    // network
    if (eMode == CM_Network)
        return Network.DecideControlDelivery();
    // use direct
    return CDT_Direct;
}

References CDT_Direct, CM_Network, C4GameControlNetwork::DecideControlDelivery(), eMode, and Network.

Referenced by DoInput().

Here is the call graph for this function:

Here is the caller graph for this function:

Default()

void C4GameControl::Default

(

)

Definition at line 210 of file C4GameControl.cpp.

{
    Input.Clear();
    Network.Clear();
    eMode = CM_None;
    fHost = fInitComplete = false;
    iClientID = C4ClientIDUnknown;
    pRecord = nullptr;
    pPlayback = nullptr;
    SyncChecks.Clear();
    ControlRate = Clamp<int>(Config.Network.ControlRate, 1, C4MaxControlRate);
    ControlTick = 0;
    SyncRate = C4SyncCheckRate;
    DoSync = false;
    fRecordNeeded = false;
    pExecutingControl = nullptr;
}

References C4ClientIDUnknown, C4MaxControlRate, C4SyncCheckRate, C4Control::Clear(), C4GameControlNetwork::Clear(), CM_None, Config, C4ConfigNetwork::ControlRate, ControlRate, ControlTick, DoSync, eMode, fHost, fInitComplete, fRecordNeeded, iClientID, Input, C4Config::Network, Network, pExecutingControl, pPlayback, pRecord, SyncChecks, and SyncRate.

Referenced by C4GameControl(), and Clear().

Here is the call graph for this function:

Here is the caller graph for this function:

DoInput()

void C4GameControl::DoInput	(	C4PacketType	eCtrlType,
		C4ControlPacket *	pPkt,
		C4ControlDeliveryType	eDelivery
	)

Definition at line 382 of file C4GameControl.cpp.

{
    assert(fInitComplete || pPkt->Lobby());
 
    // check if the control can be executed
    if (eDelivery == CDT_Direct || eDelivery == CDT_Private)
        assert(!pPkt->Sync());
 
    // decide control type
    if (eDelivery == CDT_Decide)
        eDelivery = DecideControlDelivery();
 
    // queue?
    if (eDelivery == CDT_Queue)
    {
        // add, will be executed/sent later
        Input.Add(eCtrlType, pPkt);
        return;
    }
 
    // Network?
    if (isNetwork())
    {
        Network.DoInput(eCtrlType, pPkt, eDelivery);
    }
    else
    {
        // Local mode: execute at once
        ExecControlPacket(eCtrlType, pPkt);
        delete pPkt;
    }
 
}

References C4Control::Add(), CDT_Decide, CDT_Direct, CDT_Private, CDT_Queue, DecideControlDelivery(), C4GameControlNetwork::DoInput(), ExecControlPacket(), fInitComplete, Input, isNetwork(), C4ControlPacket::Lobby(), Network, and C4ControlPacket::Sync().

Referenced by AdjustControlRate(), C4ClientList::CtrlRemove(), C4Network2::DeactivateInactiveClients(), C4PlayerInfoList::DoLocalNonNetworkPlayerInfoUpdate(), DoSyncCheck(), C4Game::DropDef(), C4EditCursor::EMControl(), C4Network2::Execute(), C4Network2::HandleActivateReq(), C4Network2Players::HandlePlayerInfoUpdRequest(), C4Console::In(), C4Network2::Join(), C4ChatInputDialog::OnChatCancel(), C4ChatInputDialog::OnChatInput(), C4GameLobby::MainDlg::OnReadyCheck(), C4MessageInput::ProcessCommand(), C4MessageInput::ProcessInput(), C4Network2::RequestActivate(), RequestRuntimeRecord(), C4Network2::SendJoinData(), C4TeamList::SendSetTeamColors(), C4TeamList::SendSetTeamDist(), C4Network2Players::SendUpdatedPlayers(), C4ToolsDlg::SetLandscapeMode(), and C4Network2::Vote().

Here is the call graph for this function:

Here is the caller graph for this function:

DoSyncCheck()

void C4GameControl::DoSyncCheck

(

)

Definition at line 442 of file C4GameControl.cpp.

{
    // only once
    if (!DoSync) return;
    DoSync = false;
    // create sync check
    C4ControlSyncCheck *pSyncCheck = new C4ControlSyncCheck();
    pSyncCheck->Set();
    // host?
    if (fHost)
        // add sync check to control queue or send it directly if the queue isn't active
        DoInput(CID_SyncCheck, pSyncCheck, fActivated ? CDT_Queue : CDT_Direct);
    else
    {
        // already have sync check?
        C4ControlSyncCheck* pSyncCheck2 = GetSyncCheck(Game.FrameCounter);
        if (!pSyncCheck2)
            // add to sync check array
            SyncChecks.Add(CID_SyncCheck, pSyncCheck);
        else
        {
            // check
            pSyncCheck->Execute();
            delete pSyncCheck;
        }
    }
    // remove old
    RemoveOldSyncChecks();
}

References C4Control::Add(), C4ControlSyncCheck, CDT_Direct, CDT_Queue, CID_SyncCheck, DoInput(), DoSync, C4ControlPacket::Execute(), fActivated, fHost, C4Game::FrameCounter, Game, GetSyncCheck(), RemoveOldSyncChecks(), C4ControlSyncCheck::Set(), and SyncChecks.

Referenced by C4Game::Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ExecControl()

void C4GameControl::ExecControl

(

const C4Control &

rCtrl

)

Definition at line 472 of file C4GameControl.cpp.

{
    // nothing to do?
    if (!rCtrl.firstPkt()) return;
    // execute it
    if (!rCtrl.PreExecute()) Log("Control: PreExecute failed for sync control!");
    rCtrl.Execute();
    // record
    if (pRecord)
        pRecord->Rec(rCtrl, Game.FrameCounter);
}

References C4Control::Execute(), C4Control::firstPkt(), C4Game::FrameCounter, Game, Log(), pRecord, C4Control::PreExecute(), and C4Record::Rec().

Referenced by C4GameControlNetwork::ExecQueuedSyncCtrl(), and C4GameControlNetwork::ExecSyncControl().

Here is the call graph for this function:

Here is the caller graph for this function:

ExecControlPacket()

void C4GameControl::ExecControlPacket	(	C4PacketType	eCtrlType,
		class C4ControlPacket *	pPkt
	)

Definition at line 484 of file C4GameControl.cpp.

{
    // execute it
    if (!pPkt->PreExecute()) Log("Control: PreExecute failed for direct control!");
    pPkt->Execute();
    // record it
    if (pRecord)
        pRecord->Rec(eCtrlType, pPkt, Game.FrameCounter);
}

References C4ControlPacket::Execute(), C4Game::FrameCounter, Game, Log(), pRecord, C4ControlPacket::PreExecute(), and C4Record::Rec().

Referenced by C4Playback::Check(), DoInput(), C4GameControlNetwork::DoInput(), and C4GameControlNetwork::HandleControlPkt().

Here is the call graph for this function:

Here is the caller graph for this function:

Execute()

void C4GameControl::Execute

(

)

Definition at line 273 of file C4GameControl.cpp.

{
    // Execute all available control
 
    assert(fInitComplete);
 
    // control tick? replay must always be executed.
    if (!isReplay() && Game.FrameCounter % ControlRate)
        return;
 
    // Get control
    C4Control Control;
    if (eMode == CM_Local)
    {
        // control = input
        PrepareInput(); // add per-controlframe input
        Control.Take(Input);
    }
    if (eMode == CM_Network)
    {
        // control = network input
        if (!Network.GetControl(&Control, ControlTick))
        {
            LogFatal("Network: could not retrieve control from C4GameControlNetwork!");
            return;
        }
    }
    if (eMode == CM_Replay)
    {
        if (!pPlayback) { ChangeToLocal(); return; }
        // control = replay data
        pPlayback->ExecuteControl(&Control, Game.FrameCounter);
    }
 
    // Record: Save ctrl
    if (pRecord)
        pRecord->Rec(Control, Game.FrameCounter);
 
    // debug: recheck PreExecute
    assert(Control.PreExecute());
 
    // execute
    pExecutingControl = &Control;
    Control.Execute();
    Control.Clear();
    pExecutingControl = nullptr;
 
    // statistics record
    if (Game.pNetworkStatistics) Game.pNetworkStatistics->ExecuteControlFrame();
 
}

References ChangeToLocal(), Clear(), CM_Local, CM_Network, CM_Replay, Control, ControlRate, ControlTick, eMode, Execute(), C4Playback::ExecuteControl(), fInitComplete, C4Game::FrameCounter, Game, C4GameControlNetwork::GetControl(), Input, isReplay(), LogFatal(), Network, pExecutingControl, C4Game::pNetworkStatistics, pPlayback, pRecord, PrepareInput(), and C4Record::Rec().

Referenced by Execute(), and C4Game::Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

getClient() [1/2]

C4GameControlClient* C4GameControl::getClient

(

const char *

szName

)

getClient() [2/2]

C4GameControlClient* C4GameControl::getClient

(

int32_t

iID

)

getCtrlTick()

int32_t C4GameControl::getCtrlTick

(

int32_t

iFrame

)

const

Definition at line 355 of file C4GameControl.cpp.

{
    // returns control tick by frame. Note this is a guess, as the control rate
    // can always change, so don't rely on the return value too much.
 
    return iFrame / ControlRate + ControlTick - Game.FrameCounter / ControlRate;
}

References ControlRate, ControlTick, C4Game::FrameCounter, and Game.

getNextControlTick()

int32_t C4GameControl::getNextControlTick

(

)

const

Definition at line 363 of file C4GameControl.cpp.

{
    return ControlTick + (Game.FrameCounter % ControlRate ? 1 : 0);
}

References ControlRate, ControlTick, C4Game::FrameCounter, and Game.

Referenced by C4Network2::CreateDynamic(), C4GameControlNetwork::Init(), C4Network2::InitHost(), C4Network2::Pause(), C4GameControlNetwork::SetActivated(), and C4Network2::Sync().

Here is the caller graph for this function:

GetRecord()

C4Record* C4GameControl::GetRecord ( )

inline

Definition at line 101 of file C4GameControl.h.

{ return pRecord; }

References pRecord.

Referenced by LogSilent().

Here is the caller graph for this function:

GetSyncCheck()

C4ControlSyncCheck * C4GameControl::GetSyncCheck ( int32_t  iTick )

protected

Definition at line 494 of file C4GameControl.cpp.

{
    for (C4IDPacket *pPkt = SyncChecks.firstPkt(); pPkt; pPkt = SyncChecks.nextPkt(pPkt))
    {
        // should be a sync check
        if (pPkt->getPktType() != CID_SyncCheck) continue;
        // get sync check
        C4ControlSyncCheck *pCheck = static_cast<C4ControlSyncCheck *>(pPkt->getPkt());
        // packet that's searched for?
        if (pCheck->getFrame() == iTick)
            return pCheck;
    }
    return nullptr;
}

References CID_SyncCheck, C4Control::firstPkt(), C4ControlSyncCheck::getFrame(), C4Control::nextPkt(), and SyncChecks.

Referenced by DoSyncCheck().

Here is the call graph for this function:

Here is the caller graph for this function:

InitLocal()

bool C4GameControl::InitLocal

(

C4Client *

pLocal

)

Definition at line 47 of file C4GameControl.cpp.

{
    eMode = CM_Local; fInitComplete = true;
    fHost = true; iClientID = pLocal->getID();
    ControlRate = 1;
    // ok
    return true;
}

References CM_Local, ControlRate, eMode, fHost, fInitComplete, C4Client::getID(), and iClientID.

Referenced by C4Game::InitControl().

Here is the call graph for this function:

Here is the caller graph for this function:

InitNetwork()

bool C4GameControl::InitNetwork

(

C4Client *

pLocal

)

Definition at line 56 of file C4GameControl.cpp.

{
    // network should already be initialized (by C4Network2)
    if (!Network.IsEnabled())
        return false;
    // set mode
    eMode = CM_Network; fInitComplete = true;
    fHost = pLocal->isHost(); iClientID = pLocal->getID();
    // control rate by parameters
    ControlRate = Game.Parameters.ControlRate;
    // ok
    return true;
}

References CM_Network, ControlRate, C4GameParameters::ControlRate, eMode, fHost, fInitComplete, Game, C4Client::getID(), iClientID, C4GameControlNetwork::IsEnabled(), C4Client::isHost(), Network, and C4Game::Parameters.

Referenced by C4Game::InitControl(), C4Game::InitNetworkFromReference(), and C4Game::InitNetworkHost().

Here is the call graph for this function:

Here is the caller graph for this function:

InitReplay()

bool C4GameControl::InitReplay

(

C4Group &

rGroup

)

Definition at line 70 of file C4GameControl.cpp.

{
    // open replay
    pPlayback = new C4Playback();
    if (!pPlayback->Open(rGroup))
    {
        LogFatal(LoadResStr("IDS_ERR_REPLAYREAD"));
        delete pPlayback; pPlayback = nullptr;
        return false;
    }
    // set mode
    eMode = CM_Replay; fInitComplete = true;
    fHost = false; iClientID = C4ClientIDUnknown;
    // control rate by parameters
    ControlRate = Game.Parameters.ControlRate;
    // just in case
    StopRecord();
    // ok
    return true;
}

References C4ClientIDUnknown, CM_Replay, ControlRate, C4GameParameters::ControlRate, eMode, fHost, fInitComplete, Game, iClientID, LoadResStr(), LogFatal(), C4Playback::Open(), C4Game::Parameters, pPlayback, and StopRecord().

Referenced by C4Game::InitControl().

Here is the call graph for this function:

Here is the caller graph for this function:

isCtrlHost()

bool C4GameControl::isCtrlHost ( ) const

inline

Definition at line 99 of file C4GameControl.h.

{ return fHost; }

References fHost.

Referenced by C4Game::Abort(), AdjustControlRate(), C4GameOverDlg::C4GameOverDlg(), C4TeamList::CanLocalChooseTeam(), ConsoleDlgProc(), C4EditCursor::Delete(), C4PlayerInfoList::DoPlayerInfoUpdate(), C4MessageInput::ProcessCommand(), C4TeamList::ReassignAllTeams(), C4TeamList::RecheckTeams(), C4TeamList::SendSetTeamDist(), C4TeamList::SetTeamColors(), and C4TeamList::SetTeamDistribution().

Here is the caller graph for this function:

isLocal()

bool C4GameControl::isLocal ( ) const

inline

Definition at line 96 of file C4GameControl.h.

{ return eMode == CM_Local; }

References CM_Local, and eMode.

isNetwork()

bool C4GameControl::isNetwork ( ) const

inline

Definition at line 97 of file C4GameControl.h.

{ return eMode == CM_Network; }

References CM_Network, and eMode.

Referenced by C4ClientPlayerInfos::C4ClientPlayerInfos(), C4Network2::Clear(), DoInput(), C4PlayerInfoList::DoPlayerInfoUpdate(), C4ControlJoinPlayer::PreExecute(), and C4MessageInput::ProcessCommand().

Here is the caller graph for this function:

isRecord()

bool C4GameControl::isRecord ( ) const

inline

Definition at line 100 of file C4GameControl.h.

{ return !! pRecord; }

References pRecord.

Referenced by C4Game::Evaluate(), IsRuntimeRecordPossible(), RecAddFile(), and C4PlayerInfoList::RecreatePlayers().

Here is the caller graph for this function:

isReplay()

bool C4GameControl::isReplay ( ) const

inline

Definition at line 98 of file C4GameControl.h.

{ return eMode == CM_Replay; }

References CM_Replay, and eMode.

Referenced by Execute(), C4Game::GameOverCheck(), C4MouseControl::IsPassive(), IsRuntimeRecordPossible(), NoInput(), C4PlayerInfoList::RestoreSavegameInfos(), C4PlayerList::Retire(), and C4Game::Synchronize().

Here is the caller graph for this function:

IsRuntimeRecordPossible()

bool C4GameControl::IsRuntimeRecordPossible

(

)

const

Definition at line 185 of file C4GameControl.cpp.

{
    // already requested?
    if (fRecordNeeded) return false;
    // not from replay
    if (isReplay()) return false;
    // not if recording already
    if (isRecord()) return false;
    // Record OK
    return true;
}

References fRecordNeeded, isRecord(), and isReplay().

Referenced by C4Console::FileRecord(), and RequestRuntimeRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

KeyAdjustControlRate()

bool C4GameControl::KeyAdjustControlRate ( int32_t  iBy )

inline

Definition at line 140 of file C4GameControl.h.

    { AdjustControlRate(iBy); return true; }

References AdjustControlRate().

Referenced by C4Game::InitKeyboard().

Here is the call graph for this function:

Here is the caller graph for this function:

NoInput()

bool C4GameControl::NoInput ( ) const

inline

Definition at line 105 of file C4GameControl.h.

{ return isReplay(); }

References isReplay().

Referenced by C4ConsoleGUI::EnableControls(), and C4Game::InitPlayers().

Here is the call graph for this function:

Here is the caller graph for this function:

OnGameSynchronizing()

void C4GameControl::OnGameSynchronizing

(

)

Definition at line 125 of file C4GameControl.cpp.

{
    // start record if desired
    if (fRecordNeeded)
    {
        fRecordNeeded = false;
        StartRecord(false, false);
    }
}

References fRecordNeeded, and StartRecord().

Referenced by C4Game::Synchronize().

Here is the call graph for this function:

Here is the caller graph for this function:

Prepare()

bool C4GameControl::Prepare

(

)

Definition at line 228 of file C4GameControl.cpp.

{
    assert(fInitComplete);
 
    // Prepare control, return true if everything is ready for GameGo.
    bool is_input_prepared = false;
 
    switch (eMode)
    {
        // full steam ahead
    case CM_Local: case CM_Replay:
        return true;
 
    case CM_Network:
 
        Network.Execute();
 
        // deactivated and got control: request activate
        if (Input.firstPkt() && !Game.Clients.getLocal()->isActivated())
            ::Network.RequestActivate();
 
        // needs input?
        while (Network.CtrlNeeded(Game.FrameCounter))
        {
            if (!is_input_prepared && Game.Clients.getLocal()->isActivated())
            {
                // add per-controlframe input
                PrepareInput();
                is_input_prepared = true;
            }
            Network.DoInput(Input);
            Input.Clear();
        }
 
        // control tick?
        if (Game.FrameCounter % ControlRate)
            return true;
 
        // check GameGo
        return Network.CtrlReady(ControlTick);
    default:
        return false;
    }
}

References C4Control::Clear(), C4Game::Clients, CM_Local, CM_Network, CM_Replay, ControlRate, ControlTick, C4GameControlNetwork::CtrlNeeded(), C4GameControlNetwork::CtrlReady(), C4GameControlNetwork::DoInput(), eMode, C4GameControlNetwork::Execute(), fInitComplete, C4Control::firstPkt(), C4Game::FrameCounter, Game, C4ClientList::getLocal(), Input, C4Client::isActivated(), Network, and PrepareInput().

Referenced by C4Game::Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

PrepareInput()

void C4GameControl::PrepareInput ( )

protected

Definition at line 524 of file C4GameControl.cpp.

{
    // add per-controlframe input
    ::MouseControl.DoMoveInput();
    if (Application.pGamePadControl) Application.pGamePadControl->DoAxisInput();
    // per-player input
    C4Player *plr; int32_t i=0;
    while ((plr = ::Players.GetLocalByIndex(i++)))
        plr->Control.PrepareInput();
}

References Application, C4Player::Control, C4GamePadControl::DoAxisInput(), C4MouseControl::DoMoveInput(), C4PlayerList::GetLocalByIndex(), MouseControl, C4Application::pGamePadControl, Players, and C4PlayerControl::PrepareInput().

Referenced by Execute(), and Prepare().

Here is the call graph for this function:

Here is the caller graph for this function:

RecAddFile()

bool C4GameControl::RecAddFile	(	const char *	szLocalFilename,
		const char *	szAddAs
	)

Definition at line 197 of file C4GameControl.cpp.

{
    if (!isRecord() || !pRecord) return false;
    return pRecord->AddFile(szLocalFilename, szAddAs);
}

References C4Record::AddFile(), isRecord(), and pRecord.

Referenced by C4PlayerInfoList::RecreatePlayers().

Here is the call graph for this function:

Here is the caller graph for this function:

RemoveOldSyncChecks()

void C4GameControl::RemoveOldSyncChecks ( )

protected

Definition at line 509 of file C4GameControl.cpp.

{
    C4IDPacket *pNext;
    for (C4IDPacket *pPkt = SyncChecks.firstPkt(); pPkt; pPkt = pNext)
    {
        pNext = SyncChecks.nextPkt(pPkt);
        // should be a sync check
        if (pPkt->getPktType() != CID_SyncCheck) continue;
        // remove?
        C4ControlSyncCheck *pCheck = static_cast<C4ControlSyncCheck *>(pPkt->getPkt());
        if (pCheck->getFrame() < Game.FrameCounter - C4SyncCheckMaxKeep)
            SyncChecks.Delete(pPkt);
    }
}

References C4SyncCheckMaxKeep, CID_SyncCheck, C4Control::Delete(), C4Control::firstPkt(), C4Game::FrameCounter, Game, C4ControlSyncCheck::getFrame(), C4Control::nextPkt(), and SyncChecks.

Referenced by DoSyncCheck().

Here is the call graph for this function:

Here is the caller graph for this function:

RequestRuntimeRecord()

void C4GameControl::RequestRuntimeRecord

(

)

Definition at line 175 of file C4GameControl.cpp.

{
    if (!IsRuntimeRecordPossible()) return; // cannot record
    fRecordNeeded = true;
    // request through a synchronize-call
    // currnetly do not request, but start record with next gamesync, so network runtime join can be debugged
    if (Config.General.DebugRec)
        ::Control.DoInput(CID_Synchronize, new C4ControlSynchronize(false, true), CDT_Queue);
}

References CDT_Queue, CID_Synchronize, Config, Control, C4ConfigGeneral::DebugRec, DoInput(), fRecordNeeded, C4Config::General, and IsRuntimeRecordPossible().

Referenced by C4Console::FileRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

SetActivated()

void C4GameControl::SetActivated

(

bool

fActivated

)

Definition at line 375 of file C4GameControl.cpp.

{
    fActivated = fnActivated;
    if (eMode == CM_Network)
        Network.SetActivated(fnActivated);
}

References CM_Network, eMode, fActivated, Network, and C4GameControlNetwork::SetActivated().

Here is the call graph for this function:

StartRecord()

bool C4GameControl::StartRecord	(	bool	fInitial,
		bool	fStreaming
	)

Definition at line 135 of file C4GameControl.cpp.

{
    assert(fInitComplete);
    // already recording?
    if (pRecord) StopRecord();
    // start
    pRecord = new C4Record();
    if (!pRecord->Start(fInitial))
    {
        delete pRecord; pRecord = nullptr;
        return false;
    }
    // streaming
    if (fStreaming)
    {
        if (!pRecord->StartStreaming(fInitial) ||
            !::Network.StartStreaming(pRecord))
        {
            delete pRecord; pRecord = nullptr;
            return false;
        }
    }
    // runtime records executed through queue: Must record initial control
    if (pExecutingControl)
        pRecord->Rec(*pExecutingControl, Game.FrameCounter);
    // ok
    return true;
}

References fInitComplete, C4Game::FrameCounter, Game, Network, pExecutingControl, pRecord, C4Record::Rec(), C4Record::Start(), C4Record::StartStreaming(), and StopRecord().

Referenced by C4Game::InitControl(), and OnGameSynchronizing().

Here is the call graph for this function:

Here is the caller graph for this function:

StopRecord()

void C4GameControl::StopRecord	(	StdStrBuf *	pRecordName = nullptr,
		BYTE *	pRecordSHA1 = nullptr
	)

Definition at line 164 of file C4GameControl.cpp.

{
    if (pRecord)
    {
        ::Network.FinishStreaming();
        pRecord->Stop(pRecordName, pRecordSHA1);
        // just delete
        delete pRecord; pRecord = nullptr;
    }
}

References Network, pRecord, and C4Record::Stop().

Referenced by Clear(), C4Game::Evaluate(), InitReplay(), and StartRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

SyncMode()

bool C4GameControl::SyncMode ( ) const

inline

Definition at line 103 of file C4GameControl.h.

{ return eMode != CM_Local || pRecord; }

References CM_Local, eMode, and pRecord.

Ticks()

void C4GameControl::Ticks

(

)

Definition at line 325 of file C4GameControl.cpp.

{
    assert(fInitComplete);
 
    if (!(Game.FrameCounter % ControlRate))
        ControlTick++;
    if (!(Game.FrameCounter % SyncRate))
        DoSync = true;
 
    // calc next tick without waiting for timer? (catchup cases)
    if (eMode == CM_Network)
        if (Network.CtrlOverflow(ControlTick))
        {
            Game.GameGo = true;
            if (Network.GetBehind(ControlTick) >= 25)
                if (Game.FrameCounter % ((Network.GetBehind(ControlTick) + 15) / 20))
                    Game.DoSkipFrame = true;
        }
}

References CM_Network, ControlRate, ControlTick, C4GameControlNetwork::CtrlOverflow(), C4Game::DoSkipFrame, DoSync, eMode, fInitComplete, C4Game::FrameCounter, Game, C4Game::GameGo, C4GameControlNetwork::GetBehind(), Network, and SyncRate.

Referenced by C4Game::Ticks().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

C4ControlSyncCheck

friend class C4ControlSyncCheck

friend

Definition at line 59 of file C4GameControl.h.

Referenced by DoSyncCheck().

C4GameControlNetwork

friend class C4GameControlNetwork

friend

Definition at line 60 of file C4GameControl.h.

Member Data Documentation

ControlRate

int32_t C4GameControl::ControlRate

Definition at line 88 of file C4GameControl.h.

Referenced by ChangeToLocal(), CtrlTickReached(), Default(), C4Network2::DrawStatus(), Execute(), C4GameControlNetwork::Execute(), C4Network2Stats::ExecuteControlFrame(), getCtrlTick(), getNextControlTick(), C4Network2::HandleJoinData(), InitLocal(), InitNetwork(), InitReplay(), Prepare(), Ticks(), and C4Network2ClientListDlg::Update().

ControlTick

int32_t C4GameControl::ControlTick

Definition at line 89 of file C4GameControl.h.

Referenced by C4GameControlNetwork::AddClient(), C4GameControlNetwork::CheckCompleteCtrl(), C4Network2::CheckStatusReached(), C4Game::CompileFunc(), CtrlTickReached(), Default(), C4GameControlNetwork::DoInput(), C4Network2::DrawStatus(), C4GameControlNetwork::ExecQueuedSyncCtrl(), C4GameControlNetwork::ExecSyncControl(), Execute(), C4Network2::Execute(), getCtrlTick(), getNextControlTick(), C4GameControlNetwork::Init(), C4Network2::InitHost(), C4Network2::OnClientDisconnect(), Prepare(), C4Network2::SendJoinData(), C4ControlSyncCheck::Set(), C4GameControlNetwork::SetCtrlMode(), C4Network2::SetCtrlMode(), C4Network2::Start(), Ticks(), C4Network2ClientListDlg::Update(), and C4Network2::UpdateChaseTarget().

DoSync

bool C4GameControl::DoSync

Definition at line 91 of file C4GameControl.h.

Referenced by Default(), DoSyncCheck(), and Ticks().

eMode

C4ControlMode C4GameControl::eMode

protected

Definition at line 70 of file C4GameControl.h.

Referenced by ChangeToLocal(), DecideControlDelivery(), Default(), Execute(), InitLocal(), InitNetwork(), InitReplay(), isLocal(), isNetwork(), isReplay(), Prepare(), SetActivated(), SyncMode(), and Ticks().

fActivated

bool C4GameControl::fActivated

protected

Definition at line 73 of file C4GameControl.h.

Referenced by DoSyncCheck(), and SetActivated().

fHost

bool C4GameControl::fHost

protected

Definition at line 72 of file C4GameControl.h.

Referenced by ChangeToLocal(), Default(), DoSyncCheck(), InitLocal(), InitNetwork(), InitReplay(), and isCtrlHost().

fInitComplete

bool C4GameControl::fInitComplete

protected

Definition at line 71 of file C4GameControl.h.

Referenced by Default(), DoInput(), Execute(), InitLocal(), InitNetwork(), InitReplay(), Prepare(), StartRecord(), and Ticks().

fRecordNeeded

bool C4GameControl::fRecordNeeded

protected

Definition at line 74 of file C4GameControl.h.

Referenced by Default(), IsRuntimeRecordPossible(), OnGameSynchronizing(), and RequestRuntimeRecord().

iClientID

int32_t C4GameControl::iClientID

protected

Definition at line 75 of file C4GameControl.h.

Referenced by ClientID(), Default(), InitLocal(), InitNetwork(), and InitReplay().

Input

C4Control C4GameControl::Input

Definition at line 66 of file C4GameControl.h.

Referenced by ConsoleDlgProc(), Default(), DoInput(), Execute(), and Prepare().

Network

C4GameControlNetwork C4GameControl::Network

Definition at line 67 of file C4GameControl.h.

Referenced by C4Network2IO::CallHandlers(), ChangeToLocal(), DecideControlDelivery(), Default(), DoInput(), Execute(), C4Network2::InitHost(), InitNetwork(), C4Network2ResList::OnResComplete(), Prepare(), SetActivated(), StartRecord(), StopRecord(), Ticks(), and C4Network2ClientListDlg::Update().

pClients

C4GameControlClient* C4GameControl::pClients

protected

Definition at line 82 of file C4GameControl.h.

pExecutingControl

C4Control* C4GameControl::pExecutingControl

protected

Definition at line 84 of file C4GameControl.h.

Referenced by Default(), Execute(), and StartRecord().

pPlayback

C4Playback* C4GameControl::pPlayback

protected

Definition at line 78 of file C4GameControl.h.

Referenced by ChangeToLocal(), DbgRec(), Default(), Execute(), and InitReplay().

pRecord

C4Record* C4GameControl::pRecord

protected

Definition at line 77 of file C4GameControl.h.

Referenced by DbgRec(), Default(), ExecControl(), ExecControlPacket(), Execute(), GetRecord(), isRecord(), RecAddFile(), StartRecord(), StopRecord(), and SyncMode().

SyncChecks

C4Control C4GameControl::SyncChecks

protected

Definition at line 80 of file C4GameControl.h.

Referenced by Default(), DoSyncCheck(), GetSyncCheck(), and RemoveOldSyncChecks().

SyncRate

int32_t C4GameControl::SyncRate

Definition at line 90 of file C4GameControl.h.

Referenced by C4Game::CompileFunc(), Default(), and Ticks().

---

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

• C4GameControl.h
• C4GameControl.cpp