C4SDefinitions Class Reference

#include <C4Scenario.h>

Collaboration diagram for C4SDefinitions:

Public Member Functions
void	SetModules (const char *szList, const char *szRelativeToPath=nullptr, const char *szRelativeToPath2=nullptr)
bool	GetModules (StdStrBuf *psOutModules) const
std::list< const char * >	GetModulesAsList () const
void	Default ()
void	CompileFunc (StdCompiler *pComp)

Public Attributes
bool	LocalOnly
bool	AllowUserChange
C4IDList	SkipDefs

Detailed Description

Definition at line 89 of file C4Scenario.h.

Member Function Documentation

CompileFunc()

void C4SDefinitions::CompileFunc

(

StdCompiler *

pComp

)

Definition at line 502 of file C4Scenario.cpp.

{
    pComp->Value(mkNamingAdapt(LocalOnly,               "LocalOnly",             false));
    pComp->Value(mkNamingAdapt(AllowUserChange,         "AllowUserChange",       false));
    pComp->Value(mkNamingAdapt(mkStringAdaptMA(Definition[0]), "Definition1", "Objects.ocd"));
    for (int32_t i = 1; i < C4S_MaxDefinitions; i++)
        pComp->Value(mkNamingAdapt(mkStringAdaptMA(Definition[i]), FormatString("Definition%i", i+1).getData(), ""));
    pComp->Value(mkNamingAdapt(SkipDefs,                "SkipDefs",              C4IDList()));
}

References AllowUserChange, C4S_MaxDefinitions, FormatString(), LocalOnly, mkNamingAdapt(), mkStringAdaptMA(), SkipDefs, and StdCompiler::Value().

Here is the call graph for this function:

Default()

void C4SDefinitions::Default

(

)

Definition at line 150 of file C4Scenario.cpp.

{
    LocalOnly=AllowUserChange=false;
    ZeroMem(Definition,sizeof (Definition));
    SkipDefs.Default();
}

References AllowUserChange, C4IDList::Default(), LocalOnly, SkipDefs, and ZeroMem().

Referenced by C4Scenario::Default().

Here is the call graph for this function:

Here is the caller graph for this function:

GetModules()

bool C4SDefinitions::GetModules

(

StdStrBuf *

psOutModules

)

const

Definition at line 422 of file C4Scenario.cpp.

{
    // Local only
    if (LocalOnly) { psOutModules->Copy(""); return true; }
    // Scan for any valid entries
    bool fSpecified = false;
    int32_t cnt=0;
    for (; cnt<C4S_MaxDefinitions; cnt++)
        if (Definition[cnt][0])
            fSpecified = true;
    // No valid entries
    if (!fSpecified) return false;
    // Compose entry list
    psOutModules->Copy("");
    for (cnt=0; cnt<C4S_MaxDefinitions; cnt++)
        if (Definition[cnt][0])
        {
            if (psOutModules->getLength()) psOutModules->AppendChar(';');
            psOutModules->Append(Definition[cnt]);
        }
    // Done
    return true;
}

References StdStrBuf::Append(), StdStrBuf::AppendChar(), C4S_MaxDefinitions, StdStrBuf::Copy(), StdStrBuf::getLength(), and LocalOnly.

Referenced by C4Game::OpenScenario(), and C4StartupScenSelDlg::StartScenario().

Here is the call graph for this function:

Here is the caller graph for this function:

GetModulesAsList()

std::list< const char * > C4SDefinitions::GetModulesAsList

(

)

const

Definition at line 446 of file C4Scenario.cpp.

{
    // get definitions as string pointers into this structure
    std::list<const char *> result;
    if (!LocalOnly)
    {
        for (const char *def : Definition)
        {
            if (*def)
            {
                result.push_back(def);
            }
        }
    }
    return result;
}

References LocalOnly.

SetModules()

void C4SDefinitions::SetModules	(	const char *	szList,
		const char *	szRelativeToPath = nullptr,
		const char *	szRelativeToPath2 = nullptr
	)

Definition at line 464 of file C4Scenario.cpp.

{
    int32_t cnt;
 
    // Empty list: local only
    if (!SModuleCount(szList))
    {
        LocalOnly=true;
        for (cnt=0; cnt<C4S_MaxDefinitions; cnt++) Definition[cnt][0]=0;
        return;
    }
 
    // Set list
    LocalOnly=false;
    for (cnt=0; cnt<C4S_MaxDefinitions; cnt++)
    {
        SGetModule(szList,cnt,Definition[cnt],_MAX_PATH);
        // Make relative path
        if (szRelativeToPath && *szRelativeToPath)
        {
            if (GetRelativePathS(Definition[cnt],szRelativeToPath) != Definition[cnt])
            {
                SCopy(GetRelativePathS(Definition[cnt],szRelativeToPath),Definition[cnt]);
                continue;
            }
        }
        if (szRelativeToPath2 && *szRelativeToPath2)
        {
            if (GetRelativePathS(Definition[cnt],szRelativeToPath2) != Definition[cnt])
            {
                SCopy(GetRelativePathS(Definition[cnt],szRelativeToPath2),Definition[cnt]);
                continue;
            }
        }
    }
 
}

References _MAX_PATH, C4S_MaxDefinitions, GetRelativePathS(), LocalOnly, SCopy(), SGetModule(), and SModuleCount().

Here is the call graph for this function:

Member Data Documentation

AllowUserChange

bool C4SDefinitions::AllowUserChange

Definition at line 93 of file C4Scenario.h.

Referenced by CompileFunc(), Default(), C4Game::OpenScenario(), and C4StartupScenSelDlg::StartScenario().

LocalOnly

bool C4SDefinitions::LocalOnly

Definition at line 92 of file C4Scenario.h.

Referenced by CompileFunc(), Default(), GetModules(), GetModulesAsList(), and SetModules().

SkipDefs

C4IDList C4SDefinitions::SkipDefs

Definition at line 94 of file C4Scenario.h.

Referenced by CompileFunc(), and Default().

---

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

• C4Scenario.h
• C4Scenario.cpp