C4RoundResults Class Reference

#include <C4RoundResults.h>

Public Types
enum	NetResult { NR_None =0 , NR_LeagueOK , NR_LeagueError , NR_NetError }

Public Member Functions
	C4RoundResults ()=default
	~C4RoundResults ()
void	Clear ()
void	Init ()
void	CompileFunc (StdCompiler *pComp)
void	EvaluateGame ()
void	EvaluateLeague (const char *szResultMsg, bool fSuccess, const C4RoundResultsPlayers &rLeagueInfo)
void	EvaluatePlayer (C4Player *pPlr)
void	EvaluateNetwork (NetResult eResult, const char *szResultsString)
void	AddCustomEvaluationString (const char *szCustomString, int32_t idPlayer)
void	HideSettlementScore (bool fHide=true)
bool	SettlementScoreIsHidden ()
void	SetLeaguePerformance (int32_t iNewPerf, int32_t idPlayer=0)
int32_t	GetLeaguePerformance (int32_t idPlayer=0) const
StdCopyStrBuf	GetStatistics () const
const C4RoundResultsPlayers &	GetPlayers () const
const char *	GetCustomEvaluationStrings () const
NetResult	GetNetResult () const
const char *	GetNetResultString () const
bool	HasNetResult () const
bool	Load (C4Group &hGroup, const char *szFilename=C4CFN_RoundResults)
bool	Save (C4Group &hGroup, const char *szFilename=C4CFN_RoundResults)
const C4IDList &	GetGoals () const
const C4IDList &	GetFulfilledGoals () const

Static Public Member Functions
static void	EvaluateGoals (C4IDList &GoalList, C4IDList &FulfilledGoalList, int32_t iPlayerNumber)

Detailed Description

Definition at line 124 of file C4RoundResults.h.

Member Enumeration Documentation

NetResult

enum C4RoundResults::NetResult

Enumerator
NR_None
NR_LeagueOK
NR_LeagueError
NR_NetError

Definition at line 127 of file C4RoundResults.h.

    {
        NR_None=0,      // undefined
        NR_LeagueOK,    // league evaluated
        NR_LeagueError, // league evaluation error
        NR_NetError     // network disconnect
    };

Constructor & Destructor Documentation

C4RoundResults()

C4RoundResults::C4RoundResults ( )

default

~C4RoundResults()

C4RoundResults::~C4RoundResults ( )

inline

Definition at line 156 of file C4RoundResults.h.

{ Clear(); }

References Clear().

Here is the call graph for this function:

Member Function Documentation

AddCustomEvaluationString()

void C4RoundResults::AddCustomEvaluationString	(	const char *	szCustomString,
		int32_t	idPlayer
	)

Definition at line 357 of file C4RoundResults.cpp.

{
    // Set custom string to be shown in game over dialog
    // idPlayer==0 for global strings
    if (!idPlayer)
    {
        if (sCustomEvaluationStrings.getLength()) sCustomEvaluationStrings.AppendChar('|');
        sCustomEvaluationStrings.Append(szCustomString);
    }
    else
    {
        C4RoundResultsPlayer *pOwnPlr = Players.GetCreateByID(idPlayer);
        pOwnPlr->AddCustomEvaluationString(szCustomString);
    }
}

References C4RoundResultsPlayer::AddCustomEvaluationString(), StdStrBuf::Append(), StdStrBuf::AppendChar(), C4RoundResultsPlayers::GetCreateByID(), and StdStrBuf::getLength().

Here is the call graph for this function:

Clear()

void C4RoundResults::Clear

(

)

Definition at line 241 of file C4RoundResults.cpp.

{
    Players.Clear();
    Goals.Clear();
    iPlayingTime = 0;
    sCustomEvaluationStrings.Clear();
    iLeaguePerformance = 0;
    sNetResult.Clear();
    eNetResult = NR_None;
    fHideSettlementScore=false;
    Statistics.Clear();
}

References C4RoundResultsPlayers::Clear(), StdStrBuf::Clear(), C4IDList::Clear(), and NR_None.

Referenced by C4Game::Clear(), CompileFunc(), Load(), and ~C4RoundResults().

Here is the call graph for this function:

Here is the caller graph for this function:

CompileFunc()

void C4RoundResults::CompileFunc

(

StdCompiler *

pComp

)

Definition at line 261 of file C4RoundResults.cpp.

{
    bool deserializing = pComp->isDeserializer();
    if (deserializing) Clear();
    pComp->Value(mkNamingAdapt(Goals, "Goals", C4IDList()));
    pComp->Value(mkNamingAdapt(iPlayingTime, "PlayingTime", 0u));
    pComp->Value(mkNamingAdapt(fHideSettlementScore, "HideSettlementScore", Game.C4S.Game.IsMelee()));
    pComp->Value(mkNamingAdapt(sCustomEvaluationStrings, "CustomEvaluationStrings", StdCopyStrBuf()));
    pComp->Value(mkNamingAdapt(iLeaguePerformance, "LeaguePerformance", 0));
    pComp->Value(mkNamingAdapt(Players, "PlayerInfos", C4RoundResultsPlayers()));
    pComp->Value(mkNamingAdapt(sNetResult, "NetResult", StdCopyStrBuf()));
    StdEnumEntry<NetResult> NetResultEntries[] =
    {
        { "",            NR_None       },
        { "LeagueOK",    NR_LeagueOK   },
        { "LeagueError", NR_LeagueError},
        { "NetError",    NR_NetError   },
    };
    pComp->Value(mkNamingAdapt(mkEnumAdaptT<uint8_t>(eNetResult, NetResultEntries), "NetResult", NR_None));
}

References C4Game::C4S, Clear(), Game, C4Scenario::Game, StdCompiler::isDeserializer(), C4SGame::IsMelee(), mkNamingAdapt(), NR_LeagueError, NR_LeagueOK, NR_NetError, NR_None, and StdCompiler::Value().

Here is the call graph for this function:

EvaluateGame()

void C4RoundResults::EvaluateGame

(

)

Definition at line 304 of file C4RoundResults.cpp.

{
    // set game data
    C4Player *pFirstLocalPlayer = ::Players.GetLocalByIndex(0);
    int32_t iFirstLocalPlayer = pFirstLocalPlayer ? pFirstLocalPlayer->Number : NO_OWNER;
    EvaluateGoals(Goals, FulfilledGoals, iFirstLocalPlayer);
    iPlayingTime = Game.Time;
 
    // collect statistics
    try
    {
        C4AulParSet Pars;
        auto stats = ::ScriptEngine.GetPropList()->Call(PSF_CollectStatistics, &Pars);
        if (stats != C4VNull)
            Statistics = stats.ToJSON();
    }
    catch (C4JSONSerializationError& e)
    {
        DebugLogF("ERROR: cannot serialize CollectStatistics() result: %s", e.what());
    }
}

References C4VNull, C4PropList::Call(), DebugLogF(), EvaluateGoals(), Game, C4AulScriptEngine::GetPropList(), NO_OWNER, C4Player::Number, PSF_CollectStatistics, ScriptEngine, C4Game::Time, and C4JSONSerializationError::what().

Referenced by C4Game::Evaluate().

Here is the call graph for this function:

Here is the caller graph for this function:

EvaluateGoals()

void C4RoundResults::EvaluateGoals ( C4IDList &  GoalList, C4IDList &  FulfilledGoalList, int32_t  iPlayerNumber  )

static

Definition at line 282 of file C4RoundResults.cpp.

{
    // clear prev
    GoalList.Clear(); FulfilledGoalList.Clear();
    // Items
    int32_t cnt; C4ID idGoal;
    for (cnt=0; (idGoal=::Objects.GetListID(C4D_Goal,cnt)); cnt++)
    {
        // determine if the goal is fulfilled - do the calls even if the menu is not to be opened to ensure synchronization
        bool fFulfilled = false;;
        C4Object *pObj = C4Id2Def(idGoal) ? ::Objects.Find(::Definitions.ID2Def(idGoal)) : nullptr;
        if (pObj)
        {
            // Check fulfilled per player, this enables the possibility of rivalry.
            C4AulParSet pars(iPlayerNumber);
            fFulfilled = !!pObj->Call(PSF_IsFulfilled, &pars);
        }
        GoalList.SetIDCount(idGoal, cnt, true);
        if (fFulfilled) FulfilledGoalList.SetIDCount(idGoal, 1, true);
    }
}

References C4D_Goal, C4Id2Def(), C4PropList::Call(), C4IDList::Clear(), Definitions, C4ObjectList::Find(), C4ObjectList::GetListID(), C4DefList::ID2Def(), Objects, PSF_IsFulfilled, and C4IDList::SetIDCount().

Referenced by C4MainMenu::ActivateGoals(), and EvaluateGame().

Here is the call graph for this function:

Here is the caller graph for this function:

EvaluateLeague()

void C4RoundResults::EvaluateLeague	(	const char *	szResultMsg,
		bool	fSuccess,
		const C4RoundResultsPlayers &	rLeagueInfo
	)

Definition at line 336 of file C4RoundResults.cpp.

{
    // League evaluation imples network evaluation
    Game.RoundResults.EvaluateNetwork(fSuccess ? C4RoundResults::NR_LeagueOK : C4RoundResults::NR_LeagueError, szResultMsg);
    // Evaluation called by league: Sets new league scores and ranks
    C4RoundResultsPlayer *pPlr, *pOwnPlr; int32_t i = 0;
    while ((pPlr = rLeagueInfo.GetByIndex(i++)))
    {
        pOwnPlr = Players.GetCreateByID(pPlr->GetID());
        pOwnPlr->EvaluateLeague(pPlr);
    }
}

References C4RoundResultsPlayer::EvaluateLeague(), EvaluateNetwork(), Game, C4RoundResultsPlayers::GetByIndex(), C4RoundResultsPlayers::GetCreateByID(), C4RoundResultsPlayer::GetID(), NR_LeagueError, NR_LeagueOK, and C4Game::RoundResults.

Referenced by C4Network2Players::HandlePacket(), and C4Network2::LeagueEnd().

Here is the call graph for this function:

Here is the caller graph for this function:

EvaluateNetwork()

void C4RoundResults::EvaluateNetwork	(	C4RoundResults::NetResult	eNetResult,
		const char *	szResultsString
	)

Definition at line 326 of file C4RoundResults.cpp.

{
    // take result only if there was no previous result (the previous one is usually more specific)
    if (!HasNetResult())
    {
        this->eNetResult = eNetResult;
        if (szResultMsg) sNetResult.Copy(szResultMsg); else sNetResult.Clear();
    }
}

References StdStrBuf::Clear(), StdStrBuf::Copy(), and HasNetResult().

Referenced by EvaluateLeague(), C4MainMenu::MenuCommand(), and C4Network2::OnClientDisconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

EvaluatePlayer()

void C4RoundResults::EvaluatePlayer

(

C4Player *

pPlr

)

Definition at line 349 of file C4RoundResults.cpp.

{
    // Evaluation called by player when it's evaluated
    assert(pPlr);
    C4RoundResultsPlayer *pOwnPlr = Players.GetCreateByID(pPlr->ID);
    pOwnPlr->EvaluatePlayer(pPlr);
}

References C4RoundResultsPlayer::EvaluatePlayer(), C4RoundResultsPlayers::GetCreateByID(), and C4Player::ID.

Referenced by C4Player::Evaluate(), and C4PlayerList::Remove().

Here is the call graph for this function:

Here is the caller graph for this function:

GetCustomEvaluationStrings()

const char* C4RoundResults::GetCustomEvaluationStrings ( ) const

inline

Definition at line 197 of file C4RoundResults.h.

{ return sCustomEvaluationStrings.getData(); }

References StdStrBuf::getData().

Referenced by C4GameOverDlg::C4GameOverDlg().

Here is the call graph for this function:

Here is the caller graph for this function:

GetFulfilledGoals()

const C4IDList& C4RoundResults::GetFulfilledGoals ( ) const

inline

Definition at line 206 of file C4RoundResults.h.

{ return FulfilledGoals; }

Referenced by C4GameOverDlg::C4GameOverDlg().

Here is the caller graph for this function:

GetGoals()

const C4IDList& C4RoundResults::GetGoals ( ) const

inline

Definition at line 205 of file C4RoundResults.h.

{ return Goals; }

Referenced by C4GameOverDlg::C4GameOverDlg().

Here is the caller graph for this function:

GetLeaguePerformance()

int32_t C4RoundResults::GetLeaguePerformance

(

int32_t

idPlayer = 0

)

const

Definition at line 397 of file C4RoundResults.cpp.

{
    if(!idPlayer)
        return iLeaguePerformance;
    else
        if(C4RoundResultsPlayer *pPlr = Players.GetByID(idPlayer))
            return pPlr->GetLeaguePerformance();
    return 0;
}

References C4RoundResultsPlayers::GetByID().

Here is the call graph for this function:

GetNetResult()

NetResult C4RoundResults::GetNetResult ( ) const

inline

Definition at line 198 of file C4RoundResults.h.

{ return eNetResult; }

GetNetResultString()

const char* C4RoundResults::GetNetResultString ( ) const

inline

Definition at line 199 of file C4RoundResults.h.

{ return sNetResult.getData(); }

References StdStrBuf::getData().

Referenced by C4GameOverDlg::C4GameOverDlg().

Here is the call graph for this function:

Here is the caller graph for this function:

GetPlayers()

const C4RoundResultsPlayers& C4RoundResults::GetPlayers ( ) const

inline

Definition at line 196 of file C4RoundResults.h.

{ return Players; }

References Players.

GetStatistics()

StdCopyStrBuf C4RoundResults::GetStatistics ( ) const

inline

Definition at line 194 of file C4RoundResults.h.

{ return Statistics; }

HasNetResult()

bool C4RoundResults::HasNetResult ( ) const

inline

Definition at line 200 of file C4RoundResults.h.

{ return eNetResult != NR_None; }

References NR_None.

Referenced by C4GameOverDlg::C4GameOverDlg(), and EvaluateNetwork().

Here is the caller graph for this function:

HideSettlementScore()

void C4RoundResults::HideSettlementScore

(

bool

fHide = true

)

Definition at line 373 of file C4RoundResults.cpp.

{
    fHideSettlementScore=fHide;
}

Init()

void C4RoundResults::Init

(

)

Definition at line 254 of file C4RoundResults.cpp.

{
    if (Game.C4S.Game.IsMelee())
        fHideSettlementScore=true;
    else fHideSettlementScore=false;
}

References C4Game::C4S, Game, C4Scenario::Game, and C4SGame::IsMelee().

Here is the call graph for this function:

Load()

bool C4RoundResults::Load	(	C4Group &	hGroup,
		const char *	szFilename = C4CFN_RoundResults
	)

Definition at line 407 of file C4RoundResults.cpp.

{
    // clear previous
    Clear();
    // load file contents
    StdStrBuf Buf;
    if (!hGroup.LoadEntryString(szFilename, &Buf)) return false;
    // compile
    if (!CompileFromBuf_LogWarn<StdCompilerINIRead>(mkNamingAdapt(*this, "RoundResults"), Buf, szFilename)) return false;
    // done, success
    return true;
}

References Clear(), C4Group::LoadEntryString(), and mkNamingAdapt().

Here is the call graph for this function:

Save()

bool C4RoundResults::Save	(	C4Group &	hGroup,
		const char *	szFilename = C4CFN_RoundResults
	)

Definition at line 420 of file C4RoundResults.cpp.

{
    // remove previous entry from group
    hGroup.DeleteEntry(szFilename);
    // decompile
    try
    {
        StdStrBuf Buf = DecompileToBuf<StdCompilerINIWrite>(mkNamingAdapt(*this, "RoundResults"));
        // save it, if not empty
        if (Buf.getLength())
            if (!hGroup.Add(szFilename, Buf, false, true))
                return false;
    }
    catch (StdCompiler::Exception *)
        { return false; }
    // done, success
    return true;
}

References C4Group::Add(), C4Group::DeleteEntry(), StdStrBuf::getLength(), and mkNamingAdapt().

Here is the call graph for this function:

SetLeaguePerformance()

void C4RoundResults::SetLeaguePerformance	(	int32_t	iNewPerf,
		int32_t	idPlayer = 0
	)

Definition at line 383 of file C4RoundResults.cpp.

{
    // Store to be sent later. idPlayer == 0 means global performance.
    if(!idPlayer)
        {
        iLeaguePerformance = iNewPerf;
        }
    else
        {
        C4RoundResultsPlayer *pOwnPlr = Players.GetCreateByID(idPlayer);
        pOwnPlr->SetLeaguePerformance(iNewPerf);
        }
    }

References C4RoundResultsPlayers::GetCreateByID(), and C4RoundResultsPlayer::SetLeaguePerformance().

Here is the call graph for this function:

SettlementScoreIsHidden()

bool C4RoundResults::SettlementScoreIsHidden

(

)

Definition at line 378 of file C4RoundResults.cpp.

{
    return fHideSettlementScore;
}

---

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

• C4RoundResults.h
• C4RoundResults.cpp