C4TeamList Class Reference

#include <C4Teams.h>

Public Types
enum	ConfigValue {   TEAM_None = 0 , TEAM_Custom = 1 , TEAM_Active = 2 , TEAM_AllowHostilityChange = 3 ,   TEAM_Dist = 4 , TEAM_AllowTeamSwitch = 5 , TEAM_AutoGenerateTeams = 6 , TEAM_TeamColors = 7 }
enum	TeamDist {   TEAMDIST_First = 0 , TEAMDIST_Free = 0 , TEAMDIST_Host = 1 , TEAMDIST_None = 2 ,   TEAMDIST_Random = 3 , TEAMDIST_RandomInv = 4 , TEAMDIST_Last = 4 }

Public Member Functions
	C4TeamList ()=default
	~C4TeamList ()
void	Clear ()
C4TeamList &	operator= (const C4TeamList &rCopy)
C4Team *	GetTeamByID (int32_t iID) const
C4Team *	GetGenerateTeamByID (int32_t iID)
C4Team *	GetTeamByIndex (int32_t iIndex) const
C4Team *	GetTeamByName (const char *szName) const
C4Team *	GetTeamByPlayerID (int32_t iID) const
int32_t	GetLargestTeamID () const
C4Team *	GetRandomSmallestTeam () const
int32_t	GetTeamCount () const
C4Team *	CreateTeam (const char *szName)
bool	IsMultiTeams () const
bool	IsCustom () const
bool	IsHostilityChangeAllowed () const
bool	IsTeamSwitchAllowed () const
bool	CanLocalChooseTeam () const
bool	CanLocalChooseTeam (int32_t idPlayer) const
bool	CanLocalSeeTeam () const
bool	IsTeamColors () const
bool	IsRandomTeam () const
bool	IsJoin2TeamAllowed (int32_t idTeam, C4PlayerType plrType)
bool	IsAutoGenerateTeams () const
bool	IsRuntimeJoinTeamChoice () const
int32_t	GetMaxScriptPlayers () const
int32_t	GetForcedTeamSelection (int32_t idForPlayer) const
StdStrBuf	GetScriptPlayerName () const
bool	IsTeamVisible () const
void	EnforceLeagueRules ()
bool	RecheckPlayerInfoTeams (C4PlayerInfo &rNewJoin, bool fByHost)
void	CompileFunc (StdCompiler *pComp)
bool	Load (C4Group &hGroup, class C4Scenario *pInitDefault, class C4LangStringTable *pLang)
bool	Save (C4Group &hGroup)
void	RecheckPlayers ()
void	RecheckTeams ()
void	EnsureTeamCount ()
void	ReassignAllTeams ()
void	FillTeamDistOptions (C4GUI::ComboBox_FillCB *pFiller) const
void	SendSetTeamDist (TeamDist eNewDist)
TeamDist	GetTeamDist () const
StdStrBuf	GetTeamDistString () const
bool	HasTeamDistOptions () const
void	SetTeamDistribution (TeamDist eToVal)
void	SendSetTeamColors (bool fEnabled)
void	SetTeamColors (bool fEnabled)
int32_t	GetStartupTeamCount (int32_t startup_player_count)

Detailed Description

Definition at line 88 of file C4Teams.h.

Member Enumeration Documentation

ConfigValue

enum C4TeamList::ConfigValue

Enumerator
TEAM_None
TEAM_Custom
TEAM_Active
TEAM_AllowHostilityChange
TEAM_Dist
TEAM_AllowTeamSwitch
TEAM_AutoGenerateTeams
TEAM_TeamColors

Definition at line 92 of file C4Teams.h.

    {
        TEAM_None                 = 0,
        TEAM_Custom               = 1,
        TEAM_Active               = 2,
        TEAM_AllowHostilityChange = 3,
        TEAM_Dist                 = 4,
        TEAM_AllowTeamSwitch      = 5,
        TEAM_AutoGenerateTeams    = 6,
        TEAM_TeamColors           = 7
    };

TeamDist

enum C4TeamList::TeamDist

Enumerator
TEAMDIST_First
TEAMDIST_Free
TEAMDIST_Host
TEAMDIST_None
TEAMDIST_Random
TEAMDIST_RandomInv
TEAMDIST_Last

Definition at line 105 of file C4Teams.h.

    {
        TEAMDIST_First     = 0,
        TEAMDIST_Free      = 0, // anyone can choose teams
        TEAMDIST_Host      = 1, // host decides teams
        TEAMDIST_None      = 2, // no teams
        TEAMDIST_Random    = 3, // fixed random teams
        TEAMDIST_RandomInv = 4, // fixed random teams invisible in lobby
        TEAMDIST_Last      = 4,
    };

Constructor & Destructor Documentation

C4TeamList()

C4TeamList::C4TeamList ( )

default

~C4TeamList()

C4TeamList::~C4TeamList ( )

inline

Definition at line 135 of file C4Teams.h.

{ Clear(); }

References Clear().

Here is the call graph for this function:

Member Function Documentation

CanLocalChooseTeam() [1/2]

bool C4TeamList::CanLocalChooseTeam

(

)

const

Definition at line 292 of file C4Teams.cpp.

{
    // only if there are any teams
    if (!fActive) return false;
    // check by mode
    switch (eTeamDist)
    {
    case TEAMDIST_Free: return true;
    case TEAMDIST_Host: return ::Control.isCtrlHost();
    case TEAMDIST_None:
    case TEAMDIST_Random:
    case TEAMDIST_RandomInv:
        return false;
    default: assert(false); return false;
    }
}

References Control, C4GameControl::isCtrlHost(), TEAMDIST_Free, TEAMDIST_Host, TEAMDIST_None, TEAMDIST_Random, and TEAMDIST_RandomInv.

Referenced by CanLocalChooseTeam().

Here is the call graph for this function:

Here is the caller graph for this function:

CanLocalChooseTeam() [2/2]

bool C4TeamList::CanLocalChooseTeam

(

int32_t

idPlayer

)

const

Definition at line 309 of file C4Teams.cpp.

{
    // must be possible at all
    if (!CanLocalChooseTeam()) return false;
    // there must be space in a target team
    // always possible if teams are generated on the fly
    if (IsAutoGenerateTeams()) return true;
    // also possible if one of the teams that's not the player's is not full
    C4Team *pCurrentTeam = nullptr, *pCheck;
    if (idPlayer) pCurrentTeam = GetTeamByPlayerID(idPlayer);
    int32_t iCheckTeam=0;
    while ((pCheck = GetTeamByIndex(iCheckTeam++)))
        if (pCheck != pCurrentTeam)
            if (!pCheck->IsFull())
                break;
    return !!pCheck;
}

References CanLocalChooseTeam(), GetTeamByIndex(), GetTeamByPlayerID(), and IsAutoGenerateTeams().

Here is the call graph for this function:

CanLocalSeeTeam()

bool C4TeamList::CanLocalSeeTeam

(

)

const

Definition at line 327 of file C4Teams.cpp.

{
    if (!fActive) return false;
    // invisible teams aren't revealed before game start
    if (eTeamDist != TEAMDIST_RandomInv) return true;
    return !!Game.IsRunning;
}

References Game, C4Game::IsRunning, and TEAMDIST_RandomInv.

Clear()

void C4TeamList::Clear

(

)

Definition at line 255 of file C4Teams.cpp.

{
    // del all teams
    ClearTeams();
    // del player team vector
    delete [] ppList; ppList = nullptr;
    iTeamCapacity = 0;
    fAllowHostilityChange = true;
    fAllowTeamSwitch = false;
    fCustom = false;
    fActive = true;
    fTeamColors = false;
    eTeamDist = TEAMDIST_Free;
    fAutoGenerateTeams = false;
    iMaxScriptPlayers = 0;
    sScriptPlayerNames.Clear();
}

References StdStrBuf::Clear(), and TEAMDIST_Free.

Referenced by C4GameParameters::Clear(), Load(), operator=(), and ~C4TeamList().

Here is the call graph for this function:

Here is the caller graph for this function:

CompileFunc()

void C4TeamList::CompileFunc

(

StdCompiler *

pComp

)

Definition at line 545 of file C4Teams.cpp.

{
    // if (pComp->isDeserializer()) Clear(); - do not clear, because this would corrupt  the fCustom-flag
    pComp->Value(mkNamingAdapt(fActive,               "Active",               true));
    pComp->Value(mkNamingAdapt(fCustom,               "Custom",               true));
    pComp->Value(mkNamingAdapt(fAllowHostilityChange, "AllowHostilityChange", false));
    pComp->Value(mkNamingAdapt(fAllowTeamSwitch,      "AllowTeamSwitch",      false));
    pComp->Value(mkNamingAdapt(fAutoGenerateTeams,    "AutoGenerateTeams",    false));
    pComp->Value(mkNamingAdapt(iLastTeamID, "LastTeamID", 0));
 
    StdEnumEntry<TeamDist> TeamDistEntries[] =
    {
        { "Free", TEAMDIST_Free },
        { "Host", TEAMDIST_Host },
        { "None", TEAMDIST_None },
        { "Random", TEAMDIST_Random },
        { "RandomInv", TEAMDIST_RandomInv },
    };
    pComp->Value(mkNamingAdapt(mkEnumAdaptT<uint8_t>(eTeamDist, TeamDistEntries), "TeamDistribution", TEAMDIST_Free));
 
    pComp->Value(mkNamingAdapt(fTeamColors, "TeamColors", false));
    pComp->Value(mkNamingAdapt(iMaxScriptPlayers, "MaxScriptPlayers", 0));
    pComp->Value(mkNamingAdapt(mkParAdapt(sScriptPlayerNames, StdCompiler::RCT_All), "ScriptPlayerNames", StdStrBuf()));
 
    int32_t iOldTeamCount = iTeamCount;
    pComp->Value(mkNamingCountAdapt(iTeamCount,  "Team"));
 
    if (pComp->isDeserializer())
    {
        while (iOldTeamCount--) delete ppList[iOldTeamCount];
        delete [] ppList;
        if ((iTeamCapacity = iTeamCount))
        {
            ppList = new C4Team *[iTeamCapacity];
            memset(ppList, 0, sizeof(C4Team *)*iTeamCapacity);
        }
        else
            ppList = nullptr;
    }
 
    if (iTeamCount)
    {
        // Force compiler to spezialize
        mkPtrAdaptNoNull(*ppList);
        // Save team list, using map-function.
        pComp->Value(mkNamingAdapt(
                       mkArrayAdaptMap(ppList, iTeamCount, mkPtrAdaptNoNull<C4Team>),
                       "Team"));
    }
 
    if (pComp->isDeserializer())
    {
        // adjust last team ID, which may not be set properly for player-generated team files
        iLastTeamID = std::max(GetLargestTeamID(), iLastTeamID);
        // force automatic generation of teams if none are defined
        if (!iTeamCount) fAutoGenerateTeams = true;
    }
}

References GetLargestTeamID(), StdCompiler::isDeserializer(), mkArrayAdaptMap(), mkNamingAdapt(), mkNamingCountAdapt(), mkParAdapt(), mkPtrAdaptNoNull(), StdCompiler::RCT_All, TEAMDIST_Free, TEAMDIST_Host, TEAMDIST_None, TEAMDIST_Random, TEAMDIST_RandomInv, and StdCompiler::Value().

Here is the call graph for this function:

CreateTeam()

C4Team * C4TeamList::CreateTeam

(

const char *

szName

)

Definition at line 360 of file C4Teams.cpp.

{
    // custom team
    C4Team *pNewTeam = new C4Team();
    pNewTeam->iID = iLastTeamID + 1;
    SCopy(szName, pNewTeam->Name, C4MaxName);
    AddTeam(pNewTeam);
    pNewTeam->RecheckColor(*this);
    return pNewTeam;
}

References C4MaxName, C4Team::iID, C4Team::Name, C4Team::RecheckColor(), and SCopy().

Here is the call graph for this function:

EnforceLeagueRules()

void C4TeamList::EnforceLeagueRules

(

)

Definition at line 856 of file C4Teams.cpp.

{
    // enforce some league settings
    // allow temp hostility switching; often used e.g. to unstick friendly Clonks, but:
    fAllowTeamSwitch = false; // switching teams in league games? Yeah, sure...
}

Referenced by C4GameParameters::EnforceLeagueRules().

Here is the caller graph for this function:

EnsureTeamCount()

void C4TeamList::EnsureTeamCount

(

)

Definition at line 719 of file C4Teams.cpp.

{
    // in random autogenerate mode, there must be exactly two teams
    if (IsRandomTeam())
    {
        if (IsAutoGenerateTeams() && GetTeamCount() != 2)
        {
            ClearTeams();
            GenerateDefaultTeams(2);
        }
    }
}

References GetTeamCount(), IsAutoGenerateTeams(), and IsRandomTeam().

Referenced by ReassignAllTeams(), and RecheckTeams().

Here is the call graph for this function:

Here is the caller graph for this function:

FillTeamDistOptions()

void C4TeamList::FillTeamDistOptions

(

C4GUI::ComboBox_FillCB *

pFiller

)

const

Definition at line 778 of file C4Teams.cpp.

{
    // no teams if disabled
    if (!fActive) return;
    // team distribution options
    pFiller->AddEntry(GetTeamDistName(TEAMDIST_Free).getData(), TEAMDIST_Free);
    pFiller->AddEntry(GetTeamDistName(TEAMDIST_Host).getData(), TEAMDIST_Host);
    if (IsAutoGenerateTeams()) pFiller->AddEntry(GetTeamDistName(TEAMDIST_None).getData(), TEAMDIST_None); // no teams: only for regular melees
    pFiller->AddEntry(GetTeamDistName(TEAMDIST_Random).getData(), TEAMDIST_Random);
    pFiller->AddEntry(GetTeamDistName(TEAMDIST_RandomInv).getData(), TEAMDIST_RandomInv);
    }

References C4GUI::ComboBox_FillCB::AddEntry(), IsAutoGenerateTeams(), TEAMDIST_Free, TEAMDIST_Host, TEAMDIST_None, TEAMDIST_Random, and TEAMDIST_RandomInv.

Here is the call graph for this function:

GetForcedTeamSelection()

int32_t C4TeamList::GetForcedTeamSelection

(

int32_t

idForPlayer

)

const

Definition at line 863 of file C4Teams.cpp.

{
    // if there's only one team for the player to join, return that team ID
    C4Team *pOKTeam = nullptr, *pCheck;
    if (idForPlayer) pOKTeam = GetTeamByPlayerID(idForPlayer); // curent team is always possible, even if full
    int32_t iCheckTeam=0;
    while ((pCheck = GetTeamByIndex(iCheckTeam++)))
        if (!pCheck->IsFull())
        {
            // this team could be joined
            if (pOKTeam && pOKTeam != pCheck)
            {
                // there already was a team that could be joined
                // two alternatives -> team selection is not forced
                return 0;
            }
            pOKTeam = pCheck;
        }
    // was there a team that could be joined?
    if (pOKTeam)
    {
        // if teams are generated on the fly, there would always be the possibility of creating a new team    }
        if (IsAutoGenerateTeams()) return 0;
        // otherwise, this team is forced!
        return pOKTeam->GetID();
    }
    // no team could be joined: Teams auto generated?
    if (IsAutoGenerateTeams())
    {
        // then the only possible way is to join a new team
        return TEAMID_New;
    }
    // otherwise, nothing can be done...
    return 0;
}

References C4Team::GetID(), GetTeamByIndex(), GetTeamByPlayerID(), IsAutoGenerateTeams(), and TEAMID_New.

Referenced by C4Player::Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

GetGenerateTeamByID()

C4Team * C4TeamList::GetGenerateTeamByID

(

int32_t

iID

)

Definition at line 390 of file C4Teams.cpp.

{
    // only if enabled
    if (!IsMultiTeams()) return nullptr;
    // new team?
    if (iID == TEAMID_New) iID = GetLargestTeamID()+1;
    // find in list
    C4Team *pTeam = GetTeamByID(iID);
    if (pTeam) return pTeam;
    // not found: Generate
    GenerateDefaultTeams(iID);
    return GetTeamByID(iID);
}

References GetLargestTeamID(), GetTeamByID(), IsMultiTeams(), and TEAMID_New.

Referenced by C4PlayerInfoList::AddInfo(), C4Player::Init(), C4PlayerInfoList::RecheckAutoGeneratedTeams(), and C4Player::ScenarioAndTeamInit().

Here is the call graph for this function:

Here is the caller graph for this function:

GetLargestTeamID()

int32_t C4TeamList::GetLargestTeamID

(

)

const

Definition at line 427 of file C4Teams.cpp.

{
    int32_t iLargest = 0;
    C4Team **ppCheck=ppList; int32_t iCnt=iTeamCount;
    for (; iCnt--; ++ppCheck) iLargest = std::max((*ppCheck)->GetID(), iLargest);
    return iLargest;
}

References iCnt.

Referenced by CompileFunc(), and GetGenerateTeamByID().

Here is the caller graph for this function:

GetMaxScriptPlayers()

int32_t C4TeamList::GetMaxScriptPlayers ( ) const

inline

Definition at line 174 of file C4Teams.h.

{ return iMaxScriptPlayers; } // return max number of script players to be added inthe lobby

GetRandomSmallestTeam()

C4Team * C4TeamList::GetRandomSmallestTeam

(

)

const

Definition at line 435 of file C4Teams.cpp.

{
    C4Team *pLowestTeam = nullptr; int iLowestTeamCount = 0;
    C4Team **ppCheck=ppList; int32_t iCnt=iTeamCount;
    for (; iCnt--; ++ppCheck)
    {
        if ((*ppCheck)->IsFull()) continue; // do not join into full teams
        if (!pLowestTeam || pLowestTeam->GetPlayerCount() > (*ppCheck)->GetPlayerCount())
        {
            pLowestTeam = *ppCheck;
            iLowestTeamCount = 1;
        }
        else if (pLowestTeam->GetPlayerCount() == (*ppCheck)->GetPlayerCount())
            if (!UnsyncedRandom(++iLowestTeamCount))
                pLowestTeam = *ppCheck;
    }
    return pLowestTeam;
}

References C4Team::GetPlayerCount(), iCnt, and UnsyncedRandom().

Referenced by RecheckPlayerInfoTeams(), and RecheckTeams().

Here is the call graph for this function:

Here is the caller graph for this function:

GetScriptPlayerName()

StdStrBuf C4TeamList::GetScriptPlayerName

(

)

const

Definition at line 899 of file C4Teams.cpp.

{
    // get a name to assign to a new script player. Try to avoid name conflicts
    if (!sScriptPlayerNames.getLength()) return StdStrBuf(LoadResStr("IDS_TEXT_COMPUTER")); // default name
    // test available script names
    int32_t iNameIdx = 0; StdStrBuf sOut;
    while (sScriptPlayerNames.GetSection(iNameIdx++, &sOut, '|'))
        if (!Game.PlayerInfos.GetActivePlayerInfoByName(sOut.getData()))
            return sOut;
    // none are available: Return a random name
    sScriptPlayerNames.GetSection(UnsyncedRandom(iNameIdx-1), &sOut, '|');
    return sOut;
}

References Game, C4PlayerInfoList::GetActivePlayerInfoByName(), StdStrBuf::getData(), StdStrBuf::getLength(), StdStrBuf::GetSection(), LoadResStr(), C4Game::PlayerInfos, and UnsyncedRandom().

Here is the call graph for this function:

GetStartupTeamCount()

int32_t C4TeamList::GetStartupTeamCount

(

int32_t

startup_player_count

)

Definition at line 913 of file C4Teams.cpp.

{
    // Count non-empty teams
    int32_t i_team = 0; C4Team *team;
    int32_t team_count = 0;
    while ((team = GetTeamByIndex(i_team++)))
    {
        if (team->GetPlayerCount() > 0) ++team_count;
    }
    // No populated teams found? This can happen in non-network mode when no players are assigned
    if (!team_count)
    {
        // Teams have not been selected yet, but the map script may want to have an estimate
        // in this case, calculate prospective teams from startup player count
        if (IsCustom() && !IsAutoGenerateTeams())
        {
            // Teams are pre-defined. Assume players will try to distribute broadly on these teams
            team_count = std::min<int32_t>(startup_player_count, GetTeamCount());
        }
        else if (IsRandomTeam())
        {
            // Randomized teams: Players will be put into two teams.
            team_count = std::min<int32_t>(startup_player_count, 2);
        }
        else
        {
            // Teams are auto-added -> fallback to player count
            team_count = startup_player_count;
        }
    }
 
    return team_count;
}

References C4Team::GetPlayerCount(), GetTeamByIndex(), GetTeamCount(), IsAutoGenerateTeams(), IsCustom(), and IsRandomTeam().

Here is the call graph for this function:

GetTeamByID()

C4Team * C4TeamList::GetTeamByID

(

int32_t

iID

)

const

Definition at line 383 of file C4Teams.cpp.

{
    C4Team **ppCheck=ppList; int32_t iCnt=iTeamCount;
    for (; iCnt--; ++ppCheck) if ((*ppCheck)->GetID() == iID) return *ppCheck;
    return nullptr;
}

References iCnt.

Referenced by C4Player::Execute(), C4Player::FindNewOwner(), GetGenerateTeamByID(), C4PlayerInfo::GetLobbyColor(), C4PlayerInfo::HasTeamWon(), C4Player::Init(), IsJoin2TeamAllowed(), RecheckPlayerInfoTeams(), C4Player::ScenarioAndTeamInit(), C4Player::ScenarioInit(), C4PlayerInfoList::UpdatePlayerAttributes(), and C4GameSave::WriteDescPlayers().

Here is the caller graph for this function:

GetTeamByIndex()

C4Team * C4TeamList::GetTeamByIndex

(

int32_t

iIndex

)

const

Definition at line 404 of file C4Teams.cpp.

{
    // safety
    if (!Inside<int32_t>(iIndex, 0, iTeamCount-1)) return nullptr;
    // direct list access
    return ppList[iIndex];
}

Referenced by C4GameOverDlg::C4GameOverDlg(), CanLocalChooseTeam(), C4MainMenu::DoRefillInternal(), GetForcedTeamSelection(), GetStartupTeamCount(), Load(), C4Team::RecheckColor(), RecheckPlayerInfoTeams(), and C4GameSave::WriteDescPlayers().

Here is the caller graph for this function:

GetTeamByName()

C4Team * C4TeamList::GetTeamByName

(

const char *

szName

)

const

Definition at line 412 of file C4Teams.cpp.

{
    assert(szName);
    C4Team **ppCheck=ppList; int32_t iCnt=iTeamCount;
    for (; iCnt--; ++ppCheck) if (SEqual((*ppCheck)->GetName(), szName)) return *ppCheck;
    return nullptr;
}

References iCnt, and SEqual().

Here is the call graph for this function:

GetTeamByPlayerID()

C4Team * C4TeamList::GetTeamByPlayerID

(

int32_t

iID

)

const

Definition at line 420 of file C4Teams.cpp.

{
    C4Team **ppCheck=ppList; int32_t iCnt=iTeamCount;
    for (; iCnt--; ++ppCheck) if ((*ppCheck)->IsPlayerIDInTeam(iID)) return *ppCheck;
    return nullptr;
}

References iCnt.

Referenced by CanLocalChooseTeam(), GetForcedTeamSelection(), and RecheckPlayerInfoTeams().

Here is the caller graph for this function:

GetTeamCount()

int32_t C4TeamList::GetTeamCount ( ) const

inline

Definition at line 158 of file C4Teams.h.

{ return iTeamCount; }

Referenced by C4GameOverDlg::C4GameOverDlg(), EnsureTeamCount(), GetStartupTeamCount(), RecheckPlayerInfoTeams(), and RecheckTeams().

Here is the caller graph for this function:

GetTeamDist()

TeamDist C4TeamList::GetTeamDist ( ) const

inline

Definition at line 211 of file C4Teams.h.

{ return eTeamDist; }

Referenced by C4PlayerInfo::GetLobbyColor().

Here is the caller graph for this function:

GetTeamDistString()

StdStrBuf C4TeamList::GetTeamDistString

(

)

const

Definition at line 797 of file C4Teams.cpp.

{
    // return name of current team distribution setting
    return GetTeamDistName(eTeamDist);
}

HasTeamDistOptions()

bool C4TeamList::HasTeamDistOptions

(

)

const

Definition at line 803 of file C4Teams.cpp.

{
    // team distribution can be changed if teams are enabled
    return fActive;
}

IsAutoGenerateTeams()

bool C4TeamList::IsAutoGenerateTeams ( ) const

inline

Definition at line 172 of file C4Teams.h.

{ return fAutoGenerateTeams; }

Referenced by C4GameOverDlg::C4GameOverDlg(), CanLocalChooseTeam(), C4MainMenu::DoRefillInternal(), EnsureTeamCount(), FillTeamDistOptions(), GetForcedTeamSelection(), GetStartupTeamCount(), C4Player::Init(), IsJoin2TeamAllowed(), RecheckPlayerInfoTeams(), RecheckTeams(), C4Player::ScenarioAndTeamInit(), and C4GameSave::WriteDescPlayers().

Here is the caller graph for this function:

IsCustom()

bool C4TeamList::IsCustom ( ) const

inline

Definition at line 163 of file C4Teams.h.

{ return fCustom; }     // whether teams are not generated as default

Referenced by GetStartupTeamCount(), and IsRuntimeJoinTeamChoice().

Here is the caller graph for this function:

IsHostilityChangeAllowed()

bool C4TeamList::IsHostilityChangeAllowed ( ) const

inline

Definition at line 164 of file C4Teams.h.

{ return fAllowHostilityChange; } // allow (temporary) hostility changes at runtime

Referenced by C4MainMenu::MenuCommand().

Here is the caller graph for this function:

IsJoin2TeamAllowed()

bool C4TeamList::IsJoin2TeamAllowed	(	int32_t	idTeam,
		C4PlayerType	plrType
	)

Definition at line 534 of file C4Teams.cpp.

{
    // join to new team: Only if new teams can be created
    if (idTeam == TEAMID_New) return IsAutoGenerateTeams();
    // team number must be valid
    C4Team *pTeam = GetTeamByID(idTeam);
    if (!pTeam) return false;
    // team player count must not exceed the limit, unless it is a script player
    return !pTeam->IsFull() || plrType == C4PT_Script;
}

References C4PT_Script, GetTeamByID(), IsAutoGenerateTeams(), C4Team::IsFull(), and TEAMID_New.

Referenced by RecheckPlayerInfoTeams(), and C4Player::ScenarioAndTeamInit().

Here is the call graph for this function:

Here is the caller graph for this function:

IsMultiTeams()

bool C4TeamList::IsMultiTeams ( ) const

inline

Definition at line 162 of file C4Teams.h.

{ return fActive; } // teams can be selected

Referenced by C4PlayerInfoList::AssignTeams(), GetGenerateTeamByID(), C4PlayerInfoList::InitLocal(), IsRuntimeJoinTeamChoice(), C4GameLobby::MainDlg::MainDlg(), C4GameLobby::MainDlg::OnRightTabContext(), RecheckPlayerInfoTeams(), and C4GameSave::WriteDescPlayers().

Here is the caller graph for this function:

IsRandomTeam()

bool C4TeamList::IsRandomTeam ( ) const

inline

Definition at line 170 of file C4Teams.h.

{ return eTeamDist==TEAMDIST_Random ||eTeamDist==TEAMDIST_RandomInv; } // whether a random team mode is selected

References TEAMDIST_Random, and TEAMDIST_RandomInv.

Referenced by EnsureTeamCount(), GetStartupTeamCount(), RecheckPlayerInfoTeams(), RecheckTeams(), and SetTeamDistribution().

Here is the caller graph for this function:

IsRuntimeJoinTeamChoice()

bool C4TeamList::IsRuntimeJoinTeamChoice ( ) const

inline

Definition at line 173 of file C4Teams.h.

{ return IsCustom() && IsMultiTeams(); } // whether players joining at runtime must select a team first

References IsCustom(), and IsMultiTeams().

Referenced by C4Player::Init(), and RecheckPlayerInfoTeams().

Here is the call graph for this function:

Here is the caller graph for this function:

IsTeamColors()

bool C4TeamList::IsTeamColors ( ) const

inline

Definition at line 169 of file C4Teams.h.

{ return fTeamColors; } // whether team colors are enabled

Referenced by C4Team::AddPlayer(), C4PlayerInfo::GetLobbyColor(), and C4PlayerInfoList::UpdatePlayerAttributes().

Here is the caller graph for this function:

IsTeamSwitchAllowed()

bool C4TeamList::IsTeamSwitchAllowed ( ) const

inline

Definition at line 165 of file C4Teams.h.

{ return fAllowTeamSwitch; } // allow permanent team changes at runtime

Referenced by C4MainMenu::ActivateMain(), and C4MainMenu::MenuCommand().

Here is the caller graph for this function:

IsTeamVisible()

bool C4TeamList::IsTeamVisible

(

)

const

Definition at line 454 of file C4Teams.cpp.

{
    // teams invisible during lobby time if random surprise teams
    if (eTeamDist == TEAMDIST_RandomInv)
        if (::Network.isLobbyActive())
            return false;
    return true;
}

References C4Network2::isLobbyActive(), Network, and TEAMDIST_RandomInv.

Referenced by C4MessageInput::ProcessInput().

Here is the call graph for this function:

Here is the caller graph for this function:

Load()

bool C4TeamList::Load	(	C4Group &	hGroup,
		class C4Scenario *	pInitDefault,
		class C4LangStringTable *	pLang
	)

Definition at line 604 of file C4Teams.cpp.

{
    // clear previous
    Clear();
    // load file contents
    StdStrBuf Buf;
    if (!hGroup.LoadEntryString(C4CFN_Teams, &Buf))
    {
        // no teams: Try default init
        if (!pInitDefault) return false;
        // no teams defined: Activate default melee teams if a melee rule is found
        // default: FFA for anything that looks like melee
        if ( pInitDefault->Game.IsMelee())
        {
            fAllowHostilityChange = true;
            fActive = true;
            fAutoGenerateTeams = true;
        }
        else
        {
            // No goals/rules whatsoever: They could be present in the objects.txt, but parsing that would be a bit of
            //  overkill
            // So just keep the old behaviour here, and disallow teams
            fAllowHostilityChange = true;
            fActive = false;
        }
        fCustom = false;
    }
    else
    {
        // team definition file may be localized
        if (pLang) pLang->ReplaceStrings(Buf);
        // compile
        if (!CompileFromBuf_LogWarn<StdCompilerINIRead>(mkNamingAdapt(*this, "Teams"), Buf, C4CFN_Teams)) return false;
    }
    // post-initialization: Generate default team colors
    int32_t iTeam=0; C4Team *pTeam;
    while ((pTeam = GetTeamByIndex(iTeam++)))
        pTeam->RecheckColor(*this);
    return true;
}

References C4CFN_Teams, Clear(), C4Scenario::Game, GetTeamByIndex(), C4SGame::IsMelee(), C4Group::LoadEntryString(), mkNamingAdapt(), C4Team::RecheckColor(), and C4LangStringTable::ReplaceStrings().

Referenced by C4GameParameters::Load().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

C4TeamList & C4TeamList::operator=

(

const C4TeamList &

rCopy

)

Definition at line 273 of file C4Teams.cpp.

{
    Clear();
    if ((iTeamCount = iTeamCapacity = rCopy.iTeamCount))
        ppList = new C4Team *[iTeamCapacity];
    for (int i = 0; i < iTeamCount; i++)
        ppList[i] = new C4Team(*rCopy.ppList[i]);
    iLastTeamID = rCopy.iLastTeamID;
    fAllowHostilityChange = rCopy.fAllowHostilityChange;
    fAllowTeamSwitch = rCopy.fAllowTeamSwitch;
    fCustom = rCopy.fCustom;
    fActive = rCopy.fActive;
    eTeamDist = rCopy.eTeamDist;
    fTeamColors = rCopy.fTeamColors;
    fAutoGenerateTeams = rCopy.fAutoGenerateTeams;
    sScriptPlayerNames = rCopy.sScriptPlayerNames;
    return *this;
}

References Clear().

Here is the call graph for this function:

ReassignAllTeams()

void C4TeamList::ReassignAllTeams

(

)

Definition at line 732 of file C4Teams.cpp.

{
    assert(::Control.isCtrlHost());
    if (!::Control.isCtrlHost()) return;
    // go through all player infos; reset team in them
    int32_t idStart = -1; C4PlayerInfo *pNfo;
    while ((pNfo = Game.PlayerInfos.GetNextPlayerInfoByID(idStart)))
    {
        idStart = pNfo->GetID();
        if (pNfo->HasJoinIssued()) continue;
        pNfo->SetTeam(0);
        // mark changed info as updated
        C4ClientPlayerInfos *pCltInfo = Game.PlayerInfos.GetClientInfoByPlayerID(idStart);
        assert(pCltInfo);
        if (pCltInfo)
        {
            pCltInfo->SetUpdated();
        }
    }
    // clear players from team lists
    RecheckPlayers();
    EnsureTeamCount();
    // reassign them
    idStart = -1;
    while ((pNfo = Game.PlayerInfos.GetNextPlayerInfoByID(idStart)))
    {
        idStart = pNfo->GetID();
        if (pNfo->HasJoinIssued()) continue;
        assert(!pNfo->GetTeam());
        RecheckPlayerInfoTeams(*pNfo, true);
    }
}

References Control, EnsureTeamCount(), Game, C4PlayerInfoList::GetClientInfoByPlayerID(), C4PlayerInfo::GetID(), C4PlayerInfoList::GetNextPlayerInfoByID(), C4PlayerInfo::GetTeam(), C4PlayerInfo::HasJoinIssued(), C4GameControl::isCtrlHost(), C4Game::PlayerInfos, RecheckPlayerInfoTeams(), RecheckPlayers(), C4PlayerInfo::SetTeam(), and C4ClientPlayerInfos::SetUpdated().

Referenced by RecheckTeams(), and SetTeamDistribution().

Here is the call graph for this function:

Here is the caller graph for this function:

RecheckPlayerInfoTeams()

bool C4TeamList::RecheckPlayerInfoTeams	(	C4PlayerInfo &	rNewJoin,
		bool	fByHost
	)

Definition at line 463 of file C4Teams.cpp.

{
    // only if enabled
    assert(IsMultiTeams());
    if (!IsMultiTeams()) return false;
    // check whether a new team is to be assigned first
    C4Team *pCurrentTeam = GetTeamByPlayerID(rNewJoin.GetID());
    int32_t idCurrentTeam = pCurrentTeam ? pCurrentTeam->GetID() : 0;
    if (rNewJoin.GetTeam())
    {
        // was that team a change to the current team?
        // no change anyway: OK, skip this info
        if (idCurrentTeam == rNewJoin.GetTeam()) return true;
        // the player had a different team assigned: Check if changes are allowed at all
        if (eTeamDist == TEAMDIST_Free || (eTeamDist == TEAMDIST_Host && fByHost))
            // also make sure that selecting this team is allowed, e.g. doesn't break the team limit
            // this also checks whether the team number is a valid team - but it would accept TEAMID_New, which shouldn't be used in player infos!
            if (rNewJoin.GetTeam() != TEAMID_New && IsJoin2TeamAllowed(rNewJoin.GetTeam(), rNewJoin.GetType()))
                // okay; accept change
                return true;
        // Reject change by reassigning the current team
        rNewJoin.SetTeam(idCurrentTeam);
        // and determine a new team, if none has been assigned yet
        if (idCurrentTeam) return true;
    }
    // new team assignment
    // teams are always needed in the lobby, so there's a team preset to change
    // for runtime joins, teams are needed if specified by teams.txt or if any teams have been created before (to avoid mixed team-noteam-scenarios)
    // but only assign teams in runtime join if the player won't pick it himself
    bool fWillHaveLobby = ::Network.isEnabled() && !::Network.Status.isPastLobby() && Game.fLobby;
    bool fHasOrWillHaveLobby = ::Network.isLobbyActive() || fWillHaveLobby;
    bool fCanPickTeamAtRuntime = !IsRandomTeam() && (rNewJoin.GetType() == C4PT_User) && IsRuntimeJoinTeamChoice();
    bool fIsTeamNeeded = IsRuntimeJoinTeamChoice() || GetTeamCount();
    if (!fHasOrWillHaveLobby && (!fIsTeamNeeded || fCanPickTeamAtRuntime)) return false;
    // get least-used team
    C4Team *pAssignTeam=nullptr;
    C4Team *pLowestTeam = GetRandomSmallestTeam();
    // melee mode
    if (IsAutoGenerateTeams() && !IsRandomTeam())
    {
        // reuse old team only if it's empty
        if (pLowestTeam && !pLowestTeam->GetPlayerCount())
            pAssignTeam = pLowestTeam;
        else
        {
            // no empty team: generate new
            GenerateDefaultTeams(iLastTeamID+1);
            pAssignTeam = GetTeamByID(iLastTeamID);
        }
    }
    else
    {
        if (!pLowestTeam)
        {
            // not enough teams defined in teamwork mode?
            // then create two teams as default
            if (!GetTeamByIndex(1))
                GenerateDefaultTeams(2);
            else
                // otherwise, all defined teams are full. This is a scenario error, because MaxPlayer should have been adjusted
                return false;
            pLowestTeam = GetTeamByIndex(0);
        }
        pAssignTeam = pLowestTeam;
    }
    // assign it
    if (!pAssignTeam) return false;
    pAssignTeam->AddPlayer(rNewJoin, true);
    return true;
}

References C4Team::AddPlayer(), C4PT_User, C4Game::fLobby, Game, C4PlayerInfo::GetID(), C4Team::GetID(), C4Team::GetPlayerCount(), GetRandomSmallestTeam(), C4PlayerInfo::GetTeam(), GetTeamByID(), GetTeamByIndex(), GetTeamByPlayerID(), GetTeamCount(), C4PlayerInfo::GetType(), IsAutoGenerateTeams(), C4Network2::isEnabled(), IsJoin2TeamAllowed(), C4Network2::isLobbyActive(), IsMultiTeams(), C4Network2Status::isPastLobby(), IsRandomTeam(), IsRuntimeJoinTeamChoice(), Network, C4PlayerInfo::SetTeam(), C4Network2::Status, TEAMDIST_Free, TEAMDIST_Host, and TEAMID_New.

Referenced by C4PlayerInfoList::AssignTeams(), and ReassignAllTeams().

Here is the call graph for this function:

Here is the caller graph for this function:

RecheckPlayers()

void C4TeamList::RecheckPlayers

(

)

Definition at line 663 of file C4Teams.cpp.

{
    C4Team **ppCheck=ppList; int32_t iCnt=iTeamCount;
    for (; iCnt--; ++ppCheck) (*ppCheck)->RecheckPlayers();
}

References iCnt.

Referenced by C4PlayerInfoList::CreateRestoreInfosForJoinedScriptPlayers(), C4Network2Players::HandlePlayerInfo(), C4Network2Players::OnClientPart(), ReassignAllTeams(), and C4PlayerInfoList::RestoreSavegameInfos().

Here is the caller graph for this function:

RecheckTeams()

void C4TeamList::RecheckTeams

(

)

Definition at line 669 of file C4Teams.cpp.

{
    // automatic team distributions only
    if (!IsRandomTeam()) return;
    // host decides random teams
    if (!::Control.isCtrlHost())
    {
        // Still make sure that we have the right number of teams on the clients as well so that
        // GetTeamCount() does not report inconsistent values.
        EnsureTeamCount();
        return;
    }
    // random teams in auto generate mode? Make sure there are exactly two teams
    if (IsAutoGenerateTeams() && GetTeamCount() != 2)
        {
        ReassignAllTeams();
        return;
        }
    // redistribute players of largest team that has relocatable players left towards smaller teams
    for (;;)
    {
        C4Team *pLowestTeam = GetRandomSmallestTeam();
        if (!pLowestTeam) break; // no teams: Nothing to re-distribute.
        // get largest team that has relocateable players
        C4Team *pLargestTeam = nullptr;
        C4Team **ppCheck=ppList; int32_t iCnt=iTeamCount;
        for (; iCnt--; ++ppCheck) if (!pLargestTeam || pLargestTeam->GetPlayerCount() > (*ppCheck)->GetPlayerCount())
                if ((*ppCheck)->GetFirstUnjoinedPlayerID())
                    pLargestTeam = *ppCheck;
        // no team can redistribute?
        if (!pLargestTeam) break;
        // redistribution won't help much?
        if (pLargestTeam->GetPlayerCount() - pLowestTeam->GetPlayerCount() <= 1) break;
        // okay; redistribute one player!
        int32_t idRedistPlayer = pLargestTeam->GetFirstUnjoinedPlayerID();
        C4PlayerInfo *pInfo = Game.PlayerInfos.GetPlayerInfoByID(idRedistPlayer);
        assert(pInfo);
        if (!pInfo) break; // umn...serious problems
        pLargestTeam->RemovePlayerByID(idRedistPlayer);
        pLowestTeam->AddPlayer(*pInfo, true);
        C4ClientPlayerInfos *pClrInfo = Game.PlayerInfos.GetClientInfoByPlayerID(idRedistPlayer);
        assert(pClrInfo);
        // player info change: mark updated to remote clients get information
        if (pClrInfo)
        {
            pClrInfo->SetUpdated();
        }
    }
}

References C4Team::AddPlayer(), Control, EnsureTeamCount(), Game, C4PlayerInfoList::GetClientInfoByPlayerID(), C4Team::GetFirstUnjoinedPlayerID(), C4Team::GetPlayerCount(), C4PlayerInfoList::GetPlayerInfoByID(), GetRandomSmallestTeam(), GetTeamCount(), iCnt, IsAutoGenerateTeams(), C4GameControl::isCtrlHost(), IsRandomTeam(), C4Game::PlayerInfos, ReassignAllTeams(), C4Team::RemovePlayerByID(), and C4ClientPlayerInfos::SetUpdated().

Referenced by C4Network2Players::HandlePlayerInfo(), C4Network2Players::OnClientPart(), and SetTeamDistribution().

Here is the call graph for this function:

Here is the caller graph for this function:

Save()

bool C4TeamList::Save

(

C4Group &

hGroup

)

Definition at line 646 of file C4Teams.cpp.

{
    // remove previous entry from group
    hGroup.DeleteEntry(C4CFN_Teams);
    // decompile
    try
    {
        StdStrBuf Buf = DecompileToBuf<StdCompilerINIWrite>(mkNamingAdapt(*this, "Teams"));
        // save it
        hGroup.Add(C4CFN_Teams, Buf, false, true);
    }
    catch (StdCompiler::Exception *)
        { return false; }
    // done, success
    return true;
}

References C4Group::Add(), C4CFN_Teams, C4Group::DeleteEntry(), and mkNamingAdapt().

Here is the call graph for this function:

SendSetTeamColors()

void C4TeamList::SendSetTeamColors

(

bool

fEnabled

)

Definition at line 833 of file C4Teams.cpp.

{
    // set it for all clients
    ::Control.DoInput(CID_Set, new C4ControlSet(C4CVT_TeamColors, fEnabled), CDT_Sync);
}

References C4CVT_TeamColors, CDT_Sync, CID_Set, Control, and C4GameControl::DoInput().

Here is the call graph for this function:

SendSetTeamDist()

void C4TeamList::SendSetTeamDist

(

TeamDist

eNewDist

)

Definition at line 790 of file C4Teams.cpp.

{
    assert(::Control.isCtrlHost());
    // set it for all clients
    ::Control.DoInput(CID_Set, new C4ControlSet(C4CVT_TeamDistribution, eNewTeamDist), CDT_Sync);
}

References C4CVT_TeamDistribution, CDT_Sync, CID_Set, Control, C4GameControl::DoInput(), and C4GameControl::isCtrlHost().

Here is the call graph for this function:

SetTeamColors()

void C4TeamList::SetTeamColors

(

bool

fEnabled

)

Definition at line 839 of file C4Teams.cpp.

{
    // change only
    if (fEnabled == fTeamColors) return;
    // reflect change
    fTeamColors = fEnabled;
    // update colors of all players
    if (!::Control.isCtrlHost()) return;
    // go through all player infos; reset color in them
    Game.PlayerInfos.UpdatePlayerAttributes(); // sets team and savegame colors
    if (::Network.isEnabled())
    {
        // sends color updates to all clients
        ::Network.Players.SendUpdatedPlayers();
    }
}

References Control, Game, C4GameControl::isCtrlHost(), C4Network2::isEnabled(), Network, C4Game::PlayerInfos, C4Network2::Players, C4Network2Players::SendUpdatedPlayers(), and C4PlayerInfoList::UpdatePlayerAttributes().

Here is the call graph for this function:

SetTeamDistribution()

void C4TeamList::SetTeamDistribution

(

TeamDist

eToVal

)

Definition at line 809 of file C4Teams.cpp.

{
    if (!Inside(eToVal, TEAMDIST_First, TEAMDIST_Last)) { assert(false); return; }
    eTeamDist = eToVal;
    // team distribution mode changed: Host may beed to redistribute
    if (::Control.isCtrlHost())
    {
        // if a random team mode was set, reassign all teams so it's really random.
        // Also reassign in no-team-mode so enough teams for all players exist
        if (IsRandomTeam() || eTeamDist==TEAMDIST_None)
            ReassignAllTeams();
        else
        {
            // otherwise, it's sufficient to just reassign any teams that are incorrect for the current mode
            RecheckTeams();
        }
        // send updates to other clients and reset flags
        if (::Network.isEnabled())
        {
            ::Network.Players.SendUpdatedPlayers();
        }
    }
}

References Control, Inside(), C4GameControl::isCtrlHost(), C4Network2::isEnabled(), IsRandomTeam(), Network, C4Network2::Players, ReassignAllTeams(), RecheckTeams(), C4Network2Players::SendUpdatedPlayers(), TEAMDIST_First, TEAMDIST_Last, and TEAMDIST_None.

Here is the call graph for this function:

---

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

• C4Teams.h
• C4Teams.cpp