C4ObjectInfoList Class Reference

#include <C4ObjectInfoList.h>

Collaboration diagram for C4ObjectInfoList:

Public Member Functions
	C4ObjectInfoList ()
	~C4ObjectInfoList ()
void	Default ()
void	Clear ()
void	Evaluate ()
void	DetachFromObjects ()
int32_t	Load (C4Group &hGroup)
bool	Add (C4ObjectInfo *pInfo)
bool	Save (C4Group &hGroup, bool fSavegame, bool fStoreTiny, C4DefList *pDefs)
C4ObjectInfo *	New (C4ID n_id, C4DefList *pDefs)
C4ObjectInfo *	GetIdle (C4ID c_id, C4DefList &rDefs)
C4ObjectInfo *	GetIdle (const char *szByName)
C4ObjectInfo *	GetFirst ()
bool	IsElement (C4ObjectInfo *pInfo)
void	Strip (C4DefList &rDefs)
void	MakeValidName (char *sName)
bool	NameExists (const char *szName)

Public Attributes
int32_t	iNumCreated

Protected Member Functions
C4ObjectInfo *	GetLast ()
C4ObjectInfo *	GetPrevious (C4ObjectInfo *pInfo)

Protected Attributes
C4ObjectInfo *	First

Detailed Description

Definition at line 25 of file C4ObjectInfoList.h.

Constructor & Destructor Documentation

C4ObjectInfoList()

C4ObjectInfoList::C4ObjectInfoList

(

)

Definition at line 30 of file C4ObjectInfoList.cpp.

{
    Default();
}

References Default().

Here is the call graph for this function:

~C4ObjectInfoList()

C4ObjectInfoList::~C4ObjectInfoList

(

)

Definition at line 35 of file C4ObjectInfoList.cpp.

{
    Clear();
}

References Clear().

Here is the call graph for this function:

Member Function Documentation

Add()

bool C4ObjectInfoList::Add

(

C4ObjectInfo *

pInfo

)

Definition at line 95 of file C4ObjectInfoList.cpp.

{
    if (!pInfo)
    {
        return false;
    }
    pInfo->Next = First;
    First = pInfo;
    return true;
}

References First, and C4ObjectInfo::Next.

Referenced by Load(), and New().

Here is the caller graph for this function:

Clear()

void C4ObjectInfoList::Clear

(

)

Definition at line 46 of file C4ObjectInfoList.cpp.

{
    C4ObjectInfo *next;
    while (First)
    {
        next = First->Next;
        delete First;
        First = next;
    }
}

References First, and C4ObjectInfo::Next.

Referenced by ~C4ObjectInfoList().

Here is the caller graph for this function:

Default()

void C4ObjectInfoList::Default

(

)

Definition at line 40 of file C4ObjectInfoList.cpp.

{
    First = nullptr;
    iNumCreated = 0;
}

References First, and iNumCreated.

Referenced by C4ObjectInfoList(), and C4Player::C4Player().

Here is the caller graph for this function:

DetachFromObjects()

void C4ObjectInfoList::DetachFromObjects

(

)

Definition at line 262 of file C4ObjectInfoList.cpp.

{
    C4ObjectInfo *cinf;
    for (cinf = First; cinf; cinf = cinf->Next)
    {
        ::Objects.ClearInfo(cinf);
    }
}

References C4ObjectList::ClearInfo(), First, C4ObjectInfo::Next, and Objects.

Referenced by C4PlayerList::Remove().

Here is the call graph for this function:

Here is the caller graph for this function:

Evaluate()

void C4ObjectInfoList::Evaluate

(

)

Definition at line 211 of file C4ObjectInfoList.cpp.

{
    C4ObjectInfo *cinf;
    for (cinf = First; cinf; cinf = cinf->Next)
    {
        cinf->Evaluate();
    }
}

References C4ObjectInfo::Evaluate(), First, and C4ObjectInfo::Next.

Referenced by C4Player::Evaluate().

Here is the call graph for this function:

Here is the caller graph for this function:

GetFirst()

C4ObjectInfo* C4ObjectInfoList::GetFirst ( )

inline

Definition at line 45 of file C4ObjectInfoList.h.

{ return First; }

References First.

Referenced by C4Player::LocalSync().

Here is the caller graph for this function:

GetIdle() [1/2]

C4ObjectInfo * C4ObjectInfoList::GetIdle	(	C4ID	c_id,
		C4DefList &	rDefs
	)

Definition at line 134 of file C4ObjectInfoList.cpp.

{
    C4Def *pDef;
    C4ObjectInfo *pInfo;
    C4ObjectInfo *pHiExp = nullptr;
 
    // Search list
    for (pInfo = First; pInfo; pInfo = pInfo->Next)
    {
        // Valid only
        if ((pDef = rDefs.ID2Def(pInfo->id)))
        {
            // Use standard crew or matching id
            if ( (!c_id && !pDef->NativeCrew) || (pInfo->id == c_id) )
            {
                // Participating and not in action
                if (pInfo->Participation && !pInfo->InAction && !pInfo->HasDied)
                {
                    // Highest experience
                    if (!pHiExp || (pInfo->Experience > pHiExp->Experience))
                    {
                        // Set this
                        pHiExp = pInfo;
                    }
                }
            }
        }
    }
 
    // Found
    if (pHiExp)
    {
        pHiExp->Recruit();
        return pHiExp;
    }
 
    return nullptr;
}

References C4ObjectInfoCore::Experience, First, C4ObjectInfo::HasDied, C4ObjectInfoCore::id, C4DefList::ID2Def(), C4ObjectInfo::InAction, C4Def::NativeCrew, C4ObjectInfo::Next, C4ObjectInfoCore::Participation, and C4ObjectInfo::Recruit().

Referenced by C4Player::MakeCrewMember(), and C4Player::PlaceReadyCrew().

Here is the call graph for this function:

Here is the caller graph for this function:

GetIdle() [2/2]

C4ObjectInfo * C4ObjectInfoList::GetIdle

(

const char *

szByName

)

Definition at line 244 of file C4ObjectInfoList.cpp.

{
    C4ObjectInfo *pInfo;
    // Find matching name, participating, alive and not in action
    for (pInfo = First; pInfo; pInfo = pInfo->Next)
    {
        if (SEqualNoCase(pInfo->Name, szByName)
        &&  pInfo->Participation
        && !pInfo->InAction
        && !pInfo->HasDied)
        {
            pInfo->Recruit();
            return pInfo;
        }
    }
    return nullptr;
}

References First, C4ObjectInfo::HasDied, C4ObjectInfo::InAction, C4ObjectInfoCore::Name, C4ObjectInfo::Next, C4ObjectInfoCore::Participation, C4ObjectInfo::Recruit(), and SEqualNoCase().

Here is the call graph for this function:

GetLast()

C4ObjectInfo * C4ObjectInfoList::GetLast ( )

protected

Definition at line 271 of file C4ObjectInfoList.cpp.

{
    C4ObjectInfo *cInfo = First;
    while (cInfo && cInfo->Next)
    {
        cInfo = cInfo->Next;
    }
    return cInfo;
}

References First, and C4ObjectInfo::Next.

Referenced by Save().

Here is the caller graph for this function:

GetPrevious()

C4ObjectInfo * C4ObjectInfoList::GetPrevious ( C4ObjectInfo *  pInfo )

protected

Definition at line 281 of file C4ObjectInfoList.cpp.

{
    for (C4ObjectInfo *cInfo = First; cInfo; cInfo=cInfo->Next)
    {
        if (cInfo->Next == pInfo)
        {
            return cInfo;
        }
    }
    return nullptr;
}

References First, and C4ObjectInfo::Next.

Referenced by Save().

Here is the caller graph for this function:

IsElement()

bool C4ObjectInfoList::IsElement

(

C4ObjectInfo *

pInfo

)

Definition at line 293 of file C4ObjectInfoList.cpp.

{
    for (C4ObjectInfo *cInfo = First; cInfo; cInfo = cInfo->Next)
    {
        if (cInfo == pInfo)
        {
            return true;
        }
    }
    return false;
}

References First, and C4ObjectInfo::Next.

Referenced by C4Player::SetObjectCrewStatus().

Here is the caller graph for this function:

Load()

int32_t C4ObjectInfoList::Load

(

C4Group &

hGroup

)

Definition at line 57 of file C4ObjectInfoList.cpp.

{
    C4ObjectInfo *ninf;
    int32_t infn = 0;
    char entryname[256 + 1];
 
    // Search all oci files
    hGroup.ResetSearch();
    while (hGroup.FindNextEntry(C4CFN_ObjectInfoFiles, entryname))
    {
        if ((ninf = new C4ObjectInfo))
        {
            if (ninf->Load(hGroup,entryname))
            {
                Add(ninf);
                infn++;
            }
            else
            {
                delete ninf;
            }
        }
    }
 
    // Search subfolders
    hGroup.ResetSearch();
    while (hGroup.FindNextEntry("*", entryname))
    {
        C4Group ItemGroup;
        if (ItemGroup.OpenAsChild(&hGroup, entryname))
        {
            Load(ItemGroup);
        }
    }
 
    return infn;
}

References Add(), C4CFN_ObjectInfoFiles, C4Group::FindNextEntry(), C4ObjectInfo::Load(), C4Group::OpenAsChild(), and C4Group::ResetSearch().

Referenced by C4Player::Load(), and C4Player::Strip().

Here is the call graph for this function:

Here is the caller graph for this function:

MakeValidName()

void C4ObjectInfoList::MakeValidName

(

char *

sName

)

Definition at line 106 of file C4ObjectInfoList.cpp.

{
    // Append a number to the name if it already exists, starting at 2
 
    // 1 space, up to 10 characters for integer max size,
    // 1 terminating zero, 1 extra space for overflow (negative value) = 13 characters
    char number_suffix[13];
    size_t namelen = SLen(sName);
    for (int32_t identifier = 2; NameExists(sName); identifier++)
    {
        sprintf(number_suffix, " %d", identifier);
        SCopy(number_suffix, sName + std::min(namelen, C4MaxName - SLen(number_suffix)));
    }
}

References C4MaxName, NameExists(), SCopy(), SLen(), and sprintf.

Referenced by New().

Here is the call graph for this function:

Here is the caller graph for this function:

NameExists()

bool C4ObjectInfoList::NameExists

(

const char *

szName

)

Definition at line 121 of file C4ObjectInfoList.cpp.

{
    C4ObjectInfo *cinf;
    for (cinf = First; cinf; cinf = cinf->Next)
    {
        if (SEqualNoCase(szName, cinf->Name))
        {
            return true;
        }
    }
    return false;
}

References First, C4ObjectInfoCore::Name, C4ObjectInfo::Next, and SEqualNoCase().

Referenced by MakeValidName().

Here is the call graph for this function:

Here is the caller graph for this function:

New()

C4ObjectInfo * C4ObjectInfoList::New	(	C4ID	n_id,
		C4DefList *	pDefs
	)

Definition at line 173 of file C4ObjectInfoList.cpp.

{
    C4ObjectInfo *pInfo;
    // Create new info object
    if (!(pInfo = new C4ObjectInfo))
    {
        return nullptr;
    }
    // Default type clonk if none specified
    if (n_id == C4ID::None)
    {
        n_id = C4ID::Clonk;
    }
    // Check type valid and def available
    C4Def *pDef = nullptr;
    if (pDefs && !(pDef = pDefs->ID2Def(n_id)))
    {
        delete pInfo;
        return nullptr;
    }
    // Set name source
    const char *cpNames = Game.Names.GetData();
    if (pDef->pClonkNames)
    {
        cpNames = pDef->pClonkNames->GetData();
    }
    // Default by type
    ((C4ObjectInfoCore*) pInfo)->Default(n_id, pDefs, cpNames);
    // Set birthday
    pInfo->Birthday = time(nullptr); // TODO: Use the function from C4ObjectInfo here, instead of assigning it manually
    // Make valid names
    MakeValidName(pInfo->Name);
    // Add
    Add(pInfo);
    ++iNumCreated;
    return pInfo;
}

References Add(), C4ObjectInfoCore::Birthday, C4ID::Clonk, Game, C4ComponentHost::GetData(), C4DefList::ID2Def(), iNumCreated, MakeValidName(), C4ObjectInfoCore::Name, C4Game::Names, C4ID::None, and C4Def::pClonkNames.

Referenced by C4Player::MakeCrewMember(), and C4Player::PlaceReadyCrew().

Here is the call graph for this function:

Here is the caller graph for this function:

Save()

bool C4ObjectInfoList::Save	(	C4Group &	hGroup,
		bool	fSavegame,
		bool	fStoreTiny,
		C4DefList *	pDefs
	)

Definition at line 220 of file C4ObjectInfoList.cpp.

{
    // Save in opposite order (for identical crew order on load)
    C4ObjectInfo *pInfo;
    for (pInfo = GetLast(); pInfo; pInfo = GetPrevious(pInfo))
    {
        // Don't save TemporaryCrew in regular player files
        if (!fSavegame)
        {
            C4Def *pDef = C4Id2Def(pInfo->id);
            if (pDef && pDef->TemporaryCrew)
            {
                continue;
            }
        }
        // save
        if (!pInfo->Save(hGroup, fStoreTiny, pDefs))
        {
            return false;
        }
    }
    return true;
}

References C4Id2Def(), GetLast(), GetPrevious(), C4ObjectInfoCore::id, C4ObjectInfo::Save(), and C4Def::TemporaryCrew.

Referenced by C4Player::Save(), and C4Player::Strip().

Here is the call graph for this function:

Here is the caller graph for this function:

Strip()

void C4ObjectInfoList::Strip

(

C4DefList &

rDefs

)

Definition at line 305 of file C4ObjectInfoList.cpp.

{
    C4ObjectInfo *pInfo;
    C4ObjectInfo *pPrev;
    // Search list
    for (pInfo = First, pPrev = nullptr; pInfo; )
    {
        // Invalid?
        if (!rDefs.ID2Def(pInfo->id))
        {
            C4ObjectInfo *pDelete = pInfo;
            if (pPrev)
            {
                pPrev->Next = pInfo->Next;
            }
            else
            {
                First = pInfo->Next;
            }
            pInfo = pInfo->Next;
            delete pDelete;
        }
        else
        {
            pPrev = pInfo;
            pInfo = pInfo->Next;
        }
    }
}

References First, C4ObjectInfoCore::id, C4DefList::ID2Def(), and C4ObjectInfo::Next.

Referenced by C4Player::Save(), and C4Player::Strip().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

First

C4ObjectInfo* C4ObjectInfoList::First

protected

Definition at line 31 of file C4ObjectInfoList.h.

Referenced by Add(), Clear(), Default(), DetachFromObjects(), Evaluate(), GetFirst(), GetIdle(), GetLast(), GetPrevious(), IsElement(), NameExists(), and Strip().

iNumCreated

int32_t C4ObjectInfoList::iNumCreated

Definition at line 33 of file C4ObjectInfoList.h.

Referenced by C4Player::CompileFunc(), Default(), and New().

---

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

• C4ObjectInfoList.h
• C4ObjectInfoList.cpp