C4GameRes Class Reference

#include <C4GameParameters.h>

Public Member Functions
	C4GameRes ()
	C4GameRes (const C4GameRes &Res)
	~C4GameRes ()
C4GameRes &	operator= (const C4GameRes &Res)
C4Network2ResType	getType () const
const char *	getFile () const
bool	isPresent () const
const C4Network2ResCore *	getResCore () const
C4Network2Res::Ref	getNetRes () const
void	SetFile (C4Network2ResType eType, const char *szFile)
void	SetResCore (C4Network2ResCore *pResCore)
void	SetNetRes (C4Network2Res::Ref pRes)
bool	Publish (C4Network2ResList *pResList)
bool	Load (C4Network2ResList *pResList)
bool	InitNetwork (C4Network2ResList *pResList)
void	CalcHash ()
void	Clear ()
void	CompileFunc (StdCompiler *pComp)

Friends
class	C4GameResList

Detailed Description

Definition at line 26 of file C4GameParameters.h.

Constructor & Destructor Documentation

C4GameRes() [1/2]

C4GameRes::C4GameRes

(

)

Definition at line 28 of file C4GameParameters.cpp.

        : pNetRes(nullptr)
{
 
}

C4GameRes() [2/2]

C4GameRes::C4GameRes

(

const C4GameRes &

Res

)

Definition at line 34 of file C4GameParameters.cpp.

        : eType(Res.getType()), File(Res.getFile()), pResCore(Res.getResCore()), pNetRes(Res.getNetRes())
{
    if (pResCore && !pNetRes)
        pResCore = new C4Network2ResCore(*pResCore);
}

~C4GameRes()

C4GameRes::~C4GameRes

(

)

Definition at line 42 of file C4GameParameters.cpp.

{
    Clear();
}

References Clear().

Here is the call graph for this function:

Member Function Documentation

CalcHash()

void C4GameRes::CalcHash

(

)

Definition at line 173 of file C4GameParameters.cpp.

{
    if (!pNetRes) return;
    pNetRes->CalculateSHA();
}

References C4Network2Res::CalculateSHA().

Referenced by C4GameParameters::EnforceLeagueRules().

Here is the call graph for this function:

Here is the caller graph for this function:

Clear()

void C4GameRes::Clear

(

)

Definition at line 59 of file C4GameParameters.cpp.

{
    eType = NRT_Null;
    File.Clear();
    if (pResCore && !pNetRes)
        delete pResCore;
    pResCore = nullptr;
    pNetRes = nullptr;
}

References StdStrBuf::Clear(), and NRT_Null.

Referenced by C4GameParameters::Clear(), CompileFunc(), operator=(), SetNetRes(), and ~C4GameRes().

Here is the call graph for this function:

Here is the caller graph for this function:

CompileFunc()

void C4GameRes::CompileFunc

(

StdCompiler *

pComp

)

Definition at line 92 of file C4GameParameters.cpp.

{
    bool deserializing = pComp->isDeserializer();
    // Clear previous data for compiling
    if (deserializing) Clear();
    // Core is needed to decompile something meaningful
    if (!deserializing) assert(pResCore);
    // De-/Compile core
    pComp->Value(mkPtrAdaptNoNull(const_cast<C4Network2ResCore * &>(pResCore)));
    // Compile: Set type accordingly
    if (deserializing)
        eType = pResCore->getType();
}

References Clear(), C4Network2ResCore::getType(), StdCompiler::isDeserializer(), mkPtrAdaptNoNull(), and StdCompiler::Value().

Here is the call graph for this function:

getFile()

const char* C4GameRes::getFile ( ) const

inline

Definition at line 44 of file C4GameParameters.h.

{ return File.getData(); }

References StdStrBuf::getData().

Referenced by C4Game::InitDefs(), C4Game::InitMaterialTexture(), InitNetwork(), operator=(), and C4Record::Start().

Here is the call graph for this function:

Here is the caller graph for this function:

getNetRes()

C4Network2Res::Ref C4GameRes::getNetRes ( ) const

inline

Definition at line 47 of file C4GameParameters.h.

{ return pNetRes; }

Referenced by InitNetwork(), and operator=().

Here is the caller graph for this function:

getResCore()

const C4Network2ResCore* C4GameRes::getResCore ( ) const

inline

Definition at line 46 of file C4GameParameters.h.

{ return pResCore; }

Referenced by operator=(), C4MessageInput::ProcessCommand(), C4GameResList::RetrieveFiles(), and C4Network2::RetrieveScenario().

Here is the caller graph for this function:

getType()

C4Network2ResType C4GameRes::getType ( ) const

inline

Definition at line 43 of file C4GameParameters.h.

{ return eType; }

Referenced by operator=().

Here is the caller graph for this function:

InitNetwork()

bool C4GameRes::InitNetwork

(

C4Network2ResList *

pResList

)

Definition at line 135 of file C4GameParameters.cpp.

{
    // Already initialized?
    if (getNetRes())
        return true;
    // Present? [Host]
    if (isPresent())
    {
        // Publish on network
        if (!Publish(pNetResList))
        {
            LogFatal(FormatString(LoadResStr("IDS_NET_NOFILEPUBLISH"), getFile()).getData());
            return false;
        }
    }
    // Got a core? [Client]
    else if (pResCore)
    {
        // Search/Load it
        if (!Load(pNetResList))
        {
            // Give some hints to why this might happen.
            const char *szFilename = pResCore->getFileName();
            if (!pResCore->isLoadable())
                if (pResCore->getType() == NRT_System)
                    LogFatal(FormatString(LoadResStr("IDS_NET_NOSAMESYSTEM"), szFilename).getData());
                else
                    LogFatal(FormatString(LoadResStr("IDS_NET_NOSAMEANDTOOLARGE"), szFilename).getData());
            // Should not happen
            else
                LogFatal(FormatString(LoadResStr("IDS_NET_NOVALIDCORE"), szFilename).getData());
            return false;
        }
    }
    // Okay
    return true;
}

References FormatString(), getFile(), C4Network2ResCore::getFileName(), getNetRes(), C4Network2ResCore::getType(), C4Network2ResCore::isLoadable(), isPresent(), Load(), LoadResStr(), LogFatal(), NRT_System, and Publish().

Referenced by C4GameParameters::InitNetwork().

Here is the call graph for this function:

Here is the caller graph for this function:

isPresent()

bool C4GameRes::isPresent ( ) const

inline

Definition at line 45 of file C4GameParameters.h.

{ return !! File; }

Referenced by InitNetwork(), and Publish().

Here is the caller graph for this function:

Load()

bool C4GameRes::Load

(

C4Network2ResList *

pResList

)

Definition at line 122 of file C4GameParameters.cpp.

{
    assert(pResCore);
    // Already present?
    if (pNetRes) return true;
    // Add to network resource list
    C4Network2Res::Ref pNetRes = pNetResList->AddByCore(*pResCore);
    if (!pNetRes) return false;
    // Set resource
    SetNetRes(pNetRes);
    return true;
}

References C4Network2ResList::AddByCore(), and SetNetRes().

Referenced by InitNetwork().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

C4GameRes & C4GameRes::operator=

(

const C4GameRes &

Res

)

Definition at line 47 of file C4GameParameters.cpp.

{
    Clear();
    eType = Res.getType();
    File = Res.getFile();
    pResCore = Res.getResCore();
    pNetRes = Res.getNetRes();
    if (pResCore && !pNetRes)
        pResCore = new C4Network2ResCore(*pResCore);
    return *this;
}

References Clear(), getFile(), getNetRes(), getResCore(), and getType().

Here is the call graph for this function:

Publish()

bool C4GameRes::Publish

(

C4Network2ResList *

pResList

)

Definition at line 106 of file C4GameParameters.cpp.

{
    assert(isPresent());
    // Already present?
    if (pNetRes) return true;
    // determine whether it's loadable
    bool fAllowUnloadable = false;
    if (eType == NRT_Definitions) fAllowUnloadable = true;
    // Add to network resource list
    C4Network2Res::Ref pNetRes = pNetResList->AddByFile(File.getData(), false, eType, -1, nullptr, fAllowUnloadable);
    if (!pNetRes) return false;
    // Set resource
    SetNetRes(pNetRes);
    return true;
}

References C4Network2ResList::AddByFile(), StdStrBuf::getData(), isPresent(), NRT_Definitions, and SetNetRes().

Referenced by InitNetwork().

Here is the call graph for this function:

Here is the caller graph for this function:

SetFile()

void C4GameRes::SetFile	(	C4Network2ResType	eType,
		const char *	szFile
	)

Definition at line 69 of file C4GameParameters.cpp.

{
    assert(!pNetRes && !pResCore);
    eType = enType;
    File = sznFile;
}

Referenced by C4GameResList::CreateByFile(), and C4GameParameters::Load().

Here is the caller graph for this function:

SetNetRes()

void C4GameRes::SetNetRes

(

C4Network2Res::Ref

pRes

)

Definition at line 83 of file C4GameParameters.cpp.

{
    Clear();
    pNetRes = pnNetRes;
    eType = pNetRes->getType();
    File = pNetRes->getFile();
    pResCore = &pNetRes->getCore();
}

References Clear(), C4Network2Res::getCore(), C4Network2Res::getFile(), and C4Network2Res::getType().

Referenced by C4GameResList::CreateByNetRes(), Load(), and Publish().

Here is the call graph for this function:

Here is the caller graph for this function:

SetResCore()

void C4GameRes::SetResCore

(

C4Network2ResCore *

pResCore

)

Definition at line 76 of file C4GameParameters.cpp.

{
    assert(!pNetRes);
    pResCore = pnResCore;
    eType = pResCore->getType();
}

References C4Network2ResCore::getType().

Here is the call graph for this function:

Friends And Related Function Documentation

C4GameResList

friend class C4GameResList

friend

Definition at line 28 of file C4GameParameters.h.

---

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

• C4GameParameters.h
• C4GameParameters.cpp