C4Network2Reference Class Reference

#include <C4Network2Reference.h>

Collaboration diagram for C4Network2Reference:

Public Member Functions
	C4Network2Reference ()
	~C4Network2Reference ()
const C4Network2Address &	getAddr (int i) const
C4Network2Address &	getAddr (int i)
int	getAddrCnt () const
const char *	getTitle () const
int32_t	getIcon () const
C4Network2Status	getGameStatus () const
const char *	getComment () const
const C4GameVersion &	getGameVersion () const
bool	isPasswordNeeded () const
bool	isJoinAllowed () const
bool	isOfficialServer () const
int32_t	getSortOrder () const
int32_t	getTime () const
int32_t	getStartTime () const
StdStrBuf	getGameGoalString () const
bool	isEditor () const
C4NetpuncherID	getNetpuncherGameID () const
StdStrBuf	getNetpuncherAddr () const
void	SetSourceAddress (const C4NetIO::EndpointAddress &ip)
const C4NetIO::EndpointAddress &	GetSourceAddress () const
void	InitLocal ()
void	SortNullIPsBack ()
void	CompileFunc (StdCompiler *pComp)

Public Attributes
C4GameParameters	Parameters

Detailed Description

Definition at line 28 of file C4Network2Reference.h.

Constructor & Destructor Documentation

C4Network2Reference()

C4Network2Reference::C4Network2Reference

(

)

Definition at line 25 of file C4Network2Reference.cpp.

        :  GameMode(), NetpuncherGameID(C4NetpuncherID())
{
 
}

~C4Network2Reference()

C4Network2Reference::~C4Network2Reference ( )

default

Member Function Documentation

CompileFunc()

void C4Network2Reference::CompileFunc

(

StdCompiler *

pComp

)

Definition at line 100 of file C4Network2Reference.cpp.

{
    pComp->Value(mkNamingAdapt(Icon,              "Icon",             0));
    pComp->Value(mkNamingAdapt(Title,             "Title",            "No title"));
    pComp->Value(mkNamingAdapt(mkParAdapt(GameMode, StdCompiler::RCT_IdtfAllowEmpty), "GameMode", ""));
    pComp->Value(mkParAdapt(GameStatus, true));
    pComp->Value(mkNamingAdapt(Time,              "Time",             0));
    pComp->Value(mkNamingAdapt(Frame,             "Frame",            0));
    pComp->Value(mkNamingAdapt(StartTime,         "StartTime",        0));
    pComp->Value(mkNamingAdapt(LeaguePerformance, "LeaguePerformance",0));
    pComp->Value(mkNamingAdapt(Comment,           "Comment",          ""));
    pComp->Value(mkNamingAdapt(JoinAllowed,       "JoinAllowed",      true));
    pComp->Value(mkNamingAdapt(ObservingAllowed,  "ObservingAllowed", true));
    pComp->Value(mkNamingAdapt(PasswordNeeded,    "PasswordNeeded",   false));
    pComp->Value(mkNamingAdapt(IsEditor,          "IsEditor",         false));
    pComp->Value(mkNamingAdapt(mkIntPackAdapt(iAddrCnt), "AddressCount", 0));
    iAddrCnt = std::min<uint8_t>(C4ClientMaxAddr, iAddrCnt);
    pComp->Value(mkNamingAdapt(mkArrayAdapt(Addrs, iAddrCnt, C4Network2Address()), "Address"));
    pComp->Value(mkNamingAdapt(Game.sEngineName,      "Game",             "None"));
    pComp->Value(mkNamingAdapt(mkArrayAdaptDM(Game.iVer,0),"Version"    ));
    pComp->Value(mkNamingAdapt(OfficialServer,  "OfficialServer", false));
    pComp->Value(mkNamingAdapt(NetpuncherGameID,  "NetpuncherID", C4NetpuncherID(), false, false));
    pComp->Value(mkNamingAdapt(NetpuncherAddr,  "NetpuncherAddr", "", false, false));
    pComp->Value(mkNamingAdapt(mkParAdapt(Statistics, StdCompiler::RCT_All), "Statistics", "", false, false));
 
    pComp->Value(Parameters);
}

References C4ClientMaxAddr, C4GameVersion::iVer, mkArrayAdapt(), mkArrayAdaptDM(), mkIntPackAdapt(), mkNamingAdapt(), mkParAdapt(), Parameters, StdCompiler::RCT_All, StdCompiler::RCT_IdtfAllowEmpty, C4GameVersion::sEngineName, and StdCompiler::Value().

Here is the call graph for this function:

getAddr() [1/2]

C4Network2Address& C4Network2Reference::getAddr ( int  i )

inline

Definition at line 67 of file C4Network2Reference.h.

{ return Addrs[i]; }

getAddr() [2/2]

const C4Network2Address& C4Network2Reference::getAddr ( int  i ) const

inline

Definition at line 66 of file C4Network2Reference.h.

{ return Addrs[i]; }

Referenced by C4StartupNetListEntry::IsSameAddress(), and C4StartupNetListEntry::SetReference().

Here is the caller graph for this function:

getAddrCnt()

int C4Network2Reference::getAddrCnt ( ) const

inline

Definition at line 68 of file C4Network2Reference.h.

{ return iAddrCnt; }

Referenced by C4StartupNetListEntry::IsSameAddress(), and C4StartupNetListEntry::SetReference().

Here is the caller graph for this function:

getComment()

const char* C4Network2Reference::getComment ( ) const

inline

Definition at line 72 of file C4Network2Reference.h.

{ return Comment.getData(); }

References StdStrBuf::getData().

Referenced by C4StartupNetListEntry::KeywordMatch(), and C4StartupNetListEntry::SetReference().

Here is the call graph for this function:

Here is the caller graph for this function:

getGameGoalString()

StdStrBuf C4Network2Reference::getGameGoalString

(

)

const

Definition at line 146 of file C4Network2Reference.cpp.

{
    if (GameMode.getLength() > 0)
    {
        // Prefer to derive string from game mode
        return FormatString("%s: %s", LoadResStr("IDS_MENU_CPGOALS"), GameMode.getData());
    }
    else
    {
        // If not defined, fall back to goal string
        return Parameters.GetGameGoalString();
    }
}

References FormatString(), StdStrBuf::getData(), C4GameParameters::GetGameGoalString(), StdStrBuf::getLength(), LoadResStr(), and Parameters.

Referenced by C4StartupNetListEntry::SetReference().

Here is the call graph for this function:

Here is the caller graph for this function:

getGameStatus()

C4Network2Status C4Network2Reference::getGameStatus ( ) const

inline

Definition at line 71 of file C4Network2Reference.h.

{ return GameStatus; }

Referenced by C4StartupNetDlg::DoOK(), getSortOrder(), and C4StartupNetListEntry::SetReference().

Here is the caller graph for this function:

getGameVersion()

const C4GameVersion& C4Network2Reference::getGameVersion ( ) const

inline

Definition at line 73 of file C4Network2Reference.h.

{ return Game; }

References Game.

Referenced by C4StartupNetDlg::DoOK(), getSortOrder(), and C4StartupNetListEntry::SetReference().

Here is the caller graph for this function:

getIcon()

int32_t C4Network2Reference::getIcon ( ) const

inline

Definition at line 70 of file C4Network2Reference.h.

{ return Icon; }

Referenced by C4StartupNetListEntry::SetReference().

Here is the caller graph for this function:

getNetpuncherAddr()

StdStrBuf C4Network2Reference::getNetpuncherAddr ( ) const

inline

Definition at line 83 of file C4Network2Reference.h.

{ return NetpuncherAddr; }

getNetpuncherGameID()

C4NetpuncherID C4Network2Reference::getNetpuncherGameID ( ) const

inline

Definition at line 82 of file C4Network2Reference.h.

{ return NetpuncherGameID; }

getSortOrder()

int32_t C4Network2Reference::getSortOrder

(

)

const

Definition at line 128 of file C4Network2Reference.cpp.

{
    C4GameVersion verThis;
    int iOrder = 0;
    // Official server
    if (isOfficialServer() && !Config.Network.UseAlternateServer) iOrder += 50;
    // Joinable
    if (isJoinAllowed() && (getGameVersion() == verThis)) iOrder += 25;
    // League game
    if (Parameters.isLeague()) iOrder += 5;
    // In lobby
    if (getGameStatus().isLobbyActive()) iOrder += 3;
    // No password needed
    if (!isPasswordNeeded()) iOrder += 1;
    // Done
    return iOrder;
}

References Config, getGameStatus(), getGameVersion(), isJoinAllowed(), C4GameParameters::isLeague(), isOfficialServer(), isPasswordNeeded(), C4Config::Network, Parameters, and C4ConfigNetwork::UseAlternateServer.

Referenced by C4StartupNetListEntry::OnReference(), and C4StartupNetListEntry::SetReference().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSourceAddress()

const C4NetIO::EndpointAddress& C4Network2Reference::GetSourceAddress ( ) const

inline

Definition at line 86 of file C4Network2Reference.h.

{ return source; }

getStartTime()

int32_t C4Network2Reference::getStartTime ( ) const

inline

Definition at line 79 of file C4Network2Reference.h.

{ return StartTime; }

getTime()

int32_t C4Network2Reference::getTime ( ) const

inline

Definition at line 78 of file C4Network2Reference.h.

{ return Time; }

Referenced by C4StartupNetListEntry::SetReference().

Here is the caller graph for this function:

getTitle()

const char* C4Network2Reference::getTitle ( ) const

inline

Definition at line 69 of file C4Network2Reference.h.

{ return Title.getData(); }

References StdStrBuf::getData().

Referenced by C4Game::InitNetworkFromReference(), C4StartupNetListEntry::KeywordMatch(), and C4StartupNetListEntry::SetReference().

Here is the call graph for this function:

Here is the caller graph for this function:

InitLocal()

void C4Network2Reference::InitLocal

(

)

Definition at line 40 of file C4Network2Reference.cpp.

{
    // Copy all game parameters
    Parameters = ::Game.Parameters;
 
    // Discard player resources (we don't want these infos in the reference)
    // Add league performance (but only after game end)
    C4ClientPlayerInfos *pClientInfos; C4PlayerInfo *pPlayerInfo;
    int32_t i, j;
    for (i = 0; (pClientInfos = Parameters.PlayerInfos.GetIndexedInfo(i)); i++)
        for (j = 0; (pPlayerInfo = pClientInfos->GetPlayerInfo(j)); j++)
        {
            pPlayerInfo->DiscardResource();
            if(::Game.GameOver)
                pPlayerInfo->SetLeaguePerformance(::Game.RoundResults.GetLeaguePerformance(pPlayerInfo->GetID()));
        }
 
    // Special additional information in reference
    Icon = ::Game.C4S.Head.Icon;
    Title.CopyValidated(::Game.ScenarioTitle);
    GameMode = ::Game.C4S.Game.Mode;
    GameStatus = ::Network.Status;
    Time = ::Game.Time;
    Frame = ::Game.FrameCounter;
    StartTime = ::Game.StartTime;
    LeaguePerformance = ::Game.RoundResults.GetLeaguePerformance();
    Comment = Config.Network.Comment;
    JoinAllowed = ::Network.isJoinAllowed();
    ObservingAllowed = ::Network.isObservingAllowed();
    PasswordNeeded = ::Network.isPassworded();
    IsEditor = !!::Application.isEditor;
    NetpuncherGameID = ::Network.getNetpuncherGameID();
    NetpuncherAddr = ::Network.getNetpuncherAddr();
    Statistics = ::Game.RoundResults.GetStatistics();
    Game.Set();
 
    // Addresses
    C4Network2Client *pLocalNetClient = ::Game.Clients.getLocal()->getNetClient();
    iAddrCnt = pLocalNetClient->getAddrCnt();
    for (i = 0; i < iAddrCnt; i++)
        Addrs[i] = pLocalNetClient->getAddr(i);
 
}

References Application, C4ConfigNetwork::Comment, Config, ValidatedStdCopyStrBufBase::CopyValidated(), C4PlayerInfo::DiscardResource(), C4Network2Client::getAddr(), C4Network2Client::getAddrCnt(), C4PlayerInfo::GetID(), C4PlayerInfoList::GetIndexedInfo(), C4Network2::getNetpuncherAddr(), C4Network2::getNetpuncherGameID(), C4ClientPlayerInfos::GetPlayerInfo(), C4Application::isEditor, C4Network2::isJoinAllowed(), C4Network2::isObservingAllowed(), C4Network2::isPassworded(), Network, C4Config::Network, Parameters, C4GameParameters::PlayerInfos, C4GameVersion::Set(), C4PlayerInfo::SetLeaguePerformance(), and C4Network2::Status.

Referenced by C4Network2::Execute(), C4Network2::LeagueEnd(), C4Network2::LeagueStart(), and C4Network2::LeagueUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

isEditor()

bool C4Network2Reference::isEditor ( ) const

inline

Definition at line 81 of file C4Network2Reference.h.

{ return IsEditor; }

Referenced by C4StartupNetDlg::DoOK(), and C4StartupNetListEntry::SetReference().

Here is the caller graph for this function:

isJoinAllowed()

bool C4Network2Reference::isJoinAllowed ( ) const

inline

Definition at line 75 of file C4Network2Reference.h.

{ return JoinAllowed; }

Referenced by C4StartupNetDlg::DoOK(), getSortOrder(), and C4StartupNetListEntry::SetReference().

Here is the caller graph for this function:

isOfficialServer()

bool C4Network2Reference::isOfficialServer ( ) const

inline

Definition at line 76 of file C4Network2Reference.h.

{ return OfficialServer; }

Referenced by getSortOrder(), and C4StartupNetListEntry::SetReference().

Here is the caller graph for this function:

isPasswordNeeded()

bool C4Network2Reference::isPasswordNeeded ( ) const

inline

Definition at line 74 of file C4Network2Reference.h.

{ return PasswordNeeded; }

Referenced by getSortOrder(), and C4StartupNetListEntry::SetReference().

Here is the caller graph for this function:

SetSourceAddress()

void C4Network2Reference::SetSourceAddress

(

const C4NetIO::EndpointAddress &

ip

)

Definition at line 33 of file C4Network2Reference.cpp.

{
    source = ip;
    if (iAddrCnt < C4ClientMaxAddr)
        Addrs[++iAddrCnt].SetAddr(ip);
}

References C4ClientMaxAddr, and C4Network2Address::SetAddr().

Here is the call graph for this function:

SortNullIPsBack()

void C4Network2Reference::SortNullIPsBack

(

)

Definition at line 84 of file C4Network2Reference.cpp.

{
    // Sort all addresses with zero IP to back of list
    int iSortAddrCnt = iAddrCnt;
    for (int i = 0; i < iSortAddrCnt; i++)
        if (Addrs[i].isIPNull())
        {
            C4Network2Address Addr = Addrs[i];
            for (int j = i + 1; j < iAddrCnt; j++)
                Addrs[j - 1] = Addrs[j];
            Addrs[iAddrCnt - 1] = Addr;
            // Correct position
            i--; iSortAddrCnt--;
        }
}

Member Data Documentation

Parameters

C4GameParameters C4Network2Reference::Parameters

Definition at line 35 of file C4Network2Reference.h.

Referenced by CompileFunc(), getGameGoalString(), getSortOrder(), InitLocal(), C4Game::InitNetworkFromReference(), C4StartupNetListEntry::IsSameHost(), C4StartupNetListEntry::KeywordMatch(), C4StartupNetListEntry::OnReference(), and C4StartupNetListEntry::SetReference().

---

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

• C4Network2Reference.h
• C4Network2Reference.cpp