C4ClientPlayerInfos Class Reference

#include <C4PlayerInfo.h>

Public Member Functions
	C4ClientPlayerInfos (const char *szJoinFilenames=nullptr, bool fAdd=false, C4PlayerInfo *pAddInfo=nullptr)
	C4ClientPlayerInfos (const C4ClientPlayerInfos &rCopy)
	~C4ClientPlayerInfos ()
C4ClientPlayerInfos &	operator= (const C4ClientPlayerInfos &rCopy)
void	Clear ()
void	GrabMergeFrom (C4ClientPlayerInfos &rFrom)
void	AddInfo (C4PlayerInfo *pAddInfo)
void	RemoveIndexedInfo (int32_t iAtIndex)
void	RemoveInfo (int32_t idPlr)
void	SetUpdated ()
bool	IsUpdated ()
void	ResetUpdated ()
void	SetAdd ()
void	ResetAdd ()
int32_t	GetPlayerCount () const
int32_t	GetFlaggedPlayerCount (DWORD dwFlag) const
C4PlayerInfo *	GetPlayerInfo (int32_t iIndex) const
C4PlayerInfo *	GetPlayerInfo (int32_t iIndex, C4PlayerType eType) const
C4PlayerInfo *	GetPlayerInfoByID (int32_t id) const
C4PlayerInfo *	GetPlayerInfoByRes (int32_t idResID) const
int32_t	GetClientID () const
bool	HasUnjoinedPlayers () const
int32_t	GetJoinedPlayerCount () const
bool	IsAddPacket () const
bool	IsInitialPacket () const
bool	IsDeveloperPacket () const
void	LoadResources ()
void	CompileFunc (StdCompiler *pComp)

Detailed Description

Definition at line 208 of file C4PlayerInfo.h.

Constructor & Destructor Documentation

C4ClientPlayerInfos() [1/2]

C4ClientPlayerInfos::C4ClientPlayerInfos	(	const char *	szJoinFilenames = nullptr,
		bool	fAdd = false,
		C4PlayerInfo *	pAddInfo = nullptr
	)

Definition at line 372 of file C4PlayerInfo.cpp.

{
    // init for local client?
    if (szJoinFilenames || pAddInfo)
    {
        // set developer flag for developer hosts
        if (SSearch(Config.GetRegistrationData("Type"), "Developer"))
            dwFlags |= CIF_Developer;
        // set local ID
        iClientID = ::Control.ClientID();
        // maybe control is not preinitialized
        if (!::Control.isNetwork() && iClientID < 0) iClientID = 0;
        // join packet or initial packet?
        if (fAdd)
            // packet is to be added to other players
            dwFlags |= CIF_AddPlayers;
        else
            // set initial flag for first-time join packet
            dwFlags |= CIF_Initial;
        // join all players in list
        if ((iPlayerCapacity = (szJoinFilenames ? SModuleCount(szJoinFilenames) : 0) + !!pAddInfo))
        {
            ppPlayers = new C4PlayerInfo *[iPlayerCapacity];
            if (szJoinFilenames)
            {
                char szPlrFile[_MAX_PATH_LEN];
                for (int32_t i=0; i<iPlayerCapacity; ++i)
                    if (SGetModule(szJoinFilenames, i, szPlrFile, _MAX_PATH))
                    {
                        C4PlayerInfo *pNewInfo = new C4PlayerInfo();
                        if (pNewInfo->LoadFromLocalFile(szPlrFile))
                        {
                            // player def loaded; register and count it
                            ppPlayers[iPlayerCount++] = pNewInfo;
                        }
                        else
                        {
                            // loading failure; clear info class
                            delete pNewInfo;
                            // 
                            Log(FormatString(LoadResStr("IDS_ERR_LOAD_PLAYER"), szPlrFile).getData());
                        }
                    }
            }
            if (pAddInfo)
                ppPlayers[iPlayerCount++] = pAddInfo;
        }
    }
}

References _MAX_PATH, _MAX_PATH_LEN, C4GameControl::ClientID(), Config, Control, FormatString(), C4Config::GetRegistrationData(), C4GameControl::isNetwork(), C4PlayerInfo::LoadFromLocalFile(), LoadResStr(), Log(), SGetModule(), SModuleCount(), and SSearch().

Here is the call graph for this function:

C4ClientPlayerInfos() [2/2]

C4ClientPlayerInfos::C4ClientPlayerInfos

(

const C4ClientPlayerInfos &

rCopy

)

Definition at line 422 of file C4PlayerInfo.cpp.

{
    // copy fields
    iClientID = rCopy.iClientID;
    if ((iPlayerCount = rCopy.iPlayerCount))
    {
        // copy player infos
        ppPlayers = new C4PlayerInfo *[iPlayerCapacity = rCopy.iPlayerCapacity];
        int32_t i = iPlayerCount;
        C4PlayerInfo **ppCurrPlrInfo = ppPlayers, **ppSrcPlrInfo = rCopy.ppPlayers;
        while (i--) *ppCurrPlrInfo++ = new C4PlayerInfo(**ppSrcPlrInfo++);
    }
    // no players
    else
    {
        ppPlayers = nullptr;
        iPlayerCapacity = 0;
    }
    // misc fields
    dwFlags = rCopy.dwFlags;
}

~C4ClientPlayerInfos()

C4ClientPlayerInfos::~C4ClientPlayerInfos ( )

inline

Definition at line 233 of file C4PlayerInfo.h.

{ Clear(); }                   // dtor

References Clear().

Here is the call graph for this function:

Member Function Documentation

AddInfo()

void C4ClientPlayerInfos::AddInfo

(

C4PlayerInfo *

pAddInfo

)

Definition at line 508 of file C4PlayerInfo.cpp.

{
    // grow list if necessary
    if (iPlayerCount == iPlayerCapacity) GrowList(4);
    // add info
    ppPlayers[iPlayerCount++] = pAddInfo;
}

Referenced by C4PlayerInfoList::CreateRestoreInfosForJoinedScriptPlayers().

Here is the caller graph for this function:

Clear()

void C4ClientPlayerInfos::Clear

(

)

Definition at line 469 of file C4PlayerInfo.cpp.

{
    // del player infos
    int32_t i = iPlayerCount; C4PlayerInfo **ppCurrPlrInfo = ppPlayers;
    while (i--) delete *ppCurrPlrInfo++;
    // del player info vector
    delete [] ppPlayers; ppPlayers = nullptr;
    // reset other fields
    iPlayerCount = iPlayerCapacity = 0;
    iClientID=-1;
    dwFlags = 0;
}

Referenced by CompileFunc(), operator=(), and ~C4ClientPlayerInfos().

Here is the caller graph for this function:

CompileFunc()

void C4ClientPlayerInfos::CompileFunc

(

StdCompiler *

pComp

)

Definition at line 636 of file C4PlayerInfo.cpp.

{
    bool deserializing = pComp->isDeserializer();
    if (deserializing) Clear();
    pComp->Value(mkNamingAdapt(iClientID, "ID", C4ClientIDUnknown));
 
    // Flags
    StdBitfieldEntry<uint32_t> Entries[] =
    {
        { "AddPlayers", CIF_AddPlayers },
        { "Updated", CIF_Updated },
        { "Initial", CIF_Initial },
        { "Developer", CIF_Developer },
 
        { nullptr, 0 }
    };
    pComp->Value(mkNamingAdapt(mkBitfieldAdapt(dwFlags, Entries), "Flags", 0u));
 
    pComp->Value(mkNamingCountAdapt<int32_t>(iPlayerCount, "Player"));
    if (iPlayerCount < 0 || iPlayerCount > C4MaxPlayer)
        { pComp->excCorrupt("player count out of range"); return; }
    // Grow list, if necessary
    if (deserializing && iPlayerCount > iPlayerCapacity)
    {
        GrowList(iPlayerCount - iPlayerCapacity);
        ZeroMem(ppPlayers, sizeof(*ppPlayers) * iPlayerCount);
    }
    // Compile
    pComp->Value(mkNamingAdapt(mkArrayAdaptMap(ppPlayers, iPlayerCount, mkPtrAdaptNoNull<C4PlayerInfo>), "Player"));
    // Force specialization
    mkPtrAdaptNoNull<C4PlayerInfo>(*ppPlayers);
}

References C4ClientIDUnknown, C4MaxPlayer, Clear(), StdCompiler::excCorrupt(), StdCompiler::isDeserializer(), mkArrayAdaptMap(), mkBitfieldAdapt(), mkNamingAdapt(), StdCompiler::Value(), and ZeroMem().

Here is the call graph for this function:

GetClientID()

int32_t C4ClientPlayerInfos::GetClientID ( ) const

inline

Definition at line 257 of file C4PlayerInfo.h.

{ return iClientID; }       // get target client ID

Referenced by C4PlayerInfoList::AddInfo(), C4PlayerInfoList::GetActivePlayerNames(), C4Network2Players::GetLocalPlayerInfoPacket(), C4PlayerInfoList::GetPlayerInfoByID(), C4Network2Players::HandlePlayerInfo(), C4Network2Players::HandlePlayerInfoUpdRequest(), C4Network2Players::OnStatusGoReached(), C4MessageInput::ProcessCommand(), C4PlayerInfoList::RecreatePlayers(), and C4PlayerInfoList::SetAsRestoreInfos().

Here is the caller graph for this function:

GetFlaggedPlayerCount()

int32_t C4ClientPlayerInfos::GetFlaggedPlayerCount

(

DWORD

dwFlag

)

const

Definition at line 557 of file C4PlayerInfo.cpp.

{
    // check all players
    int32_t iCount = 0;
    int32_t i = iPlayerCount; C4PlayerInfo **ppCurrPlrInfo = ppPlayers;
    while (i--) if ((*ppCurrPlrInfo++)->GetFlags() | dwFlag)
            ++iCount;
    // return number of matching infos
    return iCount;
}

GetJoinedPlayerCount()

int32_t C4ClientPlayerInfos::GetJoinedPlayerCount

(

)

const

Definition at line 628 of file C4PlayerInfo.cpp.

{
    // count all players with IsJoined()
    int32_t i = iPlayerCount; int32_t cnt=0; C4PlayerInfo **ppCurrPlrInfo = ppPlayers;
    while (i--) if ((*ppCurrPlrInfo++)->IsJoined()) ++cnt;
    return cnt;
}

Referenced by C4Network2::OpenVoteDialog(), and C4PlayerInfoList::RecreatePlayers().

Here is the caller graph for this function:

GetPlayerCount()

int32_t C4ClientPlayerInfos::GetPlayerCount ( ) const

inline

Definition at line 251 of file C4PlayerInfo.h.

{ return iPlayerCount; } // get number of player infos available

Referenced by C4PlayerInfoList::AssignPlayerIDs(), C4PlayerInfoList::GetActivePlayerCount(), C4PlayerInfoList::GetActivePlayerNames(), C4PlayerInfoList::GetActiveScriptPlayerCount(), C4PlayerInfoList::GetJoinIssuedPlayerCount(), C4PlayerInfoList::GetJoinPendingPlayerCount(), C4Network2Players::HandlePlayerInfoUpdRequest(), C4Network2Players::JoinLocalPlayer(), C4Network2::OpenVoteDialog(), C4PlayerInfoList::RecreatePlayers(), and C4PlayerInfoList::SetAsRestoreInfos().

Here is the caller graph for this function:

GetPlayerInfo() [1/2]

C4PlayerInfo * C4ClientPlayerInfos::GetPlayerInfo

(

int32_t

iIndex

)

const

Definition at line 568 of file C4PlayerInfo.cpp.

{
    // check range
    if (iIndex<0 || iIndex>=iPlayerCount) return nullptr;
    // return indexed info
    return ppPlayers[iIndex];
}

Referenced by C4PlayerInfoList::AddInfo(), C4PlayerInfoList::AssignPlayerIDs(), C4PlayerInfoList::AssignTeams(), DisconnectData::CompileFunc(), C4PlayerInfoList::CreateRestoreInfosForJoinedScriptPlayers(), C4PlayerInfoList::FindUnassociatedRestoreInfo(), C4PlayerInfoList::GetActivePlayerCount(), C4PlayerInfoList::GetActivePlayerNames(), C4PlayerInfoList::GetActiveScriptPlayerCount(), C4Network2Players::GetClientChatColor(), C4PlayerInfoList::GetJoinIssuedPlayerCount(), C4PlayerInfoList::GetJoinPendingPlayerCount(), C4PlayerInfoList::GetPrimaryInfoByClientID(), C4Network2Players::HandlePlayerInfoUpdRequest(), C4PlayerInfoList::HasSameTeamPlayers(), C4Network2Reference::InitLocal(), C4Network2Players::JoinLocalPlayer(), C4Network2::LeagueNotifyDisconnect(), C4Network2::LeagueUpdateProcessReply(), C4PlayerInfoList::RecheckAutoGeneratedTeams(), C4PlayerInfoList::RecreatePlayerFiles(), C4PlayerInfoList::RecreatePlayers(), C4PlayerInfoList::RemoveUnassociatedPlayers(), C4PlayerInfoList::ResetLeagueProjectedGain(), C4PlayerInfoList::RestoreSavegameInfos(), C4PlayerInfoList::SetAsRestoreInfos(), C4GameLobby::MainDlg::Start(), and C4PlayerInfoList::UpdatePlayerAttributes().

Here is the caller graph for this function:

GetPlayerInfo() [2/2]

C4PlayerInfo * C4ClientPlayerInfos::GetPlayerInfo	(	int32_t	iIndex,
		C4PlayerType	eType
	)		const

Definition at line 576 of file C4PlayerInfo.cpp.

{
    // get indexed matching info
    for (int32_t iCheck=0; iCheck<iPlayerCount; ++iCheck)
    {
        C4PlayerInfo *pNfo = ppPlayers[iCheck];
        if (pNfo->GetType() == eType)
            if (!iIndex--)
                return pNfo;
    }
    // nothing found
    return nullptr;
}

References C4PlayerInfo::GetType().

Here is the call graph for this function:

GetPlayerInfoByID()

C4PlayerInfo * C4ClientPlayerInfos::GetPlayerInfoByID

(

int32_t

id

)

const

Definition at line 590 of file C4PlayerInfo.cpp.

{
    // check all infos
    int32_t i = iPlayerCount; C4PlayerInfo **ppCurrPlrInfo = ppPlayers;
    while (i--)
    {
        if ((*ppCurrPlrInfo)->GetID() == id) return *ppCurrPlrInfo;
        ++ppCurrPlrInfo;
    }
    // none matched
    return nullptr;
}

Referenced by C4Network2::LeagueUpdateProcessReply(), and C4MessageInput::ProcessCommand().

Here is the caller graph for this function:

GetPlayerInfoByRes()

C4PlayerInfo * C4ClientPlayerInfos::GetPlayerInfoByRes

(

int32_t

idResID

)

const

Definition at line 603 of file C4PlayerInfo.cpp.

{
    int32_t i = iPlayerCount; C4PlayerInfo **ppCurrPlrInfo = ppPlayers;
    C4Network2Res *pRes;
    while (i--)
    {
        if ((pRes = (*ppCurrPlrInfo)->GetRes()))
            if (pRes->getResID() == idResID)
                // only if the player is actually using the resource
                if ((*ppCurrPlrInfo)->IsUsingPlayerFile())
                    return *ppCurrPlrInfo;
        ++ppCurrPlrInfo;
    }
    return nullptr;
}

References C4Network2Res::getResID().

Referenced by C4Network2Players::HandlePlayerInfoUpdRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

GrabMergeFrom()

void C4ClientPlayerInfos::GrabMergeFrom

(

C4ClientPlayerInfos &

rFrom

)

Definition at line 482 of file C4PlayerInfo.cpp.

{
    // anything to grab?
    if (!rFrom.iPlayerCount) return;
    // any previous players to copy?
    if (iPlayerCount)
    {
        // buffer sufficient?
        if (iPlayerCount + rFrom.iPlayerCount > iPlayerCapacity)
            GrowList(rFrom.iPlayerCount);
        // merge into new buffer
        memcpy(ppPlayers + iPlayerCount, rFrom.ppPlayers, rFrom.iPlayerCount * sizeof(C4PlayerInfo *));
        iPlayerCount += rFrom.iPlayerCount;
        rFrom.iPlayerCount = rFrom.iPlayerCapacity = 0;
        delete [] rFrom.ppPlayers; rFrom.ppPlayers = nullptr;
    }
    else
    {
        // no own players: take over buffer of pFrom
        if (ppPlayers) delete [] ppPlayers;
        ppPlayers = rFrom.ppPlayers; rFrom.ppPlayers = nullptr;
        iPlayerCount = rFrom.iPlayerCount; rFrom.iPlayerCount = 0;
        iPlayerCapacity = rFrom.iPlayerCapacity; rFrom.iPlayerCapacity = 0;
    }
}

HasUnjoinedPlayers()

bool C4ClientPlayerInfos::HasUnjoinedPlayers

(

)

const

Definition at line 619 of file C4PlayerInfo.cpp.

{
    // check all players
    int32_t i = iPlayerCount; C4PlayerInfo **ppCurrPlrInfo = ppPlayers;
    while (i--) if (!(*ppCurrPlrInfo++)->HasJoined()) return true;
    // all joined
    return false;
}

Referenced by C4Network2Players::OnStatusGoReached().

Here is the caller graph for this function:

IsAddPacket()

bool C4ClientPlayerInfos::IsAddPacket ( ) const

inline

Definition at line 260 of file C4PlayerInfo.h.

{ return !!(dwFlags & CIF_AddPlayers); }  // return whether players are to be added to the current list (otherwise overwrite)

Referenced by C4PlayerInfoList::AddInfo(), and C4Network2Players::HandlePlayerInfoUpdRequest().

Here is the caller graph for this function:

IsDeveloperPacket()

bool C4ClientPlayerInfos::IsDeveloperPacket ( ) const

inline

Definition at line 262 of file C4PlayerInfo.h.

{ return !!(dwFlags & CIF_Developer); } // returns whether packet was created by a developer host - client side check only!

IsInitialPacket()

bool C4ClientPlayerInfos::IsInitialPacket ( ) const

inline

Definition at line 261 of file C4PlayerInfo.h.

{ return !!(dwFlags & CIF_Initial); } // returns whether this packet was sent as the first local-join packet

Referenced by C4Network2Players::HandlePlayerInfoUpdRequest().

Here is the caller graph for this function:

IsUpdated()

bool C4ClientPlayerInfos::IsUpdated ( )

inline

Definition at line 245 of file C4PlayerInfo.h.

{ return !!(dwFlags & CIF_Updated); }

Referenced by C4Network2Players::SendUpdatedPlayers().

Here is the caller graph for this function:

LoadResources()

void C4ClientPlayerInfos::LoadResources

(

)

Definition at line 669 of file C4PlayerInfo.cpp.

{
    // load for all players
    int32_t i = iPlayerCount; C4PlayerInfo **ppCurrPlrInfo = ppPlayers;
    while (i--) (*ppCurrPlrInfo++)->LoadResource();
}

operator=()

C4ClientPlayerInfos & C4ClientPlayerInfos::operator=

(

const C4ClientPlayerInfos &

rCopy

)

Definition at line 444 of file C4PlayerInfo.cpp.

{
    Clear();
    // copy fields
    iClientID = rCopy.iClientID;
    if ((iPlayerCount = rCopy.iPlayerCount))
    {
        // copy player infos
        ppPlayers = new C4PlayerInfo *[iPlayerCapacity = rCopy.iPlayerCapacity];
        int32_t i = iPlayerCount;
        C4PlayerInfo **ppCurrPlrInfo = ppPlayers, **ppSrcPlrInfo = rCopy.ppPlayers;
        while (i--) *ppCurrPlrInfo++ = new C4PlayerInfo(**ppSrcPlrInfo++);
    }
    // no players
    else
    {
        ppPlayers = nullptr;
        iPlayerCapacity = 0;
    }
    // misc fields
    dwFlags = rCopy.dwFlags;
    return *this;
}

References Clear().

Here is the call graph for this function:

RemoveIndexedInfo()

void C4ClientPlayerInfos::RemoveIndexedInfo

(

int32_t

iAtIndex

)

Definition at line 516 of file C4PlayerInfo.cpp.

{
    // bounds check
    if (iAtIndex<0 || iAtIndex>=iPlayerCount) return;
    // del player info at index
    delete ppPlayers[iAtIndex];
    // move down last index (may self-assign a ptr)
    ppPlayers[iAtIndex] = ppPlayers[--iPlayerCount];
}

Referenced by C4PlayerInfoList::AssignPlayerIDs(), C4Network2Players::HandlePlayerInfoUpdRequest(), C4Network2Players::JoinLocalPlayer(), RemoveInfo(), and C4PlayerInfoList::SetAsRestoreInfos().

Here is the caller graph for this function:

RemoveInfo()

void C4ClientPlayerInfos::RemoveInfo

(

int32_t

idPlr

)

Definition at line 526 of file C4PlayerInfo.cpp.

{
    // check all infos; remove the one that matches
    int32_t i = 0; C4PlayerInfo **ppCurrPlrInfo = ppPlayers;
    while (i < iPlayerCount)
    {
        if ((*ppCurrPlrInfo)->GetID() == idPlr)
        {
            RemoveIndexedInfo(i);
            return;
        }
        ++ppCurrPlrInfo; ++i;
    }
    // none matched
    return;
}

References RemoveIndexedInfo().

Here is the call graph for this function:

ResetAdd()

void C4ClientPlayerInfos::ResetAdd ( )

inline

Definition at line 248 of file C4PlayerInfo.h.

{ dwFlags &= ~CIF_AddPlayers; }

Referenced by C4PlayerInfoList::AddInfo().

Here is the caller graph for this function:

ResetUpdated()

void C4ClientPlayerInfos::ResetUpdated ( )

inline

Definition at line 246 of file C4PlayerInfo.h.

{ dwFlags &= ~CIF_Updated; }

Referenced by C4Network2Players::ResetUpdatedPlayers(), and C4Network2Players::SendUpdatedPlayers().

Here is the caller graph for this function:

SetAdd()

void C4ClientPlayerInfos::SetAdd ( )

inline

Definition at line 247 of file C4PlayerInfo.h.

{ dwFlags |= CIF_AddPlayers; }

SetUpdated()

void C4ClientPlayerInfos::SetUpdated ( )

inline

Definition at line 244 of file C4PlayerInfo.h.

{ dwFlags |= CIF_Updated; }

Referenced by C4Network2::LeagueUpdateProcessReply(), C4TeamList::ReassignAllTeams(), C4TeamList::RecheckTeams(), C4PlayerInfoList::ResetLeagueProjectedGain(), and C4PlayerInfoList::UpdatePlayerAttributes().

Here is the caller graph for this function:

---

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

• C4PlayerInfo.h
• C4PlayerInfo.cpp