C4ScenarioParameterDefs Class Reference

#include <C4ScenarioParameters.h>

Public Member Functions
	C4ScenarioParameterDefs ()=default
	~C4ScenarioParameterDefs ()=default
void	Clear ()
const C4ScenarioParameterDef *	GetParameterDefByIndex (size_t idx) const
bool	Load (C4Group &hGroup, class C4LangStringTable *pLang)
void	CompileFunc (StdCompiler *pComp)
void	RegisterScriptConstants (const class C4ScenarioParameters &values)

Detailed Description

Definition at line 75 of file C4ScenarioParameters.h.

Constructor & Destructor Documentation

C4ScenarioParameterDefs()

C4ScenarioParameterDefs::C4ScenarioParameterDefs ( )

default

~C4ScenarioParameterDefs()

C4ScenarioParameterDefs::~C4ScenarioParameterDefs ( )

default

Member Function Documentation

Clear()

void C4ScenarioParameterDefs::Clear ( )

inline

Definition at line 83 of file C4ScenarioParameters.h.

{ Parameters.clear(); }

Referenced by C4Game::Clear().

Here is the caller graph for this function:

CompileFunc()

void C4ScenarioParameterDefs::CompileFunc

(

StdCompiler *

pComp

)

Definition at line 66 of file C4ScenarioParameters.cpp.

{
    pComp->Value(mkSTLContainerAdapt(Parameters, StdCompiler::SEP_NONE));
}

References mkSTLContainerAdapt(), StdCompiler::SEP_NONE, and StdCompiler::Value().

Here is the call graph for this function:

GetParameterDefByIndex()

const C4ScenarioParameterDef * C4ScenarioParameterDefs::GetParameterDefByIndex

(

size_t

idx

)

const

Definition at line 71 of file C4ScenarioParameters.cpp.

{
    if (idx >= Parameters.size()) return nullptr;
    return &Parameters[idx];
}

Referenced by C4GameParameters::EnforceLeagueRules().

Here is the caller graph for this function:

Load()

bool C4ScenarioParameterDefs::Load	(	C4Group &	hGroup,
		class C4LangStringTable *	pLang
	)

Definition at line 77 of file C4ScenarioParameters.cpp.

{
    // Load buffer, localize and parse
    StdStrBuf Buf;
    if (!hGroup.LoadEntryString(C4CFN_ScenarioParameterDefs,&Buf)) return false;
    if (pLang) pLang->ReplaceStrings(Buf);
    if (!CompileFromBuf_LogWarn<StdCompilerINIRead>(*this, Buf, C4CFN_ScenarioParameterDefs))
        { return false; }
    return true;
}

References C4CFN_ScenarioParameterDefs, C4Group::LoadEntryString(), and C4LangStringTable::ReplaceStrings().

Referenced by C4Game::OpenScenario().

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterScriptConstants()

void C4ScenarioParameterDefs::RegisterScriptConstants

(

const class C4ScenarioParameters &

values

)

Definition at line 88 of file C4ScenarioParameters.cpp.

{
    // register constants for all parameters in script engine
 
    // old-style: one constant per parameter
    for (const auto & Parameter : Parameters)
    {
        StdStrBuf constant_name;
        constant_name.Format("SCENPAR_%s", Parameter.GetID());
        int32_t constant_value = values.GetValueByID(Parameter.GetID(), Parameter.GetDefault());
        ::ScriptEngine.RegisterGlobalConstant(constant_name.getData(), C4VInt(constant_value));
    }
 
    // new-style: all constants in a proplist
    auto scenpar = C4PropList::NewStatic(nullptr, nullptr, &Strings.P[P_SCENPAR]);
    for (const auto & Parameter : Parameters)
    {
        int32_t constant_value = values.GetValueByID(Parameter.GetID(), Parameter.GetDefault());
        scenpar->SetPropertyByS(Strings.RegString(StdStrBuf(Parameter.GetID())), C4VInt(constant_value));
    }
    scenpar->Freeze();
    ::ScriptEngine.RegisterGlobalConstant("SCENPAR", C4Value(scenpar));
}

References C4VInt(), StdStrBuf::Format(), StdStrBuf::getData(), C4ScenarioParameters::GetValueByID(), C4PropList::NewStatic(), C4StringTable::P, P_SCENPAR, C4AulScriptEngine::RegisterGlobalConstant(), C4StringTable::RegString(), ScriptEngine, and Strings.

Here is the call graph for this function:

---

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

• C4ScenarioParameters.h
• C4ScenarioParameters.cpp