C4PlayerControlDefs Class Reference

#include <C4PlayerControl.h>

Collaboration diagram for C4PlayerControlDefs:

Classes
struct	CInternalCons

Public Member Functions
void	UpdateInternalCons ()
	C4PlayerControlDefs ()=default
	~C4PlayerControlDefs ()=default
void	Clear ()
void	CompileFunc (StdCompiler *pComp)
void	MergeFrom (const C4PlayerControlDefs &Src)
void	FinalInit ()
const C4PlayerControlDef *	GetControlByIndex (int32_t idx) const
int32_t	GetControlIndexByIdentifier (const char *szIdentifier) const
size_t	GetCount () const
bool	operator== (const C4PlayerControlDefs &cmp) const

Public Attributes
struct C4PlayerControlDefs::CInternalCons	InternalCons

Detailed Description

Definition at line 96 of file C4PlayerControl.h.

Constructor & Destructor Documentation

C4PlayerControlDefs()

C4PlayerControlDefs::C4PlayerControlDefs ( )

default

~C4PlayerControlDefs()

C4PlayerControlDefs::~C4PlayerControlDefs ( )

default

Member Function Documentation

Clear()

void C4PlayerControlDefs::Clear

(

)

Definition at line 114 of file C4PlayerControl.cpp.

{
    clear_previous = false;
    Defs.clear();
    UpdateInternalCons();
}

References UpdateInternalCons().

Referenced by C4PlayerControlFile::Clear(), and C4Game::Clear().

Here is the call graph for this function:

Here is the caller graph for this function:

CompileFunc()

void C4PlayerControlDefs::CompileFunc

(

StdCompiler *

pComp

)

Definition at line 121 of file C4PlayerControl.cpp.

{
    pComp->Value(mkNamingAdapt(clear_previous, "ClearPrevious", false));
    pComp->Value(mkSTLContainerAdapt(Defs, StdCompiler::SEP_NONE));
    if (pComp->isDeserializer()) UpdateInternalCons();
}

References StdCompiler::isDeserializer(), mkNamingAdapt(), mkSTLContainerAdapt(), StdCompiler::SEP_NONE, UpdateInternalCons(), and StdCompiler::Value().

Here is the call graph for this function:

FinalInit()

void C4PlayerControlDefs::FinalInit

(

)

Definition at line 165 of file C4PlayerControl.cpp.

{
    // Assume all defs have been loaded
    // Register scritp constants
    for (DefVecImpl::const_iterator i = Defs.begin(); i != Defs.end(); ++i)
    {
        const char *szIdtf  = (*i).GetIdentifier();
        if (szIdtf && *szIdtf && !SEqual(szIdtf, "None"))
        {
            ::ScriptEngine.RegisterGlobalConstant(FormatString("CON_%s", szIdtf).getData(), C4VInt(i-Defs.begin()));
        }
    }
}

References C4VInt(), FormatString(), C4AulScriptEngine::RegisterGlobalConstant(), ScriptEngine, and SEqual().

Here is the call graph for this function:

GetControlByIndex()

const C4PlayerControlDef * C4PlayerControlDefs::GetControlByIndex

(

int32_t

idx

)

const

Definition at line 150 of file C4PlayerControl.cpp.

{
    // safe index
    if (idx<0 || idx>=int32_t(Defs.size())) return nullptr;
    return &(Defs[idx]);
}

Referenced by C4PlayerControlAssignmentSet::GetAssignmentsByKey(), C4PlayerControlAssignment::GetGUIDesc(), C4PlayerControlAssignment::GetGUIName(), C4PlayerControlAssignmentSet::GetTriggerKeys(), and C4PlayerControl::CSync::InitDefaults().

Here is the caller graph for this function:

GetControlIndexByIdentifier()

int32_t C4PlayerControlDefs::GetControlIndexByIdentifier

(

const char *

szIdentifier

)

const

Definition at line 157 of file C4PlayerControl.cpp.

{
    for (DefVecImpl::const_iterator i = Defs.begin(); i != Defs.end(); ++i)
        if (SEqual((*i).GetIdentifier(), szIdentifier))
            return i-Defs.begin();
    return CON_None;
}

References CON_None, and SEqual().

Referenced by MergeFrom(), C4PlayerControlAssignment::ResolveRefs(), and UpdateInternalCons().

Here is the call graph for this function:

Here is the caller graph for this function:

GetCount()

size_t C4PlayerControlDefs::GetCount ( ) const

inline

Definition at line 124 of file C4PlayerControl.h.

{ return Defs.size(); }

MergeFrom()

void C4PlayerControlDefs::MergeFrom

(

const C4PlayerControlDefs &

Src

)

Definition at line 128 of file C4PlayerControl.cpp.

{
    // Clear previous defs if specified in merge set
    if (Src.clear_previous) Defs.clear();
    // copy all defs from source file; overwrite defs of same name if found
    for (const auto & SrcDef : Src.Defs)
    {
        // overwrite if def of same name existed
        int32_t iPrevIdx = GetControlIndexByIdentifier(SrcDef.GetIdentifier());
        if (iPrevIdx != CON_None)
        {
            Defs[iPrevIdx] = SrcDef;
        }
        else
        {
            // new def: Append a copy
            Defs.push_back(SrcDef);
        }
    }
    UpdateInternalCons();
}

References CON_None, GetControlIndexByIdentifier(), and UpdateInternalCons().

Referenced by C4Game::LoadAdditionalSystemGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

operator==()

bool C4PlayerControlDefs::operator== ( const C4PlayerControlDefs &  cmp ) const

inline

Definition at line 126 of file C4PlayerControl.h.

{ return Defs == cmp.Defs && clear_previous == cmp.clear_previous; }

UpdateInternalCons()

void C4PlayerControlDefs::UpdateInternalCons

(

)

Definition at line 105 of file C4PlayerControl.cpp.

{
    InternalCons.CON_ObjectMenuSelect   = GetControlIndexByIdentifier("ObjectMenuSelect");
    InternalCons.CON_ObjectMenuOK       = GetControlIndexByIdentifier("ObjectMenuOK");
    InternalCons.CON_ObjectMenuOKAll    = GetControlIndexByIdentifier("ObjectMenuOKAll");
    InternalCons.CON_ObjectMenuCancel   = GetControlIndexByIdentifier("ObjectMenuCancel");
    InternalCons.CON_CursorPos          = GetControlIndexByIdentifier("CursorPos");
}

References C4PlayerControlDefs::CInternalCons::CON_CursorPos, C4PlayerControlDefs::CInternalCons::CON_ObjectMenuCancel, C4PlayerControlDefs::CInternalCons::CON_ObjectMenuOK, C4PlayerControlDefs::CInternalCons::CON_ObjectMenuOKAll, C4PlayerControlDefs::CInternalCons::CON_ObjectMenuSelect, GetControlIndexByIdentifier(), and InternalCons.

Referenced by Clear(), CompileFunc(), and MergeFrom().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

InternalCons

struct C4PlayerControlDefs::CInternalCons C4PlayerControlDefs::InternalCons

Referenced by C4ObjectMenu::OnUserClose(), C4ObjectMenu::OnUserEnter(), C4ObjectMenu::OnUserSelectItem(), C4PlayerControl::PrepareInput(), and UpdateInternalCons().

---

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

• C4PlayerControl.h
• C4PlayerControl.cpp