C4ScenarioParameterDef Class Reference

#include <C4ScenarioParameters.h>

Classes
struct	Option

Public Types
enum	ParameterType { SPDT_Enum }

Public Member Functions
	C4ScenarioParameterDef ()=default
	~C4ScenarioParameterDef ()=default
const char *	GetName () const
const char *	GetDescription () const
const char *	GetID () const
ParameterType	GetType () const
int32_t	GetDefault () const
int32_t	GetLeagueValue () const
const Option *	GetOptionByValue (int32_t val) const
const Option *	GetOptionByIndex (size_t idx) const
bool	IsAchievement () const
const char *	GetAchievement () const
void	CompileFunc (StdCompiler *pComp)

Detailed Description

Definition at line 24 of file C4ScenarioParameters.h.

Member Enumeration Documentation

ParameterType

enum C4ScenarioParameterDef::ParameterType

Enumerator
SPDT_Enum

Definition at line 28 of file C4ScenarioParameters.h.

    {
        SPDT_Enum, // only one type so far
    };

Constructor & Destructor Documentation

C4ScenarioParameterDef()

C4ScenarioParameterDef::C4ScenarioParameterDef ( )

default

~C4ScenarioParameterDef()

C4ScenarioParameterDef::~C4ScenarioParameterDef ( )

default

Member Function Documentation

CompileFunc()

void C4ScenarioParameterDef::CompileFunc

(

StdCompiler *

pComp

)

Definition at line 47 of file C4ScenarioParameters.cpp.

{
    if (!pComp->Name("ParameterDef")) { pComp->NameEnd(); pComp->excNotFound("ParameterDef"); }
    pComp->Value(mkNamingAdapt(mkParAdapt(Name, StdCompiler::RCT_All),          "Name",         StdCopyStrBuf()));
    pComp->Value(mkNamingAdapt(mkParAdapt(Description, StdCompiler::RCT_All),   "Description",  StdCopyStrBuf()));
    pComp->Value(mkNamingAdapt(mkParAdapt(ID, StdCompiler::RCT_Idtf),           "ID",           StdCopyStrBuf()));
    StdEnumEntry<ParameterType> ParTypeEntries[] =
    {
        { "Enumeration", SPDT_Enum },
        { nullptr, SPDT_Enum }
    };
    pComp->Value(mkNamingAdapt(mkEnumAdaptT<uint8_t>(Type, ParTypeEntries),         "Type",         SPDT_Enum));
    pComp->Value(mkNamingAdapt(Default,                                             "Default",      0));
    pComp->Value(mkNamingAdapt(LeagueValue,                                         "LeagueValue",  0));
    pComp->Value(mkNamingAdapt(mkParAdapt(Achievement, StdCompiler::RCT_Idtf),      "Achievement",  StdCopyStrBuf()));
    pComp->Value(mkNamingAdapt(mkSTLContainerAdapt(Options, StdCompiler::SEP_NONE), "Options"));
    pComp->NameEnd();
}

References StdCompiler::excNotFound(), mkNamingAdapt(), mkParAdapt(), mkSTLContainerAdapt(), StdCompiler::Name(), StdCompiler::NameEnd(), StdCompiler::RCT_All, StdCompiler::RCT_Idtf, StdCompiler::SEP_NONE, SPDT_Enum, and StdCompiler::Value().

Here is the call graph for this function:

GetAchievement()

const char* C4ScenarioParameterDef::GetAchievement ( ) const

inline

Definition at line 69 of file C4ScenarioParameters.h.

{ return Achievement.getData(); }

References StdStrBuf::getData().

Referenced by C4ScenarioListLoader::Scenario::LoadCustomPre().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDefault()

int32_t C4ScenarioParameterDef::GetDefault ( ) const

inline

Definition at line 63 of file C4ScenarioParameters.h.

{ return Default; }

Referenced by C4ScenarioListLoader::Scenario::LoadCustomPre().

Here is the caller graph for this function:

GetDescription()

const char* C4ScenarioParameterDef::GetDescription ( ) const

inline

Definition at line 60 of file C4ScenarioParameters.h.

{ return Description.getData(); }

References StdStrBuf::getData().

Here is the call graph for this function:

GetID()

const char* C4ScenarioParameterDef::GetID ( ) const

inline

Definition at line 61 of file C4ScenarioParameters.h.

{ return ID.getData(); }

References StdStrBuf::getData().

Referenced by C4GameParameters::EnforceLeagueRules(), and C4ScenarioListLoader::Scenario::LoadCustomPre().

Here is the call graph for this function:

Here is the caller graph for this function:

GetLeagueValue()

int32_t C4ScenarioParameterDef::GetLeagueValue ( ) const

inline

Definition at line 64 of file C4ScenarioParameters.h.

{ return LeagueValue; }

Referenced by C4GameParameters::EnforceLeagueRules().

Here is the caller graph for this function:

GetName()

const char* C4ScenarioParameterDef::GetName ( ) const

inline

Definition at line 59 of file C4ScenarioParameters.h.

{ return Name.getData(); }

References StdStrBuf::getData().

Here is the call graph for this function:

GetOptionByIndex()

const C4ScenarioParameterDef::Option * C4ScenarioParameterDef::GetOptionByIndex

(

size_t

idx

)

const

Definition at line 41 of file C4ScenarioParameters.cpp.

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

GetOptionByValue()

const C4ScenarioParameterDef::Option * C4ScenarioParameterDef::GetOptionByValue

(

int32_t

val

)

const

Definition at line 32 of file C4ScenarioParameters.cpp.

{
    // search option by value
    for (const auto & Option : Options)
        if (Option.Value == val)
            return &Option;
    return nullptr;
}

References C4ScenarioParameterDef::Option::Value.

Referenced by C4ScenarioListLoader::Scenario::LoadCustomPre().

Here is the caller graph for this function:

GetType()

ParameterType C4ScenarioParameterDef::GetType ( ) const

inline

Definition at line 62 of file C4ScenarioParameters.h.

{ return Type; }

IsAchievement()

bool C4ScenarioParameterDef::IsAchievement ( ) const

inline

Definition at line 68 of file C4ScenarioParameters.h.

{ return Achievement.getLength()>0; }

References StdStrBuf::getLength().

Referenced by C4ScenarioListLoader::Scenario::LoadCustomPre().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• C4ScenarioParameters.h
• C4ScenarioParameters.cpp